Google Apps Chat V1 Client - Class CreateSpaceRequest (0.7.1)

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

A request to create a named space with no members.

Generated from protobuf message google.chat.v1.CreateSpaceRequest

Namespace

Google \ Apps \ Chat \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ space Space

Required. The displayName and spaceType fields must be populated. Only SpaceType.SPACE and SpaceType.GROUP_CHAT are supported. SpaceType.GROUP_CHAT can only be used if importMode is set to true. If you receive the error message ALREADY_EXISTS, try a different displayName. An existing space within the Google Workspace organization might already use this display name. The space name is assigned on the server so anything specified in this field will be ignored.
↳ request_id string

Optional. A unique identifier for this request. A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error.

getSpace

Required. The displayName and spaceType fields must be populated. Only SpaceType.SPACE and SpaceType.GROUP_CHAT are supported.

SpaceType.GROUP_CHAT can only be used if importMode is set to true. If you receive the error message ALREADY_EXISTS, try a different displayName. An existing space within the Google Workspace organization might already use this display name. The space name is assigned on the server so anything specified in this field will be ignored.

Returns
Type Description
Space|null

hasSpace

clearSpace

setSpace

Required. The displayName and spaceType fields must be populated. Only SpaceType.SPACE and SpaceType.GROUP_CHAT are supported.

SpaceType.GROUP_CHAT can only be used if importMode is set to true. If you receive the error message ALREADY_EXISTS, try a different displayName. An existing space within the Google Workspace organization might already use this display name. The space name is assigned on the server so anything specified in this field will be ignored.

Parameter
Name Description
var Space
Returns
Type Description
$this

getRequestId

Optional. A unique identifier for this request.

A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error.

Returns
Type Description
string

setRequestId

Optional. A unique identifier for this request.

A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
space Space

Required. The displayName and spaceType fields must be populated. Only SpaceType.SPACE and SpaceType.GROUP_CHAT are supported. SpaceType.GROUP_CHAT can only be used if importMode is set to true.

If you receive the error message ALREADY_EXISTS, try a different displayName. An existing space within the Google Workspace organization might already use this display name.

The space name is assigned on the server so anything specified in this field will be ignored.
Returns
Type Description
CreateSpaceRequest