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.

Inheritance
object
Space
Implements
Inherited Members
Namespace: Google.Apps.Chat.V1
Assembly: Google.Apps.Chat.V1.dll
Syntax
public sealed class Space : IMessage<Space>, IEquatable<Space>, IDeepCloneable<Space>, IBufferMessage, IMessage

Constructors

Space()

Declaration
public Space()

Space(Space)

Declaration
public Space(Space other)
Parameters
Type Name Description
Space other

Properties

AccessSettings

Optional. Specifies the access setting of the space. Only populated when the space_type is SPACE.

Declaration
public Space.Types.AccessSettings AccessSettings { get; set; }
Property Value
Type Description
Space.Types.AccessSettings

AdminInstalled

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.

Declaration
public bool AdminInstalled { get; set; }
Property Value
Type Description
bool

CreateTime

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.

Declaration
public Timestamp CreateTime { get; set; }
Property Value
Type Description
Timestamp

Customer

Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with app authentication and SpaceType is SPACE, otherwise should not be set.

In the format customers/{customer}, where customer is the id from the Admin SDK customer resource. Private apps can also use the customers/my_customer alias to create the space in the same Google Workspace organization as the app.

For DMs, this field isn't populated.

Declaration
public string Customer { get; set; }
Property Value
Type Description
string

DisplayName

Optional. The space's display name. Required when creating a space with a spaceType of 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.

Declaration
public string DisplayName { get; set; }
Property Value
Type Description
string

ExternalUserAllowed

Optional. 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.

Declaration
public bool ExternalUserAllowed { get; set; }
Property Value
Type Description
bool

HasCustomer

Gets whether the "customer" field is set

Declaration
public bool HasCustomer { get; }
Property Value
Type Description
bool

HasPredefinedPermissionSettings

Gets whether the "predefined_permission_settings" field is set

Declaration
public bool HasPredefinedPermissionSettings { get; }
Property Value
Type Description
bool

ImportMode

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.

Creating a space in Import Moderequires user authentication.

Declaration
public bool ImportMode { get; set; }
Property Value
Type Description
bool

ImportModeExpireTime

Output only. The time when the space will be automatically deleted by the system if it remains in import mode.

Each space created in import mode must exit this mode before this expire time using spaces.completeImport.

This field is only populated for spaces that were created with import mode.

Declaration
public Timestamp ImportModeExpireTime { get; set; }
Property Value
Type Description
Timestamp

LastActiveTime

Output only. Timestamp of the last message in the space.

Declaration
public Timestamp LastActiveTime { get; set; }
Property Value
Type Description
Timestamp

MembershipCount

Output only. The count of joined memberships grouped by member type. Populated when the space_type is SPACE, DIRECT_MESSAGE or GROUP_CHAT.

Declaration
public Space.Types.MembershipCount MembershipCount { get; set; }
Property Value
Type Description
Space.Types.MembershipCount

Name

Identifier. 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 the spaces.list() method or from the space URL. For example, if the space URL is https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA, the space ID is AAAAAAAAA.

Declaration
public string Name { get; set; }
Property Value
Type Description
string

PermissionSettings

Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings.

Reading and updating permission settings supports:

Declaration
public Space.Types.PermissionSettings PermissionSettings { get; set; }
Property Value
Type Description
Space.Types.PermissionSettings

PredefinedPermissionSettings

Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the PermissionSettings field.

Setting predefined permission settings supports:

Declaration
public Space.Types.PredefinedPermissionSettings PredefinedPermissionSettings { get; set; }
Property Value
Type Description
Space.Types.PredefinedPermissionSettings

SingleUserBotDm

Optional. Whether the space is a DM between a Chat app and a single human.

Declaration
public bool SingleUserBotDm { get; set; }
Property Value
Type Description
bool

SpaceDetails

Optional. Details about the space including description and rules.

Declaration
public Space.Types.SpaceDetails SpaceDetails { get; set; }
Property Value
Type Description
Space.Types.SpaceDetails

SpaceHistoryState

Optional. The message history state for messages and threads in this space.

Declaration
public HistoryState SpaceHistoryState { get; set; }
Property Value
Type Description
HistoryState

SpaceName

SpaceName-typed view over the Name resource name property.

Declaration
public SpaceName SpaceName { get; set; }
Property Value
Type Description
SpaceName

SpacePermissionSettingsCase

Declaration
public Space.SpacePermissionSettingsOneofCase SpacePermissionSettingsCase { get; }
Property Value
Type Description
Space.SpacePermissionSettingsOneofCase

SpaceThreadingState

Output only. The threading state in the Chat space.

Declaration
public Space.Types.SpaceThreadingState SpaceThreadingState { get; set; }
Property Value
Type Description
Space.Types.SpaceThreadingState

SpaceType

Optional. The type of space. Required when creating a space or updating the space type of a space. Output only for other usage.

Declaration
public Space.Types.SpaceType SpaceType { get; set; }
Property Value
Type Description
Space.Types.SpaceType

SpaceUri

Output only. The URI for a user to access the space.

Declaration
public string SpaceUri { get; set; }
Property Value
Type Description
string

Threaded

Output only. Deprecated: Use spaceThreadingState instead. Whether messages are threaded in this space.

Declaration
[Obsolete]
public bool Threaded { get; set; }
Property Value
Type Description
bool

Type

Output only. Deprecated: Use space_type instead. The type of a space.

Declaration
[Obsolete]
public Space.Types.Type Type { get; set; }
Property Value
Type Description
Space.Types.Type