Reference documentation and code samples for the Google Apps Chat V1 Client class CustomStatus.
Represents a user's custom status in Google Chat.
This includes a short text message with an optional emoji that a user sets to give more context about their availability.
Generated from protobuf message google.chat.v1.CustomStatus
Namespace
Google \ Apps \ Chat \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ text |
string
Required. The text of the custom status. This will be a string with maximum length of 64. |
↳ emoji |
Emoji
Required. The emoji of the custom status. Only Unicode emojis are supported; custom emojis are not supported. |
↳ expire_time |
Google\Protobuf\Timestamp
The timestamp when the custom status expires. |
↳ ttl |
Google\Protobuf\Duration
Input only. The time-to-live duration after which the custom status expires. |
getText
Required. The text of the custom status. This will be a string with maximum length of 64.
| Returns | |
|---|---|
| Type | Description |
string |
|
setText
Required. The text of the custom status. This will be a string with maximum length of 64.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEmoji
Required. The emoji of the custom status. Only Unicode emojis are supported; custom emojis are not supported.
| Returns | |
|---|---|
| Type | Description |
Emoji|null |
|
hasEmoji
clearEmoji
setEmoji
Required. The emoji of the custom status. Only Unicode emojis are supported; custom emojis are not supported.
| Parameter | |
|---|---|
| Name | Description |
var |
Emoji
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExpireTime
The timestamp when the custom status expires.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasExpireTime
setExpireTime
The timestamp when the custom status expires.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTtl
Input only. The time-to-live duration after which the custom status expires.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasTtl
setTtl
Input only. The time-to-live duration after which the custom status expires.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExpiration
| Returns | |
|---|---|
| Type | Description |
string |
|