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.



4734
4735
4736
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4734

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:



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

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) 


4627
4628
4629
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4627

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) 


4637
4638
4639
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4637

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) 


4647
4648
4649
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4647

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) 


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

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) 


4665
4666
4667
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4665

def import_mode
  @import_mode
end

#last_active_time ⇒ String

Output only. Timestamp of the last message in the space. Developer Preview. Corresponds to the JSON property lastActiveTime

Returns:

  • (String) 


4672
4673
4674
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4672

def last_active_time
  @last_active_time
end

#membership_count ⇒ Google::Apis::ChatV1::MembershipCount

Developer Preview. Represents the count of memberships of a space, grouped into categories. Corresponds to the JSON property membershipCount

Returns:



4678
4679
4680
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4678

def membership_count
  @membership_count
end

#name ⇒ String

Resource name of the space. Format: spaces/spaceWherespace` represents the system-assigned ID for the space. You can obtain the space ID by calling the [spaces.list()](https://developers.google.com/workspace/chat/ api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL ishttps://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is AAAAAAAAA. Corresponds to the JSON property name

Returns:

  • (String) 


4688
4689
4690
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4688

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) 


4693
4694
4695
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4693

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:



4699
4700
4701
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4699

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) 


4704
4705
4706
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4704

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) 


4709
4710
4711
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4709

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) 


4715
4716
4717
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4715

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) 


4720
4721
4722
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4720

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) 


4726
4727
4728
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4726

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) 


4732
4733
4734
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4732

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4739

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)
  @last_active_time = args[:last_active_time] if args.key?(:last_active_time)
  @membership_count = args[:membership_count] if args.key?(:membership_count)
  @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