Class: Google::Apis::ChatV1::HangoutsChatService
- Inherits:
-
Google::Apis::Core::BaseService
- Object
- Google::Apis::Core::BaseService
- Google::Apis::ChatV1::HangoutsChatService
- Defined in:
- lib/google/apis/chat_v1/service.rb
Overview
Google Chat API
Enables apps to fetch information and perform actions in Google Chat. Authentication is a prerequisite for using the Google Chat REST API.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Instance Method Summary collapse
-
#create_space_message(parent, message_object = nil, message_id: nil, message_reply_option: nil, request_id: nil, thread_key: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChatV1::Message
Creates a message.
-
#delete_space_message(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChatV1::Empty
Deletes a message.
-
#download_medium(resource_name, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChatV1::Media
Downloads media.
-
#get_space(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChatV1::Space
Returns a space.
-
#get_space_member(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChatV1::Membership
Developer Preview: Returns a membership.
-
#get_space_message(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChatV1::Message
Returns a message.
-
#get_space_message_attachment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChatV1::Attachment
Gets the metadata of a message attachment.
-
#initialize ⇒ HangoutsChatService
constructor
A new instance of HangoutsChatService.
-
#list_space_members(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChatV1::ListMembershipsResponse
Developer Preview: Lists memberships in a space.
-
#list_spaces(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChatV1::ListSpacesResponse
Lists spaces the caller is a member of.
-
#patch_space_message(name, message_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChatV1::Message
Updates a message.
-
#update_space_message(name, message_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChatV1::Message
Updates a message.
Constructor Details
#initialize ⇒ HangoutsChatService
Returns a new instance of HangoutsChatService.
46 47 48 49 50 51 |
# File 'lib/google/apis/chat_v1/service.rb', line 46 def initialize super('https://chat.googleapis.com/', '', client_name: 'google-apis-chat_v1', client_version: Google::Apis::ChatV1::GEM_VERSION) @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
39 40 41 |
# File 'lib/google/apis/chat_v1/service.rb', line 39 def key @key end |
#quota_user ⇒ String
Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
44 45 46 |
# File 'lib/google/apis/chat_v1/service.rb', line 44 def quota_user @quota_user end |
Instance Method Details
#create_space_message(parent, message_object = nil, message_id: nil, message_reply_option: nil, request_id: nil, thread_key: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChatV1::Message
Creates a message. For example usage, see Create a message.
Requires authentication.
Fully supports service account authentication. Supports user authentication as part of the Google
Workspace Developer Preview Program, which grants early access to certain features. User authentication requires the chat.
messages or chat.messages.create authorization scope. Because Chat provides
authentication for webhooks as part of the URL that's generated when a webhook is registered,
webhooks can create messages without a service account or user authentication.
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'lib/google/apis/chat_v1/service.rb', line 322 def (parent, = nil, message_id: nil, message_reply_option: nil, request_id: nil, thread_key: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/messages', ) command.request_representation = Google::Apis::ChatV1::Message::Representation command.request_object = command.response_representation = Google::Apis::ChatV1::Message::Representation command.response_class = Google::Apis::ChatV1::Message command.params['parent'] = parent unless parent.nil? command.query['messageId'] = unless .nil? command.query['messageReplyOption'] = unless .nil? command.query['requestId'] = request_id unless request_id.nil? command.query['threadKey'] = thread_key unless thread_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_space_message(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChatV1::Empty
Deletes a message. For example usage, see Delete a message.
Requires authentication.
Fully supports service account authentication. Supports user authentication as part of the Google
Workspace Developer Preview Program, which grants early access to certain features. User authentication requires the chat.
messages authorization scope.
368 369 370 371 372 373 374 375 376 |
# File 'lib/google/apis/chat_v1/service.rb', line 368 def (name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) command.response_representation = Google::Apis::ChatV1::Empty::Representation command.response_class = Google::Apis::ChatV1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#download_medium(resource_name, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChatV1::Media
Downloads media. Download is supported on the URI /v1/media/+name?alt=media
.
76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/google/apis/chat_v1/service.rb', line 76 def download_medium(resource_name, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block) if download_dest.nil? command = make_simple_command(:get, 'v1/media/{+resourceName}', ) else command = make_download_command(:get, 'v1/media/{+resourceName}', ) command.download_dest = download_dest end command.response_representation = Google::Apis::ChatV1::Media::Representation command.response_class = Google::Apis::ChatV1::Media command.params['resourceName'] = resource_name unless resource_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_space(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChatV1::Space
Returns a space. Requires authentication. Fully supports service account authentication. Supports user
authentication as
part of the Google Workspace Developer Preview Program, which grants early access to certain features.
User authentication
requires the chat.spaces or chat.spaces.readonly authorization scope.
119 120 121 122 123 124 125 126 127 |
# File 'lib/google/apis/chat_v1/service.rb', line 119 def get_space(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::ChatV1::Space::Representation command.response_class = Google::Apis::ChatV1::Space command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_space_member(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChatV1::Membership
Developer Preview: Returns
a membership. Requires authentication. Fully supports service account authentication. Supports user
authentication as
part of the Google Workspace Developer Preview Program, which grants early access to certain features.
User authentication
requires the chat.memberships or chat.memberships.readonly authorization
scope.
208 209 210 211 212 213 214 215 216 |
# File 'lib/google/apis/chat_v1/service.rb', line 208 def get_space_member(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::ChatV1::Membership::Representation command.response_class = Google::Apis::ChatV1::Membership command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_space_message(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChatV1::Message
Returns a message. For example usage, see Read a message. Requires
authentication. Fully
supports Service account authentication. Supports user authentication as part of the Google
Workspace Developer Preview Program, which grants early access to certain features. User authentication requires the chat.
messages or chat.messages.readonly authorization scope. Note: Might return
a message from a blocked member or space.
413 414 415 416 417 418 419 420 421 |
# File 'lib/google/apis/chat_v1/service.rb', line 413 def (name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::ChatV1::Message::Representation command.response_class = Google::Apis::ChatV1::Message command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_space_message_attachment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChatV1::Attachment
Gets the metadata of a message attachment. The attachment data is fetched using the media API. Requires service account authentication.
554 555 556 557 558 559 560 561 562 |
# File 'lib/google/apis/chat_v1/service.rb', line 554 def (name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::ChatV1::Attachment::Representation command.response_class = Google::Apis::ChatV1::Attachment command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_space_members(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChatV1::ListMembershipsResponse
Developer Preview: Lists
memberships in a space. Requires authentication. Fully supports service account authentication. Supports
user authentication
as part of the Google Workspace Developer Preview Program, which grants early access to certain
features. User authentication requires the chat.memberships or chat.memberships.readonly
authorization scope.
258 259 260 261 262 263 264 265 266 267 268 |
# File 'lib/google/apis/chat_v1/service.rb', line 258 def list_space_members(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/members', ) command.response_representation = Google::Apis::ChatV1::ListMembershipsResponse::Representation command.response_class = Google::Apis::ChatV1::ListMembershipsResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_spaces(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChatV1::ListSpacesResponse
Lists spaces the caller is a member of. Requires authentication. Fully supports service account
authentication. Supports user authentication as part of the Google Workspace Developer Preview
Program, which grants early
access to certain features. User authentication requires the chat.spaces or chat.spaces.
readonly authorization scope. Lists spaces visible to the caller or
authenticated user. Group chats and DMs aren't listed until the first message
is sent.
167 168 169 170 171 172 173 174 175 176 |
# File 'lib/google/apis/chat_v1/service.rb', line 167 def list_spaces(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/spaces', ) command.response_representation = Google::Apis::ChatV1::ListSpacesResponse::Representation command.response_class = Google::Apis::ChatV1::ListSpacesResponse command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_space_message(name, message_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChatV1::Message
Updates a message. For example usage, see Update a message.
Requires authentication.
Fully supports service account authentication. Supports user authentication as part of the Google
Workspace Developer Preview Program, which grants early access to certain features. User authentication requires the chat.
messages authorization scope.
463 464 465 466 467 468 469 470 471 472 473 474 475 |
# File 'lib/google/apis/chat_v1/service.rb', line 463 def (name, = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', ) command.request_representation = Google::Apis::ChatV1::Message::Representation command.request_object = command.response_representation = Google::Apis::ChatV1::Message::Representation command.response_class = Google::Apis::ChatV1::Message command.params['name'] = name unless name.nil? command.query['allowMissing'] = allow_missing unless allow_missing.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#update_space_message(name, message_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChatV1::Message
Updates a message. For example usage, see Update a message.
Requires authentication.
Fully supports service account authentication. Supports user authentication as part of the Google
Workspace Developer Preview Program, which grants early access to certain features. User authentication requires the chat.
messages authorization scope.
517 518 519 520 521 522 523 524 525 526 527 528 529 |
# File 'lib/google/apis/chat_v1/service.rb', line 517 def (name, = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1/{+name}', ) command.request_representation = Google::Apis::ChatV1::Message::Representation command.request_object = command.response_representation = Google::Apis::ChatV1::Message::Representation command.response_class = Google::Apis::ChatV1::Message command.params['name'] = name unless name.nil? command.query['allowMissing'] = allow_missing unless allow_missing.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |