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.
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 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.
↳ 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 INVALID_ARGUMENT
error.
↳ 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 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
.
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.
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.
var
string[]
$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.
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.
var
int
$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.
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.
var
string
$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
.
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
.
$this
