Class: Google::Apps::Chat::V1::ListCustomEmojisRequest

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

Overview

A request to return a list of custom emojis.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns Optional. A query filter.

Supports filtering by creator.

To filter by creator, you must specify a valid value. Currently only creator("users/me") and NOT creator("users/me") are accepted to filter custom emojis by whether they were created by the calling user or not.

For example, the following query returns custom emojis created by the caller:

creator("users/me")

Invalid queries are rejected with an INVALID_ARGUMENT error.

Returns:

  • (::String) —

    Optional. A query filter.

    Supports filtering by creator.

    To filter by creator, you must specify a valid value. Currently only creator("users/me") and NOT creator("users/me") are accepted to filter custom emojis by whether they were created by the calling user or not.

    For example, the following query returns custom emojis created by the caller:

    creator("users/me")

    Invalid queries are rejected with an INVALID_ARGUMENT error.



287
288
289
290
 
# File 'proto_docs/google/chat/v1/reaction.rb', line 287

class ListCustomEmojisRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Optional. The maximum number of custom emojis returned. The service can return fewer custom emojis than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200.

Returns:

  • (::Integer) —

    Optional. The maximum number of custom emojis returned. The service can return fewer custom emojis than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200.



287
288
289
290
 
# File 'proto_docs/google/chat/v1/reaction.rb', line 287

class ListCustomEmojisRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns Optional. (If resuming from a previous query.)

A page token received from a previous list custom emoji call. Provide this to retrieve the subsequent page.

When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.

Returns:

  • (::String) —

    Optional. (If resuming from a previous query.)

    A page token received from a previous list custom emoji call. Provide this to retrieve the subsequent page.

    When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.



287
288
289
290
 
# File 'proto_docs/google/chat/v1/reaction.rb', line 287

class ListCustomEmojisRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end