View Source GoogleApi.Chat.V1.Model.SetUpSpaceRequest (google_api_chat v0.41.4)
Request to create a space and add specified users to it.
Attributes
-
memberships(type:list(GoogleApi.Chat.V1.Model.Membership.t), default:nil) - Optional. The Google Chat users or groups to invite to join the space. Omit the calling user, as they are added automatically. The set currently allows up to 20 memberships (in addition to the caller). For human membership, theMembership.memberfield must contain auserwithnamepopulated (format:users/{user}) andtypeset toUser.Type.HUMAN. You can only add human users when setting up a space (adding Chat apps is only supported for direct message setup with the calling app). You can also add members using the user's email as an alias for {user}. For example, theuser.namecan beusers/example@gmail.com. To invite Gmail users or users from external Google Workspace domains, user's email must be used for{user}. For Google group membership, theMembership.group_memberfield must contain agroupwithnamepopulated (formatgroups/{group}). You can only add Google groups when settingSpace.spaceTypetoSPACE. Optional when settingSpace.spaceTypetoSPACE. Required when settingSpace.spaceTypetoGROUP_CHAT, along with at least two memberships. Required when settingSpace.spaceTypetoDIRECT_MESSAGEwith a human user, along with exactly one membership. Must be empty when creating a 1:1 conversation between a human and the calling Chat app (when settingSpace.spaceTypetoDIRECT_MESSAGEandSpace.singleUserBotDmtotrue). -
requestId(type:String.t, default:nil) - 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. -
space(type:GoogleApi.Chat.V1.Model.Space.t, default:nil) - Required. TheSpace.spaceTypefield is required. To create a space, setSpace.spaceTypetoSPACEand setSpace.displayName. If you receive the error messageALREADY_EXISTSwhen setting up a space, try a differentdisplayName. An existing space within the Google Workspace organization might already use this display name. To create a group chat, setSpace.spaceTypetoGROUP_CHAT. Don't setSpace.displayName. To create a 1:1 conversation between humans, setSpace.spaceTypetoDIRECT_MESSAGEand setSpace.singleUserBotDmtofalse. Don't setSpace.displayNameorSpace.spaceDetails. To create an 1:1 conversation between a human and the calling Chat app, setSpace.spaceTypetoDIRECT_MESSAGEandSpace.singleUserBotDmtotrue. Don't setSpace.displayNameorSpace.spaceDetails. If aDIRECT_MESSAGEspace already exists, that space is returned instead of creating a new space.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.Chat.V1.Model.SetUpSpaceRequest{ memberships: [GoogleApi.Chat.V1.Model.Membership.t()] | nil, requestId: String.t() | nil, space: GoogleApi.Chat.V1.Model.Space.t() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.