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.



4659
4660
4661
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4659

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#access_settings ⇒ Google::Apis::ChatV1::AccessSettings

Represents the access setting of the space. Corresponds to the JSON property accessSettings

Returns:



4560
4561
4562
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4560

def access_settings
  @access_settings
end

#admin_installed ⇒ Boolean Also known as: admin_installed?

Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. Corresponds to the JSON property adminInstalled

Returns:

  • (Boolean) 


4569
4570
4571
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4569

def admin_installed
  @admin_installed
end

#create_time ⇒ String

Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when spaceType is GROUP_CHAT or SPACE. Corresponds to the JSON property createTime

Returns:

  • (String) 


4579
4580
4581
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4579

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


4589
4590
4591
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4589

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 consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. Corresponds to the JSON property externalUserAllowed

Returns:

  • (Boolean) 


4599
4600
4601
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4599

def external_user_allowed
  @external_user_allowed
end

#import_mode ⇒ Boolean Also known as: import_mode?

Optional. Whether this space is created in Import Mode as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Corresponds to the JSON property importMode

Returns:

  • (Boolean) 


4607
4608
4609
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4607

def import_mode
  @import_mode
end

#name ⇒ String

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

Returns:

  • (String) 


4613
4614
4615
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4613

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) 


4618
4619
4620
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4618

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:



4624
4625
4626
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4624

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) 


4629
4630
4631
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4629

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) 


4634
4635
4636
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4634

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) 


4640
4641
4642
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4640

def space_type
  @space_type
end

#space_uri ⇒ String

Output only. The URI for a user to access the space. Corresponds to the JSON property spaceUri

Returns:

  • (String) 


4645
4646
4647
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4645

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


4651
4652
4653
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4651

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) 


4657
4658
4659
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4657

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4664

def update!(**args)
  @access_settings = args[:access_settings] if args.key?(:access_settings)
  @admin_installed = args[:admin_installed] if args.key?(:admin_installed)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @external_user_allowed = args[:external_user_allowed] if args.key?(:external_user_allowed)
  @import_mode = args[:import_mode] if args.key?(:import_mode)
  @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)
  @space_uri = args[:space_uri] if args.key?(:space_uri)
  @threaded = args[:threaded] if args.key?(:threaded)
  @type = args[:type] if args.key?(:type)
end