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.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The message users reacted to. Format: |
↳ 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 |
getParent
Required. The message users reacted to.
Format: spaces/{space}/messages/{message}
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The message users reacted to.
Format: spaces/{space}/messages/{message}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 by the server with an INVALID_ARGUMENT
error.
| Returns | |
|---|---|
| Type | Description |
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 by the server with an INVALID_ARGUMENT
error.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The message users reacted to. Format: |
| Returns | |
|---|---|
| Type | Description |
Google\Apps\Chat\V1\ListReactionsRequest |
|