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 \ V1
Methods
__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 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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Apps Chat V1 Client - Class ListCustomEmojisRequest (0.12.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.12.0 (latest)](/php/docs/reference/apps-chat/latest/Chat.V1.ListCustomEmojisRequest)\n- [0.11.2](/php/docs/reference/apps-chat/0.11.2/Chat.V1.ListCustomEmojisRequest)\n- [0.10.0](/php/docs/reference/apps-chat/0.10.0/Chat.V1.ListCustomEmojisRequest)\n- [0.9.0](/php/docs/reference/apps-chat/0.9.0/Chat.V1.ListCustomEmojisRequest)\n- [0.8.1](/php/docs/reference/apps-chat/0.8.1/Chat.V1.ListCustomEmojisRequest)\n- [0.7.2](/php/docs/reference/apps-chat/0.7.2/Chat.V1.ListCustomEmojisRequest)\n- [0.6.1](/php/docs/reference/apps-chat/0.6.1/Chat.V1.ListCustomEmojisRequest)\n- [0.5.0](/php/docs/reference/apps-chat/0.5.0/Chat.V1.ListCustomEmojisRequest)\n- [0.4.0](/php/docs/reference/apps-chat/0.4.0/Chat.V1.ListCustomEmojisRequest)\n- [0.3.0](/php/docs/reference/apps-chat/0.3.0/Chat.V1.ListCustomEmojisRequest)\n- [0.2.0](/php/docs/reference/apps-chat/0.2.0/Chat.V1.ListCustomEmojisRequest)\n- [0.1.4](/php/docs/reference/apps-chat/0.1.4/Chat.V1.ListCustomEmojisRequest) \nReference documentation and code samples for the Google Apps Chat V1 Client class ListCustomEmojisRequest.\n\nA request to return a list of custom emojis.\n\nGenerated from protobuf message `google.chat.v1.ListCustomEmojisRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Apps \\\\ Chat \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getPageSize\n\nOptional. The maximum number of custom emojis returned. The service can\nreturn fewer custom emojis than this value. If unspecified, the default\nvalue is 25. The maximum value is 200; values above 200 are changed to 200.\n\n### setPageSize\n\nOptional. The maximum number of custom emojis returned. The service can\nreturn fewer custom emojis than this value. If unspecified, the default\nvalue is 25. The maximum value is 200; values above 200 are changed to 200.\n\n### getPageToken\n\nOptional. (If resuming from a previous query.)\nA page token received from a previous list custom emoji call. Provide this\nto retrieve the subsequent page.\n\nWhen paginating, the filter value should match the call that provided the\npage token. Passing a different value might lead to unexpected results.\n\n### setPageToken\n\nOptional. (If resuming from a previous query.)\nA page token received from a previous list custom emoji call. Provide this\nto retrieve the subsequent page.\n\nWhen paginating, the filter value should match the call that provided the\npage token. Passing a different value might lead to unexpected results.\n\n### getFilter\n\nOptional. A query filter.\n\nSupports filtering by creator.\nTo filter by creator, you must specify a valid value. Currently only\n`creator(\"users/me\")` and `NOT creator(\"users/me\")` are accepted to filter\ncustom emojis by whether they were created by the calling user or not.\nFor example, the following query returns custom emojis created by the\ncaller: \n\n creator(\"users/me\")\n\nInvalid queries are rejected with an `INVALID_ARGUMENT` error.\n\n### setFilter\n\nOptional. A query filter.\n\nSupports filtering by creator.\nTo filter by creator, you must specify a valid value. Currently only\n`creator(\"users/me\")` and `NOT creator(\"users/me\")` are accepted to filter\ncustom emojis by whether they were created by the calling user or not.\nFor example, the following query returns custom emojis created by the\ncaller: \n\n creator(\"users/me\")\n\nInvalid queries are rejected with an `INVALID_ARGUMENT` error."]]
