Reference documentation and code samples for the Google Apps Chat V1 Client class ListMessagesRequest.
Lists messages in the specified space, that the user is a member of.
Generated from protobuf message google.chat.v1.ListMessagesRequest
Namespace
Google \ Apps \ Chat \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The resource name of the space to list messages from. Format: spaces/{space}
↳ page_size
int
Optional. The maximum number of messages returned. The service might return fewer messages than this value. If unspecified, at most 25 are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an INVALID_ARGUMENT error.
↳ page_token
string
Optional. A page token received from a previous list messages call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.
↳ filter
string
Optional. A query filter. You can filter messages by date (create_time) and thread (thread.name). To filter messages by the date they were created, specify the create_time with a timestamp in RFC-3339 format and double quotation marks. For example, "2023-04-21T11:30:00-04:00". You can use the greater than operator > to list messages that were created after a timestamp, or the less than operator < to list messages that were created before a timestamp. To filter messages within a time interval, use the AND operator between two timestamps. To filter by thread, specify the thread.name, formatted as spaces/{space}/threads/{thread}. You can only specify one thread.name per query. To filter by both thread and date, use the AND operator in your query. For example, the following queries are valid: create_time > "2012-04-21T11:30:00-04:00" create_time > "2012-04-21T11:30:00-04:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123 create_time > "2012-04-21T11:30:00+00:00" AND create_time < "2013-01-01T00:00:00+00:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123 thread.name = spaces/AAAAAAAAAAA/threads/123 Invalid queries are rejected by the server with an INVALID_ARGUMENT error.
↳ order_by
string
Optional. How the list of messages is ordered. Specify a value to order by an ordering operation. Valid ordering operation values are as follows: - ASC for ascending. - DESC for descending. The default ordering is create_time ASC.
↳ show_deleted
bool
Optional. Whether to include deleted messages. Deleted messages include deleted time and metadata about their deletion, but message content is unavailable.
getParent
Required. The resource name of the space to list messages from.
Format: spaces/{space}
Returns
Type
Description
string
setParent
Required. The resource name of the space to list messages from.
Format: spaces/{space}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Optional. The maximum number of messages returned. The service might return
fewer messages than this value.
If unspecified, at most 25 are returned.
The maximum value is 1000. If you use a value more than 1000, it's
automatically changed to 1000.
Negative values return an INVALID_ARGUMENT error.
Returns
Type
Description
int
setPageSize
Optional. The maximum number of messages returned. The service might return
fewer messages than this value.
If unspecified, at most 25 are returned.
The maximum value is 1000. If you use a value more than 1000, it's
automatically changed to 1000.
Negative values return an INVALID_ARGUMENT error.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Optional. A page token received from a previous list messages call. Provide
this parameter to retrieve the subsequent page.
When paginating, all other parameters provided should match the call that
provided the page token. Passing different values to the other parameters
might lead to unexpected results.
Returns
Type
Description
string
setPageToken
Optional. A page token received from a previous list messages call. Provide
this parameter to retrieve the subsequent page.
When paginating, all other parameters provided should match the call that
provided the page token. Passing different values to the other parameters
might lead to unexpected results.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Optional. A query filter.
You can filter messages by date (create_time) and thread (thread.name).
To filter messages by the date they were created, specify the create_time
with a timestamp in RFC-3339
format and double quotation marks. For example,
"2023-04-21T11:30:00-04:00". You can use the greater than operator > to
list messages that were created after a timestamp, or the less than
operator < to list messages that were created before a timestamp. To
filter messages within a time interval, use the AND operator between two
timestamps.
To filter by thread, specify the thread.name, formatted as
spaces/{space}/threads/{thread}. You can only specify one
thread.name per query.
To filter by both thread and date, use the AND operator in your query.
For example, the following queries are valid:
create_time > "2012-04-21T11:30:00-04:00"
create_time > "2012-04-21T11:30:00-04:00" AND
thread.name = spaces/AAAAAAAAAAA/threads/123
create_time > "2012-04-21T11:30:00+00:00" AND
create_time < "2013-01-01T00:00:00+00:00" AND
thread.name = spaces/AAAAAAAAAAA/threads/123
thread.name = spaces/AAAAAAAAAAA/threads/123
Invalid queries are rejected by the server with an INVALID_ARGUMENT
error.
Returns
Type
Description
string
setFilter
Optional. A query filter.
You can filter messages by date (create_time) and thread (thread.name).
To filter messages by the date they were created, specify the create_time
with a timestamp in RFC-3339
format and double quotation marks. For example,
"2023-04-21T11:30:00-04:00". You can use the greater than operator > to
list messages that were created after a timestamp, or the less than
operator < to list messages that were created before a timestamp. To
filter messages within a time interval, use the AND operator between two
timestamps.
To filter by thread, specify the thread.name, formatted as
spaces/{space}/threads/{thread}. You can only specify one
thread.name per query.
To filter by both thread and date, use the AND operator in your query.
For example, the following queries are valid:
create_time > "2012-04-21T11:30:00-04:00"
create_time > "2012-04-21T11:30:00-04:00" AND
thread.name = spaces/AAAAAAAAAAA/threads/123
create_time > "2012-04-21T11:30:00+00:00" AND
create_time < "2013-01-01T00:00:00+00:00" AND
thread.name = spaces/AAAAAAAAAAA/threads/123
thread.name = spaces/AAAAAAAAAAA/threads/123
Invalid queries are rejected by the server with an INVALID_ARGUMENT
error.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getOrderBy
Optional. How the list of messages is ordered. Specify a value to order by
an ordering operation. Valid ordering operation values are as follows:
ASC for ascending.
DESC for descending.
The default ordering is create_time ASC.
Returns
Type
Description
string
setOrderBy
Optional. How the list of messages is ordered. Specify a value to order by
an ordering operation. Valid ordering operation values are as follows:
ASC for ascending.
DESC for descending.
The default ordering is create_time ASC.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getShowDeleted
Optional. Whether to include deleted messages. Deleted messages include
deleted time and metadata about their deletion, but message content is
unavailable.
Returns
Type
Description
bool
setShowDeleted
Optional. Whether to include deleted messages. Deleted messages include
deleted time and metadata about their deletion, but message content is
unavailable.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The resource name of the space to list messages from.
Format: spaces/{space}
Please see ChatServiceClient::spaceName() for help formatting this field.
[[["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 ListMessagesRequest (0.12.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.12.0 (latest)](/php/docs/reference/apps-chat/latest/Chat.V1.ListMessagesRequest)\n- [0.11.2](/php/docs/reference/apps-chat/0.11.2/Chat.V1.ListMessagesRequest)\n- [0.10.0](/php/docs/reference/apps-chat/0.10.0/Chat.V1.ListMessagesRequest)\n- [0.9.0](/php/docs/reference/apps-chat/0.9.0/Chat.V1.ListMessagesRequest)\n- [0.8.1](/php/docs/reference/apps-chat/0.8.1/Chat.V1.ListMessagesRequest)\n- [0.7.2](/php/docs/reference/apps-chat/0.7.2/Chat.V1.ListMessagesRequest)\n- [0.6.1](/php/docs/reference/apps-chat/0.6.1/Chat.V1.ListMessagesRequest)\n- [0.5.0](/php/docs/reference/apps-chat/0.5.0/Chat.V1.ListMessagesRequest)\n- [0.4.0](/php/docs/reference/apps-chat/0.4.0/Chat.V1.ListMessagesRequest)\n- [0.3.0](/php/docs/reference/apps-chat/0.3.0/Chat.V1.ListMessagesRequest)\n- [0.2.0](/php/docs/reference/apps-chat/0.2.0/Chat.V1.ListMessagesRequest)\n- [0.1.4](/php/docs/reference/apps-chat/0.1.4/Chat.V1.ListMessagesRequest) \nReference documentation and code samples for the Google Apps Chat V1 Client class ListMessagesRequest.\n\nLists messages in the specified space, that the user is a member of.\n\nGenerated from protobuf message `google.chat.v1.ListMessagesRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Apps \\\\ Chat \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The resource name of the space to list messages from.\n\nFormat: `spaces/{space}`\n\n### setParent\n\nRequired. The resource name of the space to list messages from.\n\nFormat: `spaces/{space}`\n\n### getPageSize\n\nOptional. The maximum number of messages returned. The service might return\nfewer messages than this value.\n\nIf unspecified, at most 25 are returned.\nThe maximum value is 1000. If you use a value more than 1000, it's\nautomatically changed to 1000.\nNegative values return an `INVALID_ARGUMENT` error.\n\n### setPageSize\n\nOptional. The maximum number of messages returned. The service might return\nfewer messages than this value.\n\nIf unspecified, at most 25 are returned.\nThe maximum value is 1000. If you use a value more than 1000, it's\nautomatically changed to 1000.\nNegative values return an `INVALID_ARGUMENT` error.\n\n### getPageToken\n\nOptional. A page token received from a previous list messages call. Provide\nthis parameter to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided should match the call that\nprovided the page token. Passing different values to the other parameters\nmight lead to unexpected results.\n\n### setPageToken\n\nOptional. A page token received from a previous list messages call. Provide\nthis parameter to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided should match the call that\nprovided the page token. Passing different values to the other parameters\nmight lead to unexpected results.\n\n### getFilter\n\nOptional. A query filter.\n\nYou can filter messages by date (`create_time`) and thread (`thread.name`).\nTo filter messages by the date they were created, specify the `create_time`\nwith a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339)\nformat and double quotation marks. For example,\n`\"2023-04-21T11:30:00-04:00\"`. You can use the greater than operator `\u003e` to\nlist messages that were created after a timestamp, or the less than\noperator `\u003c` to list messages that were created before a timestamp. To\nfilter messages within a time interval, use the `AND` operator between two\ntimestamps.\nTo filter by thread, specify the `thread.name`, formatted as\n`spaces/{space}/threads/{thread}`. You can only specify one\n`thread.name` per query.\nTo filter by both thread and date, use the `AND` operator in your query.\nFor example, the following queries are valid: \n\n create_time \u003e \"2012-04-21T11:30:00-04:00\"\n create_time \u003e \"2012-04-21T11:30:00-04:00\" AND\n thread.name = spaces/AAAAAAAAAAA/threads/123\n create_time \u003e \"2012-04-21T11:30:00+00:00\" AND\n create_time \u003c \"2013-01-01T00:00:00+00:00\" AND\n thread.name = spaces/AAAAAAAAAAA/threads/123\n thread.name = spaces/AAAAAAAAAAA/threads/123\n\nInvalid queries are rejected by the server with an `INVALID_ARGUMENT`\nerror.\n\n### setFilter\n\nOptional. A query filter.\n\nYou can filter messages by date (`create_time`) and thread (`thread.name`).\nTo filter messages by the date they were created, specify the `create_time`\nwith a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339)\nformat and double quotation marks. For example,\n`\"2023-04-21T11:30:00-04:00\"`. You can use the greater than operator `\u003e` to\nlist messages that were created after a timestamp, or the less than\noperator `\u003c` to list messages that were created before a timestamp. To\nfilter messages within a time interval, use the `AND` operator between two\ntimestamps.\nTo filter by thread, specify the `thread.name`, formatted as\n`spaces/{space}/threads/{thread}`. You can only specify one\n`thread.name` per query.\nTo filter by both thread and date, use the `AND` operator in your query.\nFor example, the following queries are valid: \n\n create_time \u003e \"2012-04-21T11:30:00-04:00\"\n create_time \u003e \"2012-04-21T11:30:00-04:00\" AND\n thread.name = spaces/AAAAAAAAAAA/threads/123\n create_time \u003e \"2012-04-21T11:30:00+00:00\" AND\n create_time \u003c \"2013-01-01T00:00:00+00:00\" AND\n thread.name = spaces/AAAAAAAAAAA/threads/123\n thread.name = spaces/AAAAAAAAAAA/threads/123\n\nInvalid queries are rejected by the server with an `INVALID_ARGUMENT`\nerror.\n\n### getOrderBy\n\nOptional. How the list of messages is ordered. Specify a value to order by\nan ordering operation. Valid ordering operation values are as follows:\n\n- `ASC` for ascending.\n\n- `DESC` for descending.\n The default ordering is `create_time ASC`.\n\n### setOrderBy\n\nOptional. How the list of messages is ordered. Specify a value to order by\nan ordering operation. Valid ordering operation values are as follows:\n\n- `ASC` for ascending.\n\n- `DESC` for descending.\n The default ordering is `create_time ASC`.\n\n### getShowDeleted\n\nOptional. Whether to include deleted messages. Deleted messages include\ndeleted time and metadata about their deletion, but message content is\nunavailable.\n\n### setShowDeleted\n\nOptional. Whether to include deleted messages. Deleted messages include\ndeleted time and metadata about their deletion, but message content is\nunavailable.\n\n### static::build"]]