View Source GoogleApi.Chat.V1.Model.Space (google_api_chat v0.40.0)
A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app.
Attributes
-
accessSettings
(type:GoogleApi.Chat.V1.Model.AccessSettings.t
, default:nil
) - Optional. Specifies the access setting of the space. Only populated when thespace_type
isSPACE
. -
adminInstalled
(type:boolean()
, default:nil
) - 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. -
createTime
(type:DateTime.t
, default:nil
) - 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 whenspaceType
isGROUP_CHAT
orSPACE
. -
displayName
(type:String.t
, default:nil
) - The space's display name. Required when creating a space with aspaceType
ofSPACE
. If you receive the error messageALREADY_EXISTS
when creating a space or updating thedisplayName
, try a differentdisplayName
. 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. -
externalUserAllowed
(type:boolean()
, default:nil
) - 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. For existing spaces, this field is output only. -
importMode
(type:boolean()
, default:nil
) - Optional. Whether this space is created inImport 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. -
lastActiveTime
(type:DateTime.t
, default:nil
) - Output only. Timestamp of the last message in the space. -
membershipCount
(type:GoogleApi.Chat.V1.Model.MembershipCount.t
, default:nil
) - Output only. The count of joined memberships grouped by member type. Populated when thespace_type
isSPACE
,DIRECT_MESSAGE
orGROUP_CHAT
. -
name
(type:String.t
, default:nil
) - Resource name of the space. Format:spaces/{space}
Where{space}
represents the system-assigned ID for the space. You can obtain the space ID by calling thespaces.list()
method or from the space URL. For example, if the space URL ishttps://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA
, the space ID isAAAAAAAAA
. -
permissionSettings
(type:GoogleApi.Chat.V1.Model.PermissionSettings.t
, default:nil
) - Optional. Exact permission settings which can be set to update the space. Input for updating a space. Otherwise, output only. For space creation, usepredefined_permission_settings
instead. -
predefinedPermissionSettings
(type:String.t
, default:nil
) - Optional. Input only. Space permission settings. Input for creating a space, a collaboration space is created if this field is not set. After you create the space, settings are populated in thePermissionSettings
field. -
singleUserBotDm
(type:boolean()
, default:nil
) - Optional. Whether the space is a DM between a Chat app and a single human. -
spaceDetails
(type:GoogleApi.Chat.V1.Model.SpaceDetails.t
, default:nil
) - Details about the space including description and rules. -
spaceHistoryState
(type:String.t
, default:nil
) - The message history state for messages and threads in this space. -
spaceThreadingState
(type:String.t
, default:nil
) - Output only. The threading state in the Chat space. -
spaceType
(type:String.t
, default:nil
) - The type of space. Required when creating a space or updating the space type of a space. Output only for other usage. -
spaceUri
(type:String.t
, default:nil
) - Output only. The URI for a user to access the space. -
threaded
(type:boolean()
, default:nil
) - Output only. Deprecated: UsespaceThreadingState
instead. Whether messages are threaded in this space. -
type
(type:String.t
, default:nil
) - Output only. Deprecated: Usespace_type
instead. The type of a space.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.Chat.V1.Model.Space{ accessSettings: GoogleApi.Chat.V1.Model.AccessSettings.t() | nil, adminInstalled: boolean() | nil, createTime: DateTime.t() | nil, displayName: String.t() | nil, externalUserAllowed: boolean() | nil, importMode: boolean() | nil, lastActiveTime: DateTime.t() | nil, membershipCount: GoogleApi.Chat.V1.Model.MembershipCount.t() | nil, name: String.t() | nil, permissionSettings: GoogleApi.Chat.V1.Model.PermissionSettings.t() | nil, predefinedPermissionSettings: String.t() | nil, singleUserBotDm: boolean() | nil, spaceDetails: GoogleApi.Chat.V1.Model.SpaceDetails.t() | nil, spaceHistoryState: String.t() | nil, spaceThreadingState: String.t() | nil, spaceType: String.t() | nil, spaceUri: String.t() | nil, threaded: boolean() | nil, type: String.t() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.