Google Chat V1 API - Class Google::Apps::Chat::V1::CustomEmoji (v0.12.0)

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

Represents a custom emoji.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#emoji_name

def emoji_name() -> ::String
Returns
  • (::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:

#emoji_name=

def emoji_name=(value) -> ::String
Parameter
  • value (::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:

Returns
  • (::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:

#name

def name() -> ::String
Returns
  • (::String) — Identifier. The resource name of the custom emoji, assigned by the server.

    Format: customEmojis/{customEmoji}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. The resource name of the custom emoji, assigned by the server.

    Format: customEmojis/{customEmoji}

Returns
  • (::String) — Identifier. The resource name of the custom emoji, assigned by the server.

    Format: customEmojis/{customEmoji}

#payload

def payload() -> ::Google::Apps::Chat::V1::CustomEmoji::CustomEmojiPayload
Returns

#payload=

def payload=(value) -> ::Google::Apps::Chat::V1::CustomEmoji::CustomEmojiPayload
Parameter
Returns

#temporary_image_uri

def temporary_image_uri() -> ::String
Returns
  • (::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.

#uid

def uid() -> ::String
Returns
  • (::String) — Output only. Unique key for the custom emoji resource.