Reference documentation and code samples for the Google Apps Chat V1 Client class FindGroupChatsRequest.
A request to get group chat spaces based on user resources.
Generated from protobuf message google.chat.v1.FindGroupChatsRequest
Namespace
Google \ Apps \ Chat \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ users |
string[]
Optional. Resource names of all human users in group chat with the calling user. Chat apps can't be included in the request. The maximum number of users that can be specified in a single request is |
↳ page_size |
int
Optional. The maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 10 spaces are returned. The maximum value is 30. If you use a value more than 30, it's automatically changed to 30. Negative values return an |
↳ page_token |
string
Optional. A page token, received from a previous call to find group chats. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the token. Passing different values may lead to unexpected results. |
↳ space_view |
int
Requested space view type. If unset, defaults to |
getUsers
Optional. Resource names of all human users in group chat with the calling user. Chat apps can't be included in the request.
The maximum number of users that can be specified in a single request is
49.
Format: users/{user}, where {user} is either the id for the
person from the
People API, or the id for the
user
in the Directory API. For example, to find all group chats with the calling
user and two other users, with People API profile IDs 123456789 and
987654321, you can use users/123456789 and users/987654321.
You can also use the email as an alias for {user}. For example,
users/example\@gmail.com where example\@gmail.com is the email of the
Google Chat user.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setUsers
Optional. Resource names of all human users in group chat with the calling user. Chat apps can't be included in the request.
The maximum number of users that can be specified in a single request is
49.
Format: users/{user}, where {user} is either the id for the
person from the
People API, or the id for the
user
in the Directory API. For example, to find all group chats with the calling
user and two other users, with People API profile IDs 123456789 and
987654321, you can use users/123456789 and users/987654321.
You can also use the email as an alias for {user}. For example,
users/example\@gmail.com where example\@gmail.com is the email of the
Google Chat user.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Optional. The maximum number of spaces to return. The service might return fewer than this value.
If unspecified, at most 10 spaces are returned.
The maximum value is 30. If you use a value more than 30, it's
automatically changed to 30.
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 10 spaces are returned.
The maximum value is 30. If you use a value more than 30, it's
automatically changed to 30.
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 call to find group chats.
Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the token. Passing different values may lead to unexpected results.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. A page token, received from a previous call to find group chats.
Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the token. Passing different values may lead to unexpected results.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSpaceView
Requested space view type. If unset, defaults to
SPACE_VIEW_RESOURCE_NAME_ONLY. Requests that specify
SPACE_VIEW_EXPANDED must include scopes that allow reading space data,
for example,
https://www.googleapis.com/auth/chat.spaces or
https://www.googleapis.com/auth/chat.spaces.readonly.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type SpaceView. |
setSpaceView
Requested space view type. If unset, defaults to
SPACE_VIEW_RESOURCE_NAME_ONLY. Requests that specify
SPACE_VIEW_EXPANDED must include scopes that allow reading space data,
for example,
https://www.googleapis.com/auth/chat.spaces or
https://www.googleapis.com/auth/chat.spaces.readonly.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type SpaceView. |
| Returns | |
|---|---|
| Type | Description |
$this |
|