Class: Google::Apps::Chat::V1::CustomEmoji

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/chat/v1/reaction.rb

Overview

Represents a custom emoji.

Defined Under Namespace

Classes: CustomEmojiPayload

Instance Attribute Summary collapse

Instance Attribute Details

#emoji_name ⇒ ::String

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/chat/v1/reaction.rb', line 88

class CustomEmoji
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Payload data for the custom emoji.
  # @!attribute [rw] file_content
  #   @return [::String]
  #     Required. Input only. The image used for the custom emoji.
  #
  #     The payload must be under 256 KB and the dimension of
  #     the image must be square and between 64 and 500 pixels. The
  #     restrictions are subject to change.
  # @!attribute [rw] filename
  #   @return [::String]
  #     Required. Input only. The image file name.
  #
  #     Supported file extensions: `.png`, `.jpg`, `.gif`.
  class CustomEmojiPayload
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns 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}



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/chat/v1/reaction.rb', line 88

class CustomEmoji
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Payload data for the custom emoji.
  # @!attribute [rw] file_content
  #   @return [::String]
  #     Required. Input only. The image used for the custom emoji.
  #
  #     The payload must be under 256 KB and the dimension of
  #     the image must be square and between 64 and 500 pixels. The
  #     restrictions are subject to change.
  # @!attribute [rw] filename
  #   @return [::String]
  #     Required. Input only. The image file name.
  #
  #     Supported file extensions: `.png`, `.jpg`, `.gif`.
  class CustomEmojiPayload
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#payload ⇒ ::Google::Apps::Chat::V1::CustomEmoji::CustomEmojiPayload

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

Returns:



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/chat/v1/reaction.rb', line 88

class CustomEmoji
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Payload data for the custom emoji.
  # @!attribute [rw] file_content
  #   @return [::String]
  #     Required. Input only. The image used for the custom emoji.
  #
  #     The payload must be under 256 KB and the dimension of
  #     the image must be square and between 64 and 500 pixels. The
  #     restrictions are subject to change.
  # @!attribute [rw] filename
  #   @return [::String]
  #     Required. Input only. The image file name.
  #
  #     Supported file extensions: `.png`, `.jpg`, `.gif`.
  class CustomEmojiPayload
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#temporary_image_uri ⇒ ::String (readonly)

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

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/chat/v1/reaction.rb', line 88

class CustomEmoji
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Payload data for the custom emoji.
  # @!attribute [rw] file_content
  #   @return [::String]
  #     Required. Input only. The image used for the custom emoji.
  #
  #     The payload must be under 256 KB and the dimension of
  #     the image must be square and between 64 and 500 pixels. The
  #     restrictions are subject to change.
  # @!attribute [rw] filename
  #   @return [::String]
  #     Required. Input only. The image file name.
  #
  #     Supported file extensions: `.png`, `.jpg`, `.gif`.
  class CustomEmojiPayload
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#uid ⇒ ::String (readonly)

Returns Output only. Unique key for the custom emoji resource.

Returns:

  • (::String) —

    Output only. Unique key for the custom emoji resource.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/chat/v1/reaction.rb', line 88

class CustomEmoji
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Payload data for the custom emoji.
  # @!attribute [rw] file_content
  #   @return [::String]
  #     Required. Input only. The image used for the custom emoji.
  #
  #     The payload must be under 256 KB and the dimension of
  #     the image must be square and between 64 and 500 pixels. The
  #     restrictions are subject to change.
  # @!attribute [rw] filename
  #   @return [::String]
  #     Required. Input only. The image file name.
  #
  #     Supported file extensions: `.png`, `.jpg`, `.gif`.
  class CustomEmojiPayload
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end