Class: Google::Apps::Chat::V1::ListReactionsRequest

Inherits:

Object

• Object
• Google::Apps::Chat::V1::ListReactionsRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/chat/v1/reaction.rb

Overview

Lists reactions to a message.

Instance Attribute Summary

• #filter ⇒ ::String

  Optional.

• #page_size ⇒ ::Integer

  Optional.

• #page_token ⇒ ::String

  Optional.

• #parent ⇒ ::String

  Required.

Instance Attribute Details

#filter ⇒ ::String

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

# File 'proto_docs/google/chat/v1/reaction.rb', line 154

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

#page_size ⇒ ::Integer

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

# File 'proto_docs/google/chat/v1/reaction.rb', line 154

class ListReactionsRequest
  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 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.

# File 'proto_docs/google/chat/v1/reaction.rb', line 154

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

#parent ⇒ ::String

Returns Required. The message users reacted to.

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

Returns:

• (::String) —

  Required. The message users reacted to.

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

# File 'proto_docs/google/chat/v1/reaction.rb', line 154

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