Reference documentation and code samples for the Google Apps Chat V1 Client class ListSpacesRequest.
A request to list the spaces the caller is a member of.
Generated from protobuf message google.chat.v1.ListSpacesRequest
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 spaces to return. The service might return fewer than this value. If unspecified, at most 100 spaces 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. A page token, received from a previous list spaces call. Provide this parameter to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value may lead to unexpected results. |
↳ filter |
string
Optional. A query filter. You can filter spaces by the space type ( |
getPageSize
Optional. The maximum number of spaces to return. The service might return fewer than this value.
If unspecified, at most 100 spaces 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 spaces to return. The service might return fewer than this value.
If unspecified, at most 100 spaces 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 spaces call.
Provide this parameter to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value may lead to unexpected results.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. A page token, received from a previous list spaces call.
Provide this parameter to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value may lead to unexpected results.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
Optional. A query filter.
You can filter spaces by the space type
(space_type).
To filter by space type, you must specify valid enum value, such as
SPACE or GROUP_CHAT (the space_type can't be
SPACE_TYPE_UNSPECIFIED). To query for multiple space types, use the OR
operator.
For example, the following queries are valid:
space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"
Invalid queries are rejected by the server with an INVALID_ARGUMENT
error.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
Optional. A query filter.
You can filter spaces by the space type
(space_type).
To filter by space type, you must specify valid enum value, such as
SPACE or GROUP_CHAT (the space_type can't be
SPACE_TYPE_UNSPECIFIED). To query for multiple space types, use the OR
operator.
For example, the following queries are valid:
space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"
Invalid queries are rejected by the server with an INVALID_ARGUMENT
error.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|