Class CustomEmoji (0.27.0)

public final class CustomEmoji extends GeneratedMessageV3 implements CustomEmojiOrBuilder

Represents a custom emoji.

Protobuf type google.chat.v1.CustomEmoji

Static Fields

EMOJI_NAME_FIELD_NUMBER

public static final int EMOJI_NAME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PAYLOAD_FIELD_NUMBER

public static final int PAYLOAD_FIELD_NUMBER
Field Value
Type Description
int

TEMPORARY_IMAGE_URI_FIELD_NUMBER

public static final int TEMPORARY_IMAGE_URI_FIELD_NUMBER
Field Value
Type Description
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CustomEmoji getDefaultInstance()
Returns
Type Description
CustomEmoji

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CustomEmoji.Builder newBuilder()
Returns
Type Description
CustomEmoji.Builder

newBuilder(CustomEmoji prototype)

public static CustomEmoji.Builder newBuilder(CustomEmoji prototype)
Parameter
Name Description
prototype CustomEmoji
Returns
Type Description
CustomEmoji.Builder

parseDelimitedFrom(InputStream input)

public static CustomEmoji parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomEmoji
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomEmoji parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomEmoji
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CustomEmoji parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CustomEmoji
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CustomEmoji parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomEmoji
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CustomEmoji parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CustomEmoji
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CustomEmoji parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomEmoji
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CustomEmoji parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CustomEmoji
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomEmoji parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomEmoji
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CustomEmoji parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomEmoji
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomEmoji parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomEmoji
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CustomEmoji parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CustomEmoji
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CustomEmoji parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomEmoji
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CustomEmoji> parser()
Returns
Type Description
Parser<CustomEmoji>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public CustomEmoji getDefaultInstanceForType()
Returns
Type Description
CustomEmoji

getEmojiName()

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

getParserForType()

public Parser<CustomEmoji> getParserForType()
Returns
Type Description
Parser<CustomEmoji>
Overrides

getPayload()

public 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 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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTemporaryImageUri()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CustomEmoji.Builder newBuilderForType()
Returns
Type Description
CustomEmoji.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CustomEmoji.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CustomEmoji.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CustomEmoji.Builder toBuilder()
Returns
Type Description
CustomEmoji.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException