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.



3057
3058
3059
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3057

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) 


3013
3014
3015
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3013

def admin_installed
  @admin_installed
end

#display_name ⇒ String

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

Returns:

  • (String) 


3021
3022
3023
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3021

def display_name
  @display_name
end

#name ⇒ String

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

Returns:

  • (String) 


3026
3027
3028
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3026

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) 


3031
3032
3033
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3031

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:



3037
3038
3039
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3037

def space_details
  @space_details
end

#space_threading_state ⇒ String

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

Returns:

  • (String) 


3042
3043
3044
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3042

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


3048
3049
3050
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3048

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) 


3055
3056
3057
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3055

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3062

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_threading_state = args[:space_threading_state] if args.key?(:space_threading_state)
  @threaded = args[:threaded] if args.key?(:threaded)
  @type = args[:type] if args.key?(:type)
end