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.



3549
3550
3551
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3549

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) 


3495
3496
3497
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3495

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) 


3503
3504
3505
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3503

def display_name
  @display_name
end

#name ⇒ String

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

Returns:

  • (String) 


3508
3509
3510
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3508

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) 


3513
3514
3515
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3513

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:



3519
3520
3521
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3519

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) 


3524
3525
3526
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3524

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) 


3529
3530
3531
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3529

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) 


3535
3536
3537
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3535

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) 


3541
3542
3543
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3541

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) 


3547
3548
3549
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3547

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3554

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