View Source GoogleApi.Chat.V1.Model.SetUpSpaceRequest (google_api_chat v0.34.3)
Attributes
-
memberships
(type:list(GoogleApi.Chat.V1.Model.Membership.t)
, default:nil
) - Optional. The Google Chat users 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). TheMembership.member
field must contain auser
withname
populated (format:users/{user}
) andtype
set 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.name
can beusers/example@gmail.com
." To invite Gmail users or users from external Google Workspace domains, user's email must be used for{user}
. Optional when settingSpace.spaceType
toSPACE
. Required when settingSpace.spaceType
toGROUP_CHAT
, along with at least two memberships. Required when settingSpace.spaceType
toDIRECT_MESSAGE
with 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.spaceType
toDIRECT_MESSAGE
andSpace.singleUserBotDm
totrue
). -
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.spaceType
field is required. To create a space, setSpace.spaceType
toSPACE
and setSpace.displayName
. If you receive the error messageALREADY_EXISTS
when 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.spaceType
toGROUP_CHAT
. Don't setSpace.displayName
. To create a 1:1 conversation between humans, setSpace.spaceType
toDIRECT_MESSAGE
and setSpace.singleUserBotDm
tofalse
. Don't setSpace.displayName
orSpace.spaceDetails
. To create an 1:1 conversation between a human and the calling Chat app, setSpace.spaceType
toDIRECT_MESSAGE
andSpace.singleUserBotDm
totrue
. Don't setSpace.displayName
orSpace.spaceDetails
. If aDIRECT_MESSAGE
space 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.