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.



3722
3723
3724
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3722

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) 


3668
3669
3670
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3668

def admin_installed
  @admin_installed
end

#display_name ⇒ String

The space's display name. Required when creating a space. For direct messages, this field might be empty. Supports up to 128 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


3676
3677
3678
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3676

def display_name
  @display_name
end

#name ⇒ String

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

Returns:

  • (String) 


3681
3682
3683
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3681

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) 


3686
3687
3688
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3686

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:



3692
3693
3694
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3692

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) 


3697
3698
3699
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3697

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) 


3702
3703
3704
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3702

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) 


3708
3709
3710
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3708

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) 


3714
3715
3716
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3714

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) 


3720
3721
3722
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3720

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3727

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