Interface CustomEmojiOrBuilder (0.27.0)

public interface CustomEmojiOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getEmojiName()

public abstract String 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:

string emoji_name = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The emojiName.

getEmojiNameBytes()

public abstract ByteString getEmojiNameBytes()

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:

string emoji_name = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for emojiName.

getName()

public abstract String getName()

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

Format: customEmojis/{customEmoji}

string name = 2 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

Format: customEmojis/{customEmoji}

string name = 2 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getPayload()

public abstract CustomEmoji.CustomEmojiPayload getPayload()

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

.google.chat.v1.CustomEmoji.CustomEmojiPayload payload = 5 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CustomEmoji.CustomEmojiPayload

The payload.

getPayloadOrBuilder()

public abstract CustomEmoji.CustomEmojiPayloadOrBuilder getPayloadOrBuilder()

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

.google.chat.v1.CustomEmoji.CustomEmojiPayload payload = 5 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CustomEmoji.CustomEmojiPayloadOrBuilder

getTemporaryImageUri()

public abstract String 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.

string temporary_image_uri = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The temporaryImageUri.

getTemporaryImageUriBytes()

public abstract ByteString getTemporaryImageUriBytes()

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.

string temporary_image_uri = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for temporaryImageUri.

getUid()

public abstract String getUid()

Output only. Unique key for the custom emoji resource.

string uid = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
String

The uid.

getUidBytes()

public abstract ByteString getUidBytes()

Output only. Unique key for the custom emoji resource.

string uid = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for uid.

hasPayload()

public abstract boolean hasPayload()

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

.google.chat.v1.CustomEmoji.CustomEmojiPayload payload = 5 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the payload field is set.