Class: Google::Apis::ChatV1::SetUpSpaceRequest

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

Request to create a space and add specified users to it.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SetUpSpaceRequest

Returns a new instance of SetUpSpaceRequest.



4439
4440
4441
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4439

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

Instance Attribute Details

#memberships ⇒ Array<Google::Apis::ChatV1::Membership>

Optional. The Google Chat users to invite to join the space. Omit the calling user, as they are added automatically. The set currently allows up to 20 memberships (in addition to the caller). For human membership, the Membership. member field must contain a user with name populated (format: users/ user) and `type` set to `User.Type.HUMAN`. You can only add human users when setting up a space (adding Chat apps is only supported for direct message setup with the calling app). You can also add members using the user's email as an alias for `user`. For example, the `user.name` can be `users/example@ gmail.com`. To invite Gmail users or users from external Google Workspace domains, user's email must be used foruser`. Optional when settingSpace. spaceTypetoSPACE. Required when settingSpace.spaceTypetoGROUP_CHAT, along with at least two memberships. Required when settingSpace.spaceType toDIRECT_MESSAGEwith a human user, along with exactly one membership. Must be empty when creating a 1:1 conversation between a human and the calling Chat app (when settingSpace.spaceTypetoDIRECT_MESSAGEandSpace. singleUserBotDmtotrue). Corresponds to the JSON propertymemberships`

Returns:



4423
4424
4425
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4423

def memberships
  @memberships
end

#request_id ⇒ String

Optional. A unique identifier for this request. A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error. Corresponds to the JSON property requestId

Returns:

  • (String) 


4431
4432
4433
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4431

def request_id
  @request_id
end

#space ⇒ Google::Apis::ChatV1::Space

A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. Corresponds to the JSON property space

Returns:



4437
4438
4439
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4437

def space
  @space
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4444
4445
4446
4447
4448
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4444

def update!(**args)
  @memberships = args[:memberships] if args.key?(:memberships)
  @request_id = args[:request_id] if args.key?(:request_id)
  @space = args[:space] if args.key?(:space)
end