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.Apis.HangoutsChat.v1.Data
Assembly: Google.Apis.HangoutsChat.v1.dll
Syntax
public class Space : IDirectResponseSchema

Properties

AccessSettings

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

Declaration
[JsonProperty("accessSettings")]
public virtual AccessSettings AccessSettings { get; set; }
Property Value
Type Description
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
[JsonProperty("adminInstalled")]
public virtual bool? AdminInstalled { get; set; }
Property Value
Type Description
bool?

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

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
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { 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
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { 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
[JsonProperty("externalUserAllowed")]
public virtual bool? ExternalUserAllowed { get; set; }
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
[JsonProperty("importMode")]
public virtual bool? ImportMode { get; set; }
Property Value
Type Description
bool?

ImportModeExpireTime

object representation of ImportModeExpireTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ImportModeExpireTimeDateTimeOffset instead.")]
public virtual object ImportModeExpireTime { get; set; }
Property Value
Type Description
object

ImportModeExpireTimeDateTimeOffset

DateTimeOffset representation of ImportModeExpireTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? ImportModeExpireTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

ImportModeExpireTimeRaw

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
[JsonProperty("importModeExpireTime")]
public virtual string ImportModeExpireTimeRaw { get; set; }
Property Value
Type Description
string

LastActiveTime

object representation of LastActiveTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use LastActiveTimeDateTimeOffset instead.")]
public virtual object LastActiveTime { get; set; }
Property Value
Type Description
object

LastActiveTimeDateTimeOffset

DateTimeOffset representation of LastActiveTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? LastActiveTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

LastActiveTimeRaw

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

Declaration
[JsonProperty("lastActiveTime")]
public virtual string LastActiveTimeRaw { get; set; }
Property Value
Type Description
string

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
[JsonProperty("membershipCount")]
public virtual MembershipCount MembershipCount { get; set; }
Property Value
Type Description
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
[JsonProperty("name")]
public virtual 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: - In Developer Preview, App authentication with administrator approval with the chat.app.spaces scope. Only populated and settable when the Chat app created the space. - User authentication

Declaration
[JsonProperty("permissionSettings")]
public virtual PermissionSettings PermissionSettings { get; set; }
Property Value
Type Description
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: - In Developer Preview, App authentication with administrator approval with the chat.app.spaces or chat.app.spaces.create scopes. - User authentication

Declaration
[JsonProperty("predefinedPermissionSettings")]
public virtual string PredefinedPermissionSettings { get; set; }
Property Value
Type Description
string

SingleUserBotDm

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

Declaration
[JsonProperty("singleUserBotDm")]
public virtual bool? SingleUserBotDm { get; set; }
Property Value
Type Description
bool?

SpaceDetails

Optional. Details about the space including description and rules.

Declaration
[JsonProperty("spaceDetails")]
public virtual SpaceDetails SpaceDetails { get; set; }
Property Value
Type Description
SpaceDetails

SpaceHistoryState

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

Declaration
[JsonProperty("spaceHistoryState")]
public virtual string SpaceHistoryState { get; set; }
Property Value
Type Description
string

SpaceThreadingState

Output only. The threading state in the Chat space.

Declaration
[JsonProperty("spaceThreadingState")]
public virtual string SpaceThreadingState { get; set; }
Property Value
Type Description
string

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
[JsonProperty("spaceType")]
public virtual string SpaceType { get; set; }
Property Value
Type Description
string

SpaceUri

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

Declaration
[JsonProperty("spaceUri")]
public virtual string SpaceUri { get; set; }
Property Value
Type Description
string

Threaded

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

Declaration
[JsonProperty("threaded")]
public virtual bool? Threaded { get; set; }
Property Value
Type Description
bool?

Type

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

Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type Description
string

Implements