Google Apps Chat V1 Client - Class CustomEmoji (0.11.1)

Reference documentation and code samples for the Google Apps Chat V1 Client class CustomEmoji.

Represents a custom emoji.

Generated from protobuf message google.chat.v1.CustomEmoji

Namespace

Google \ Apps \ Chat \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Identifier. The resource name of the custom emoji, assigned by the server. Format: customEmojis/{customEmoji}
↳ uid string

Output only. Unique key for the custom emoji resource.
↳ emoji_name string

Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: :valid-emoji-name:
↳ temporary_image_uri string

Output only. A temporary image URL for the custom emoji, valid for at least 10 minutes. Note that this is not populated in the response when the custom emoji is created.
↳ payload CustomEmoji\CustomEmojiPayload

Optional. Input only. Payload data. Required when the custom emoji is created.

getName

Identifier. The resource name of the custom emoji, assigned by the server.

Format: customEmojis/{customEmoji}

Returns
Type Description
string

setName

Identifier. The resource name of the custom emoji, assigned by the server.

Format: customEmojis/{customEmoji}

Parameter
Name Description
var string
Returns
Type Description
$this

getUid

Output only. Unique key for the custom emoji resource.

Returns
Type Description
string

setUid

Output only. Unique key for the custom emoji resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getEmojiName

Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization.

Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: :valid-emoji-name:

Returns
Type Description
string

setEmojiName

Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization.

Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: :valid-emoji-name:

Parameter
Name Description
var string
Returns
Type Description
$this

getTemporaryImageUri

Output only. A temporary image URL for the custom emoji, valid for at least 10 minutes. Note that this is not populated in the response when the custom emoji is created.

Returns
Type Description
string

setTemporaryImageUri

Output only. A temporary image URL for the custom emoji, valid for at least 10 minutes. Note that this is not populated in the response when the custom emoji is created.

Parameter
Name Description
var string
Returns
Type Description
$this

getPayload

Optional. Input only. Payload data.

Required when the custom emoji is created.

Returns
Type Description
CustomEmoji\CustomEmojiPayload|null

hasPayload

clearPayload

setPayload

Optional. Input only. Payload data.

Required when the custom emoji is created.

Parameter
Name Description
var CustomEmoji\CustomEmojiPayload
Returns
Type Description
$this