Google Chat V1 API - Class Google::Apps::Chat::V1::ListReactionsRequest (v0.1.2)

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

Lists reactions to a message.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) — Optional. A query filter.

    You can filter reactions by emoji (either emoji.unicode or emoji.custom_emoji.uid) and user (user.name).

    To filter reactions for multiple emojis or users, join similar fields with the OR operator, such as emoji.unicode = "🙂" OR emoji.unicode = "👍" and user.name = "users/AAAAAA" OR user.name = "users/BBBBBB".

    To filter reactions by emoji and user, use the AND operator, such as emoji.unicode = "🙂" AND user.name = "users/AAAAAA".

    If your query uses both AND and OR, group them with parentheses.

    For example, the following queries are valid:

    user.name = "users/\\{user}" emoji.unicode = "🙂" emoji.custom_emoji.uid = "\\{uid}" emoji.unicode = "🙂" OR emoji.unicode = "👍" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}" emoji.unicode = "🙂" AND user.name = "users/\\{user}" (emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}") AND user.name = "users/\\{user}"

    The following queries are invalid:

    emoji.unicode = "🙂" AND emoji.unicode = "👍" emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "\\{uid}" emoji.unicode = "🙂" OR user.name = "users/\\{user}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}" OR user.name = "users/\\{user}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}" AND user.name = "users/\\{user}"

    Invalid queries are rejected by the server with an INVALID_ARGUMENT error.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) — Optional. A query filter.

    You can filter reactions by emoji (either emoji.unicode or emoji.custom_emoji.uid) and user (user.name).

    To filter reactions for multiple emojis or users, join similar fields with the OR operator, such as emoji.unicode = "🙂" OR emoji.unicode = "👍" and user.name = "users/AAAAAA" OR user.name = "users/BBBBBB".

    To filter reactions by emoji and user, use the AND operator, such as emoji.unicode = "🙂" AND user.name = "users/AAAAAA".

    If your query uses both AND and OR, group them with parentheses.

    For example, the following queries are valid:

    user.name = "users/\\{user}" emoji.unicode = "🙂" emoji.custom_emoji.uid = "\\{uid}" emoji.unicode = "🙂" OR emoji.unicode = "👍" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}" emoji.unicode = "🙂" AND user.name = "users/\\{user}" (emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}") AND user.name = "users/\\{user}"

    The following queries are invalid:

    emoji.unicode = "🙂" AND emoji.unicode = "👍" emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "\\{uid}" emoji.unicode = "🙂" OR user.name = "users/\\{user}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}" OR user.name = "users/\\{user}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}" AND user.name = "users/\\{user}"

    Invalid queries are rejected by the server with an INVALID_ARGUMENT error.

Returns
  • (::String) — Optional. A query filter.

    You can filter reactions by emoji (either emoji.unicode or emoji.custom_emoji.uid) and user (user.name).

    To filter reactions for multiple emojis or users, join similar fields with the OR operator, such as emoji.unicode = "🙂" OR emoji.unicode = "👍" and user.name = "users/AAAAAA" OR user.name = "users/BBBBBB".

    To filter reactions by emoji and user, use the AND operator, such as emoji.unicode = "🙂" AND user.name = "users/AAAAAA".

    If your query uses both AND and OR, group them with parentheses.

    For example, the following queries are valid:

    user.name = "users/\\{user}" emoji.unicode = "🙂" emoji.custom_emoji.uid = "\\{uid}" emoji.unicode = "🙂" OR emoji.unicode = "👍" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}" emoji.unicode = "🙂" AND user.name = "users/\\{user}" (emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}") AND user.name = "users/\\{user}"

    The following queries are invalid:

    emoji.unicode = "🙂" AND emoji.unicode = "👍" emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "\\{uid}" emoji.unicode = "🙂" OR user.name = "users/\\{user}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}" OR user.name = "users/\\{user}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}" AND user.name = "users/\\{user}"

    Invalid queries are rejected by the server with an INVALID_ARGUMENT error.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — Optional. The maximum number of reactions returned. The service can return fewer reactions 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 reactions returned. The service can return fewer reactions 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 reactions returned. The service can return fewer reactions 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 reactions 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 reactions 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 reactions 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.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The message users reacted to.

    Format: spaces/{space}/messages/{message}

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The message users reacted to.

    Format: spaces/{space}/messages/{message}

Returns
  • (::String) — Required. The message users reacted to.

    Format: spaces/{space}/messages/{message}