Class: Google::Apis::ChatV1::Space

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/chat_v1/classes.rb,
lib/google/apis/chat_v1/representations.rb,
lib/google/apis/chat_v1/representations.rb

Overview

A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Space

Returns a new instance of Space.



4120
4121
4122
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4120

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#admin_installed ⇒ Boolean Also known as: admin_installed?

Output only. Whether the Chat app was installed by a Google Workspace administrator. Administrators can install a Chat app for their domain, organizational unit, or a group of users. Administrators can only install Chat apps for direct messaging between users and the app. To support admin install, your app must feature direct messaging. Corresponds to the JSON property adminInstalled

Returns:

  • (Boolean) 


4033
4034
4035
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4033

def admin_installed
  @admin_installed
end

#create_time ⇒ String

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. Corresponds to the JSON property createTime

Returns:

  • (String) 


4043
4044
4045
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4043

def create_time
  @create_time
end

#display_name ⇒ String

The space's display name. Required when creating a 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. Corresponds to the JSON property displayName

Returns:

  • (String) 


4053
4054
4055
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4053

def display_name
  @display_name
end

#external_user_allowed ⇒ Boolean Also known as: external_user_allowed?

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 Google Account. By default, the space permits any Google Chat user. * The space is used to import data to Google Chat. Import mode spaces must only permit members from the same Google Workspace organization. For existing spaces, this field is output only. Corresponds to the JSON property externalUserAllowed

Returns:

  • (Boolean) 


4065
4066
4067
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4065

def external_user_allowed
  @external_user_allowed
end

#import_mode ⇒ Boolean Also known as: import_mode?

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. Corresponds to the JSON property importMode

Returns:

  • (Boolean) 


4073
4074
4075
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4073

def import_mode
  @import_mode
end

#name ⇒ String

Resource name of the space. Format: spaces/space` Corresponds to the JSON propertyname`

Returns:

  • (String) 


4079
4080
4081
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4079

def name
  @name
end

#single_user_bot_dm ⇒ Boolean Also known as: single_user_bot_dm?

Optional. Whether the space is a DM between a Chat app and a single human. Corresponds to the JSON property singleUserBotDm

Returns:

  • (Boolean) 


4084
4085
4086
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4084

def single_user_bot_dm
  @single_user_bot_dm
end

#space_details ⇒ Google::Apis::ChatV1::SpaceDetails

Details about the space including description and rules. Corresponds to the JSON property spaceDetails

Returns:



4090
4091
4092
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4090

def space_details
  @space_details
end

#space_history_state ⇒ String

The message history state for messages and threads in this space. Corresponds to the JSON property spaceHistoryState

Returns:

  • (String) 


4095
4096
4097
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4095

def space_history_state
  @space_history_state
end

#space_threading_state ⇒ String

Output only. The threading state in the Chat space. Corresponds to the JSON property spaceThreadingState

Returns:

  • (String) 


4100
4101
4102
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4100

def space_threading_state
  @space_threading_state
end

#space_type ⇒ String

The type of space. Required when creating a space or updating the space type of a space. Output only for other usage. Corresponds to the JSON property spaceType

Returns:

  • (String) 


4106
4107
4108
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4106

def space_type
  @space_type
end

#threaded ⇒ Boolean Also known as: threaded?

Output only. Deprecated: Use spaceThreadingState instead. Whether messages are threaded in this space. Corresponds to the JSON property threaded

Returns:

  • (Boolean) 


4112
4113
4114
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4112

def threaded
  @threaded
end

#type ⇒ String

Output only. Deprecated: Use space_type instead. The type of a space. Corresponds to the JSON property type

Returns:

  • (String) 


4118
4119
4120
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4118

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4125

def update!(**args)
  @admin_installed = args[:admin_installed] if args.key?(:admin_installed)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @external_user_allowed = args[:external_user_allowed] if args.key?(:external_user_allowed)
  @import_mode = args[:import_mode] if args.key?(:import_mode)
  @name = args[:name] if args.key?(:name)
  @single_user_bot_dm = args[:single_user_bot_dm] if args.key?(:single_user_bot_dm)
  @space_details = args[:space_details] if args.key?(:space_details)
  @space_history_state = args[:space_history_state] if args.key?(:space_history_state)
  @space_threading_state = args[:space_threading_state] if args.key?(:space_threading_state)
  @space_type = args[:space_type] if args.key?(:space_type)
  @threaded = args[:threaded] if args.key?(:threaded)
  @type = args[:type] if args.key?(:type)
end