Reference documentation and code samples for the Google Apps Chat V1 Client class GetThreadReadStateRequest.
Request message for GetThreadReadStateRequest API.
Generated from protobuf message google.chat.v1.GetThreadReadStateRequest
Namespace
Google \ Apps \ Chat \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. Resource name of the thread read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The |
getName
Required. Resource name of the thread read state to retrieve.
Only supports getting read state for the calling user. To refer to the calling user, set one of the following:
- The
me
alias. For example,users/me/spaces/{space}/threads/{thread}/threadReadState
. - Their Workspace email address. For example,
users/user@example.com/spaces/{space}/threads/{thread}/threadReadState
. - Their user id. For example,
users/123456789/spaces/{space}/threads/{thread}/threadReadState
. Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState
Returns | |
---|---|
Type | Description |
string |
setName
Required. Resource name of the thread read state to retrieve.
Only supports getting read state for the calling user. To refer to the calling user, set one of the following:
- The
me
alias. For example,users/me/spaces/{space}/threads/{thread}/threadReadState
. - Their Workspace email address. For example,
users/user@example.com/spaces/{space}/threads/{thread}/threadReadState
. - Their user id. For example,
users/123456789/spaces/{space}/threads/{thread}/threadReadState
. Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameter | |
---|---|
Name | Description |
name |
string
Required. Resource name of the thread read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following:
Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState Please see Google\Apps\Chat\V1\ChatServiceClient::threadReadStateName() for help formatting this field. |
Returns | |
---|---|
Type | Description |
Google\Apps\Chat\V1\GetThreadReadStateRequest |