Reference documentation and code samples for the Google Apps Chat V1 Client class ListCustomEmojisRequest.
A request to return a list of custom emojis.
Generated from protobuf message google.chat.v1.ListCustomEmojisRequest
Namespace
Google \ Apps \ Chat \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ page_size |
int
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 |
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. |
↳ filter |
string
Optional. A query filter. Supports filtering by creator. To filter by creator, you must specify a valid value. Currently only |
getPageSize
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 | |
|---|---|
| Type | Description |
int |
|
setPageSize
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.
| 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 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 | |
|---|---|
| Type | Description |
string |
|
setPageToken
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
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 | |
|---|---|
| Type | Description |
string |
|
setFilter
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|