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

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

A request to return a list of custom emojis.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
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.

#filter=

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

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.

#page_size

def page_size() -> ::Integer
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.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::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.

#page_token

def page_token() -> ::String
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.

#page_token=

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

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.