Reference documentation and code samples for the Google Apps Chat V1 Client class Space.
A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app.
Generated from protobuf message google.chat.v1.Space
Namespace
Google \ Apps \ Chat \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Resource name of the space. Format: spaces/{space}
↳ type
int
Output only. Deprecated: Use space_type
instead. The type of a space.
↳ space_type
int
The type of space. Required when creating a space or updating the space type of a space. Output only for other usage.
↳ single_user_bot_dm
bool
Optional. Whether the space is a DM between a Chat app and a single human.
↳ threaded
bool
Output only. Deprecated: Use spaceThreadingState
instead. Whether messages are threaded in this space.
↳ display_name
string
The space's display name. Required when creating a space
. If you receive the error message ALREADY_EXISTS
when creating a space or updating the displayName
, try a different displayName
. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
↳ external_user_allowed
bool
Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to import data to Google Chat because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the Google Workspace Developer Preview Program , import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only.
↳ space_threading_state
int
Output only. The threading state in the Chat space.
↳ space_details
↳ space_history_state
int
The message history state for messages and threads in this space.
↳ import_mode
bool
Optional. Whether this space is created in Import Mode
as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete.
↳ create_time
Google\Protobuf\Timestamp
Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when spaceType
is GROUP_CHAT
or SPACE
.
↳ admin_installed
bool
Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
↳ access_settings
Google\Apps\Chat\V1\Space\AccessSettings
Optional. Specifies the access setting
of the space. Only populated when the space_type
is SPACE
.
↳ space_uri
string
Output only. The URI for a user to access the space.
getName
Resource name of the space.
Format: spaces/{space}
string
setName
Resource name of the space.
Format: spaces/{space}
var
string
$this
getType
Output only. Deprecated: Use space_type
instead.
The type of a space.
int
setType
Output only. Deprecated: Use space_type
instead.
The type of a space.
var
int
$this
getSpaceType
The type of space. Required when creating a space or updating the space type of a space. Output only for other usage.
int
setSpaceType
The type of space. Required when creating a space or updating the space type of a space. Output only for other usage.
var
int
$this
getSingleUserBotDm
Optional. Whether the space is a DM between a Chat app and a single human.
bool
setSingleUserBotDm
Optional. Whether the space is a DM between a Chat app and a single human.
var
bool
$this
getThreaded
Output only. Deprecated: Use spaceThreadingState
instead.
Whether messages are threaded in this space.
bool
setThreaded
Output only. Deprecated: Use spaceThreadingState
instead.
Whether messages are threaded in this space.
var
bool
$this
getDisplayName
The space's display name. Required when creating a space .
If you receive the error message ALREADY_EXISTS
when creating a space or
updating the displayName
, try a different displayName
. An
existing space within the Google Workspace organization might already use
this display name.
For direct messages, this field might be empty.
Supports up to 128 characters.
string
setDisplayName
The space's display name. Required when creating a space .
If you receive the error message ALREADY_EXISTS
when creating a space or
updating the displayName
, try a different displayName
. An
existing space within the Google Workspace organization might already use
this display name.
For direct messages, this field might be empty.
Supports up to 128 characters.
var
string
$this
getExternalUserAllowed
Immutable. Whether this space permits any Google Chat user as a member.
Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions:
- The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user.
- The space is used to import data to Google Chat because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the Google Workspace Developer Preview Program , import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only.
bool
setExternalUserAllowed
Immutable. Whether this space permits any Google Chat user as a member.
Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions:
- The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user.
- The space is used to import data to Google Chat because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the Google Workspace Developer Preview Program , import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only.
var
bool
$this
getSpaceThreadingState
Output only. The threading state in the Chat space.
int
setSpaceThreadingState
Output only. The threading state in the Chat space.
var
int
$this
getSpaceDetails
Details about the space including description and rules.
hasSpaceDetails
clearSpaceDetails
setSpaceDetails
Details about the space including description and rules.
$this
getSpaceHistoryState
The message history state for messages and threads in this space.
int
setSpaceHistoryState
The message history state for messages and threads in this space.
var
int
$this
getImportMode
Optional. Whether this space is created in Import Mode
as part of a data
migration into Google Workspace. While spaces are being imported, they
aren't visible to users until the import is complete.
bool
setImportMode
Optional. Whether this space is created in Import Mode
as part of a data
migration into Google Workspace. While spaces are being imported, they
aren't visible to users until the import is complete.
var
bool
$this
getCreateTime
Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces.
For import mode spaces, set this field to the historical timestamp at which
the space was created in the source in order to preserve the original
creation time.
Only populated in the output when spaceType
is GROUP_CHAT
or SPACE
.
hasCreateTime
clearCreateTime
setCreateTime
Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces.
For import mode spaces, set this field to the historical timestamp at which
the space was created in the source in order to preserve the original
creation time.
Only populated in the output when spaceType
is GROUP_CHAT
or SPACE
.
$this
getAdminInstalled
Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization.
To support admin install, your Chat app must feature direct messaging.
bool
setAdminInstalled
Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization.
To support admin install, your Chat app must feature direct messaging.
var
bool
$this
getAccessSettings
Optional. Specifies the access setting of the space.
Only populated when the space_type
is SPACE
.
hasAccessSettings
clearAccessSettings
setAccessSettings
Optional. Specifies the access setting of the space.
Only populated when the space_type
is SPACE
.
$this
getSpaceUri
Output only. The URI for a user to access the space.
string
setSpaceUri
Output only. The URI for a user to access the space.
var
string
$this
