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.
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}
string
setParent
Required. The resource name of the space to list messages from.
Format: spaces/{space}
var
string
$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.
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.
var
int
$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.
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.
var
string
$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.
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.
var
string
$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:
-
ASCfor ascending. -
DESCfor descending. The default ordering iscreate_time ASC.
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:
-
ASCfor ascending. -
DESCfor descending. The default ordering iscreate_time ASC.
var
string
$this
getShowDeleted
Optional. Whether to include deleted messages. Deleted messages include deleted time and metadata about their deletion, but message content is unavailable.
bool
setShowDeleted
Optional. Whether to include deleted messages. Deleted messages include deleted time and metadata about their deletion, but message content is unavailable.
var
bool
$this
static::build
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.
