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.



4893
4894
4895
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4893

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:



4762
4763
4764
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4762

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) 


4771
4772
4773
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4771

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) 


4781
4782
4783
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4781

def create_time
  @create_time
end

#display_name ⇒ String

The space's display name. Required when creating a space with a spaceType of 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) 


4792
4793
4794
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4792

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) 


4802
4803
4804
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4802

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. Creating a space in Import Moderequires user authentication. Corresponds to the JSON property importMode

Returns:

  • (Boolean) 


4812
4813
4814
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4812

def import_mode
  @import_mode
end

#last_active_time ⇒ String

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

Returns:

  • (String) 


4818
4819
4820
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4818

def last_active_time
  @last_active_time
end

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

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

Returns:



4823
4824
4825
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4823

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) 


4833
4834
4835
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4833

def name
  @name
end

#permission_settings ⇒ Google::Apis::ChatV1::PermissionSettings

Permission settings for a named space. To set permission settings when creating a space, specify the PredefinedPermissionSettings field in your request. Corresponds to the JSON property permissionSettings

Returns:



4840
4841
4842
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4840

def permission_settings
  @permission_settings
end

#predefined_permission_settings ⇒ String

Optional. Input only. Space permission settings. Input for creating a space, a collaboration space is created if this field is not set. After you create the space, settings are populated in the PermissionSettings field. Corresponds to the JSON property predefinedPermissionSettings

Returns:

  • (String) 


4847
4848
4849
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4847

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


4852
4853
4854
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4852

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:



4858
4859
4860
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4858

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) 


4863
4864
4865
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4863

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) 


4868
4869
4870
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4868

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) 


4874
4875
4876
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4874

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) 


4879
4880
4881
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4879

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) 


4885
4886
4887
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4885

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) 


4891
4892
4893
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4891

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4898

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