Class SetUpSpaceRequest
Request to create a space and add specified users to it.
Implements
Inherited Members
Namespace: Google.Apis.HangoutsChat.v1.Data
Assembly: Google.Apis.HangoutsChat.v1.dll
Syntax
public class SetUpSpaceRequest : IDirectResponseSchema
Properties
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
Memberships
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). The
Membership.member
field must contain a user
with name
populated (format: users/{user}
) and type
set to User.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, the user.name
can be users/example@gmail.com
." To invite Gmail users
or users from external Google Workspace domains, user's email must be used for {user}
. Optional when
setting Space.spaceType
to SPACE
. Required when setting Space.spaceType
to GROUP_CHAT
, along with at
least two memberships. Required when setting Space.spaceType
to DIRECT_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 setting Space.spaceType
to DIRECT_MESSAGE
and Space.singleUserBotDm
to true
).
Declaration
[JsonProperty("memberships")]
public virtual IList<Membership> Memberships { get; set; }
Property Value
Type | Description |
---|---|
IList<Membership> |
RequestId
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.
Declaration
[JsonProperty("requestId")]
public virtual string RequestId { get; set; }
Property Value
Type | Description |
---|---|
string |
Space
Required. The Space.spaceType
field is required. To create a space, set Space.spaceType
to SPACE
and
set Space.displayName
. If you receive the error message ALREADY_EXISTS
when setting up a space, try a
different displayName
. An existing space within the Google Workspace organization might already use this
display name. To create a group chat, set Space.spaceType
to GROUP_CHAT
. Don't set Space.displayName
.
To create a 1:1 conversation between humans, set Space.spaceType
to DIRECT_MESSAGE
and set
Space.singleUserBotDm
to false
. Don't set Space.displayName
or Space.spaceDetails
. To create an 1:1
conversation between a human and the calling Chat app, set Space.spaceType
to DIRECT_MESSAGE
and
Space.singleUserBotDm
to true
. Don't set Space.displayName
or Space.spaceDetails
. If a
DIRECT_MESSAGE
space already exists, that space is returned instead of creating a new space.
Declaration
[JsonProperty("space")]
public virtual Space Space { get; set; }
Property Value
Type | Description |
---|---|
Space |