Reference documentation and code samples for the Google Apps Chat V1 Client class ListReactionsRequest.
Lists reactions to a message.
Generated from protobuf message google.chat.v1.ListReactionsRequest
Namespace
Google \ Apps \ Chat \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The message users reacted to. Format: spaces/{space}/messages/{message}
↳ page_size
int
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
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.
↳ filter
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 with an INVALID_ARGUMENT
error.
getParent
Required. The message users reacted to.
Format: spaces/{space}/messages/{message}
string
setParent
Required. The message users reacted to.
Format: spaces/{space}/messages/{message}
var
string
$this
getPageSize
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.
int
setPageSize
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.
var
int
$this
getPageToken
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.
string
setPageToken
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.
var
string
$this
getFilter
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 with an INVALID_ARGUMENT
error.
string
setFilter
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 with an INVALID_ARGUMENT
error.
var
string
$this
static::build
parent
string
Required. The message users reacted to.
Format: spaces/{space}/messages/{message}
Please see ChatServiceClient::messageName()
for help formatting this field.
