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.



3833
3834
3835
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3833

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) 


3763
3764
3765
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3763

def admin_installed
  @admin_installed
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) 


3774
3775
3776
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3774

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) 


3786
3787
3788
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3786

def external_user_allowed
  @external_user_allowed
end

#name ⇒ String

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

Returns:

  • (String) 


3792
3793
3794
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3792

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) 


3797
3798
3799
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3797

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:



3803
3804
3805
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3803

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) 


3808
3809
3810
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3808

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) 


3813
3814
3815
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3813

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) 


3819
3820
3821
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3819

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) 


3825
3826
3827
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3825

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) 


3831
3832
3833
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3831

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3838

def update!(**args)
  @admin_installed = args[:admin_installed] if args.key?(:admin_installed)
  @display_name = args[:display_name] if args.key?(:display_name)
  @external_user_allowed = args[:external_user_allowed] if args.key?(:external_user_allowed)
  @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