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.



3589
3590
3591
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3589

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) 


3532
3533
3534
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3532

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) 


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

def display_name
  @display_name
end

#name ⇒ String

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

Returns:

  • (String) 


3545
3546
3547
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3545

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) 


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

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:



3556
3557
3558
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3556

def space_details
  @space_details
end

#space_history_state ⇒ String

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

Returns:

  • (String) 


3562
3563
3564
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3562

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) 


3567
3568
3569
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3567

def space_threading_state
  @space_threading_state
end

#space_type ⇒ String

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

Returns:

  • (String) 


3574
3575
3576
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3574

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) 


3580
3581
3582
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3580

def threaded
  @threaded
end

#type ⇒ String

Output only. Deprecated: Use singleUserBotDm or spaceType (developer preview) instead. The type of a space. Corresponds to the JSON property type

Returns:

  • (String) 


3587
3588
3589
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3587

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3594

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