Google Apps Chat V1 Client - Class GetSpaceReadStateRequest (0.1.4)

Reference documentation and code samples for the Google Apps Chat V1 Client class GetSpaceReadStateRequest.

Request message for GetSpaceReadState API.

Generated from protobuf message google.chat.v1.GetSpaceReadStateRequest

Namespace

Google \ Apps \ Chat \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. Resource name of the space 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}/spaceReadState. - Their Workspace email address. For example, users/user@example.com/spaces/{space}/spaceReadState. - Their user id. For example, users/123456789/spaces/{space}/spaceReadState. Format: users/{user}/spaces/{space}/spaceReadState

getName

Required. Resource name of the space 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}/spaceReadState.
  • Their Workspace email address. For example, users/user@example.com/spaces/{space}/spaceReadState.
  • Their user id. For example, users/123456789/spaces/{space}/spaceReadState. Format: users/{user}/spaces/{space}/spaceReadState
Returns
Type Description
string

setName

Required. Resource name of the space 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}/spaceReadState.
  • Their Workspace email address. For example, users/user@example.com/spaces/{space}/spaceReadState.
  • Their user id. For example, users/123456789/spaces/{space}/spaceReadState. Format: users/{user}/spaces/{space}/spaceReadState
Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. Resource name of the space 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}/spaceReadState.

  • Their Workspace email address. For example, users/user@example.com/spaces/{space}/spaceReadState.

  • Their user id. For example, users/123456789/spaces/{space}/spaceReadState.

Format: users/{user}/spaces/{space}/spaceReadState Please see Google\Apps\Chat\V1\ChatServiceClient::spaceReadStateName() for help formatting this field.
Returns
Type Description
Google\Apps\Chat\V1\GetSpaceReadStateRequest