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 \ V1Methods
__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: |
↳ page_size |
int
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 |
↳ page_token |
string
Optional, if resuming from a previous query. 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
A query filter. You can filter messages by date ( |
↳ order_by |
string
Optional, if resuming from a previous query. How the list of messages is ordered. Specify a value to order by an ordering operation. Valid ordering operation values are as follows: - |
↳ show_deleted |
bool
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
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
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, if resuming from a previous query.
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, if resuming from a previous query.
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
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
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, if resuming from a previous query.
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 iscreate_time ASC
.
Returns | |
---|---|
Type | Description |
string |
setOrderBy
Optional, if resuming from a previous query.
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 iscreate_time ASC
.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getShowDeleted
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
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: |
Returns | |
---|---|
Type | Description |
Google\Apps\Chat\V1\ListMessagesRequest |