@google-apps/chat 0.2.0 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/README.md +4 -0
- package/build/protos/google/apps/card/v1/card.proto +242 -160
- package/build/protos/google/chat/v1/action_status.proto +1 -1
- package/build/protos/google/chat/v1/annotation.proto +2 -2
- package/build/protos/google/chat/v1/attachment.proto +9 -0
- package/build/protos/google/chat/v1/chat_service.proto +135 -81
- package/build/protos/google/chat/v1/contextual_addon.proto +1 -1
- package/build/protos/google/chat/v1/membership.proto +33 -11
- package/build/protos/google/chat/v1/message.proto +71 -113
- package/build/protos/google/chat/v1/reaction.proto +4 -2
- package/build/protos/google/chat/v1/slash_command.proto +3 -2
- package/build/protos/google/chat/v1/space.proto +28 -17
- package/build/protos/google/chat/v1/space_read_state.proto +112 -0
- package/build/protos/google/chat/v1/space_setup.proto +1 -0
- package/build/protos/google/chat/v1/thread_read_state.proto +74 -0
- package/build/protos/google/chat/v1/user.proto +3 -2
- package/build/protos/google/chat/v1/widgets.proto +4 -4
- package/build/protos/protos.d.ts +887 -76
- package/build/protos/protos.js +1976 -192
- package/build/protos/protos.json +210 -12
- package/build/src/v1/chat_service_client.d.ts +368 -134
- package/build/src/v1/chat_service_client.js +196 -24
- package/build/src/v1/chat_service_client.js.map +1 -1
- package/build/src/v1/chat_service_client_config.json +20 -0
- package/package.json +1 -1
|
@@ -117,12 +117,12 @@ export declare class ChatServiceClient {
|
|
|
117
117
|
getProjectId(): Promise<string>;
|
|
118
118
|
getProjectId(callback: Callback<string, undefined, undefined>): void;
|
|
119
119
|
/**
|
|
120
|
-
* Creates a message in a Google Chat space. For an example, see [
|
|
121
|
-
* message](https://developers.google.com/chat/
|
|
120
|
+
* Creates a message in a Google Chat space. For an example, see [Send a
|
|
121
|
+
* message](https://developers.google.com/workspace/chat/create-messages).
|
|
122
122
|
*
|
|
123
123
|
* Calling this method requires
|
|
124
|
-
* [authentication](https://developers.google.com/chat/
|
|
125
|
-
* supports the following authentication types:
|
|
124
|
+
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize)
|
|
125
|
+
* and supports the following authentication types:
|
|
126
126
|
*
|
|
127
127
|
* - For text messages, user authentication or app authentication are
|
|
128
128
|
* supported.
|
|
@@ -144,7 +144,7 @@ export declare class ChatServiceClient {
|
|
|
144
144
|
* a message and specify a `threadKey` or the
|
|
145
145
|
* {@link protos.google.chat.v1.Thread.name|thread.name}. For example usage, see [Start or
|
|
146
146
|
* reply to a message
|
|
147
|
-
* thread](https://developers.google.com/chat/
|
|
147
|
+
* thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread).
|
|
148
148
|
* @param {string} [request.requestId]
|
|
149
149
|
* Optional. A unique request ID for this message. Specifying an existing
|
|
150
150
|
* request ID returns the message created with that ID instead of creating a
|
|
@@ -167,7 +167,7 @@ export declare class ChatServiceClient {
|
|
|
167
167
|
* different messages.
|
|
168
168
|
*
|
|
169
169
|
* For details, see [Name a
|
|
170
|
-
* message](https://developers.google.com/chat/
|
|
170
|
+
* message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
|
|
171
171
|
* @param {object} [options]
|
|
172
172
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
173
173
|
* @returns {Promise} - The promise which resolves to an array.
|
|
@@ -186,16 +186,16 @@ export declare class ChatServiceClient {
|
|
|
186
186
|
createMessage(request: protos.google.chat.v1.ICreateMessageRequest, callback: Callback<protos.google.chat.v1.IMessage, protos.google.chat.v1.ICreateMessageRequest | null | undefined, {} | null | undefined>): void;
|
|
187
187
|
/**
|
|
188
188
|
* Returns details about a membership. For an example, see
|
|
189
|
-
* [Get a
|
|
190
|
-
* membership](https://developers.google.com/chat/
|
|
189
|
+
* [Get details about a user's or Google Chat app's
|
|
190
|
+
* membership](https://developers.google.com/workspace/chat/get-members).
|
|
191
191
|
*
|
|
192
192
|
* Requires
|
|
193
|
-
* [authentication](https://developers.google.com/chat/
|
|
193
|
+
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
|
|
194
194
|
* Supports
|
|
195
195
|
* [app
|
|
196
|
-
* authentication](https://developers.google.com/chat/
|
|
196
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
197
197
|
* and [user
|
|
198
|
-
* authentication](https://developers.google.com/chat/
|
|
198
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
199
199
|
*
|
|
200
200
|
* @param {Object} request
|
|
201
201
|
* The request object that will be sent.
|
|
@@ -208,8 +208,8 @@ export declare class ChatServiceClient {
|
|
|
208
208
|
* Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`
|
|
209
209
|
*
|
|
210
210
|
* When [authenticated as a
|
|
211
|
-
* user](https://developers.google.com/chat/
|
|
212
|
-
* use the user's email as an alias for `{member}`. For example,
|
|
211
|
+
* user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
|
|
212
|
+
* you can use the user's email as an alias for `{member}`. For example,
|
|
213
213
|
* `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the
|
|
214
214
|
* email of the Google Chat user.
|
|
215
215
|
* @param {object} [options]
|
|
@@ -230,16 +230,16 @@ export declare class ChatServiceClient {
|
|
|
230
230
|
getMembership(request: protos.google.chat.v1.IGetMembershipRequest, callback: Callback<protos.google.chat.v1.IMembership, protos.google.chat.v1.IGetMembershipRequest | null | undefined, {} | null | undefined>): void;
|
|
231
231
|
/**
|
|
232
232
|
* Returns details about a message.
|
|
233
|
-
* For an example, see [
|
|
234
|
-
* message](https://developers.google.com/chat/
|
|
233
|
+
* For an example, see [Get details about a
|
|
234
|
+
* message](https://developers.google.com/workspace/chat/get-messages).
|
|
235
235
|
*
|
|
236
236
|
* Requires
|
|
237
|
-
* [authentication](https://developers.google.com/chat/
|
|
237
|
+
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
|
|
238
238
|
* Supports
|
|
239
239
|
* [app
|
|
240
|
-
* authentication](https://developers.google.com/chat/
|
|
240
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
241
241
|
* and [user
|
|
242
|
-
* authentication](https://developers.google.com/chat/
|
|
242
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
243
243
|
*
|
|
244
244
|
* Note: Might return a message from a blocked member or space.
|
|
245
245
|
*
|
|
@@ -253,7 +253,7 @@ export declare class ChatServiceClient {
|
|
|
253
253
|
* If you've set a custom ID for your message, you can use the value from the
|
|
254
254
|
* `clientAssignedMessageId` field for `{message}`. For details, see [Name a
|
|
255
255
|
* message]
|
|
256
|
-
* (https://developers.google.com/chat/
|
|
256
|
+
* (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
|
|
257
257
|
* @param {object} [options]
|
|
258
258
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
259
259
|
* @returns {Promise} - The promise which resolves to an array.
|
|
@@ -276,15 +276,15 @@ export declare class ChatServiceClient {
|
|
|
276
276
|
* method uses a `patch` request while the `update` method uses a `put`
|
|
277
277
|
* request. We recommend using the `patch` method. For an example, see
|
|
278
278
|
* [Update a
|
|
279
|
-
* message](https://developers.google.com/chat/
|
|
279
|
+
* message](https://developers.google.com/workspace/chat/update-messages).
|
|
280
280
|
*
|
|
281
281
|
* Requires
|
|
282
|
-
* [authentication](https://developers.google.com/chat/
|
|
282
|
+
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
|
|
283
283
|
* Supports
|
|
284
284
|
* [app
|
|
285
|
-
* authentication](https://developers.google.com/chat/
|
|
285
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
286
286
|
* and [user
|
|
287
|
-
* authentication](https://developers.google.com/chat/
|
|
287
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
288
288
|
* When using app authentication, requests can only update messages
|
|
289
289
|
* created by the calling Chat app.
|
|
290
290
|
*
|
|
@@ -313,7 +313,7 @@ export declare class ChatServiceClient {
|
|
|
313
313
|
* @param {boolean} [request.allowMissing]
|
|
314
314
|
* Optional. If `true` and the message isn't found, a new message is created
|
|
315
315
|
* and `updateMask` is ignored. The specified message ID must be
|
|
316
|
-
* [client-assigned](https://developers.google.com/chat/
|
|
316
|
+
* [client-assigned](https://developers.google.com/workspace/chat/create-messages#name_a_created_message)
|
|
317
317
|
* or the request fails.
|
|
318
318
|
* @param {object} [options]
|
|
319
319
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
@@ -334,15 +334,15 @@ export declare class ChatServiceClient {
|
|
|
334
334
|
/**
|
|
335
335
|
* Deletes a message.
|
|
336
336
|
* For an example, see [Delete a
|
|
337
|
-
* message](https://developers.google.com/chat/
|
|
337
|
+
* message](https://developers.google.com/workspace/chat/delete-messages).
|
|
338
338
|
*
|
|
339
339
|
* Requires
|
|
340
|
-
* [authentication](https://developers.google.com/chat/
|
|
340
|
+
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
|
|
341
341
|
* Supports
|
|
342
342
|
* [app
|
|
343
|
-
* authentication](https://developers.google.com/chat/
|
|
343
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
344
344
|
* and [user
|
|
345
|
-
* authentication](https://developers.google.com/chat/
|
|
345
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
346
346
|
* When using app authentication, requests can only delete messages
|
|
347
347
|
* created by the calling Chat app.
|
|
348
348
|
*
|
|
@@ -356,15 +356,15 @@ export declare class ChatServiceClient {
|
|
|
356
356
|
* If you've set a custom ID for your message, you can use the value from the
|
|
357
357
|
* `clientAssignedMessageId` field for `{message}`. For details, see [Name a
|
|
358
358
|
* message]
|
|
359
|
-
* (https://developers.google.com/chat/
|
|
359
|
+
* (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
|
|
360
360
|
* @param {boolean} request.force
|
|
361
361
|
* When `true`, deleting a message also deletes its threaded replies. When
|
|
362
362
|
* `false`, if a message has threaded replies, deletion fails.
|
|
363
363
|
*
|
|
364
364
|
* Only applies when [authenticating as a
|
|
365
|
-
* user](https://developers.google.com/chat/
|
|
366
|
-
* effect when [authenticating as a Chat app]
|
|
367
|
-
* (https://developers.google.com/chat/
|
|
365
|
+
* user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
366
|
+
* Has no effect when [authenticating as a Chat app]
|
|
367
|
+
* (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
|
|
368
368
|
* @param {object} [options]
|
|
369
369
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
370
370
|
* @returns {Promise} - The promise which resolves to an array.
|
|
@@ -384,12 +384,12 @@ export declare class ChatServiceClient {
|
|
|
384
384
|
/**
|
|
385
385
|
* Gets the metadata of a message attachment. The attachment data is fetched
|
|
386
386
|
* using the [media
|
|
387
|
-
* API](https://developers.google.com/chat/api/reference/rest/v1/media/download).
|
|
387
|
+
* API](https://developers.google.com/workspace/chat/api/reference/rest/v1/media/download).
|
|
388
388
|
* For an example, see
|
|
389
|
-
* [Get a message
|
|
390
|
-
* attachment](https://developers.google.com/chat/
|
|
389
|
+
* [Get metadata about a message
|
|
390
|
+
* attachment](https://developers.google.com/workspace/chat/get-media-attachments).
|
|
391
391
|
* Requires [app
|
|
392
|
-
* authentication](https://developers.google.com/chat/
|
|
392
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
|
|
393
393
|
*
|
|
394
394
|
* @param {Object} request
|
|
395
395
|
* The request object that will be sent.
|
|
@@ -415,9 +415,9 @@ export declare class ChatServiceClient {
|
|
|
415
415
|
/**
|
|
416
416
|
* Uploads an attachment. For an example, see
|
|
417
417
|
* [Upload media as a file
|
|
418
|
-
* attachment](https://developers.google.com/chat/
|
|
418
|
+
* attachment](https://developers.google.com/workspace/chat/upload-media-attachments).
|
|
419
419
|
* Requires user
|
|
420
|
-
* [authentication](https://developers.google.com/chat/
|
|
420
|
+
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
421
421
|
*
|
|
422
422
|
* You can upload attachments up to 200 MB. Certain file types aren't
|
|
423
423
|
* supported. For details, see [File types blocked by Google
|
|
@@ -448,15 +448,16 @@ export declare class ChatServiceClient {
|
|
|
448
448
|
uploadAttachment(request: protos.google.chat.v1.IUploadAttachmentRequest, callback: Callback<protos.google.chat.v1.IUploadAttachmentResponse, protos.google.chat.v1.IUploadAttachmentRequest | null | undefined, {} | null | undefined>): void;
|
|
449
449
|
/**
|
|
450
450
|
* Returns details about a space. For an example, see
|
|
451
|
-
* [Get a
|
|
451
|
+
* [Get details about a
|
|
452
|
+
* space](https://developers.google.com/workspace/chat/get-spaces).
|
|
452
453
|
*
|
|
453
454
|
* Requires
|
|
454
|
-
* [authentication](https://developers.google.com/chat/
|
|
455
|
+
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
|
|
455
456
|
* Supports
|
|
456
457
|
* [app
|
|
457
|
-
* authentication](https://developers.google.com/chat/
|
|
458
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
458
459
|
* and [user
|
|
459
|
-
* authentication](https://developers.google.com/chat/
|
|
460
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
460
461
|
*
|
|
461
462
|
* @param {Object} request
|
|
462
463
|
* The request object that will be sent.
|
|
@@ -483,14 +484,14 @@ export declare class ChatServiceClient {
|
|
|
483
484
|
/**
|
|
484
485
|
* Creates a named space. Spaces grouped by topics aren't supported. For an
|
|
485
486
|
* example, see [Create a
|
|
486
|
-
* space](https://developers.google.com/chat/
|
|
487
|
+
* space](https://developers.google.com/workspace/chat/create-spaces).
|
|
487
488
|
*
|
|
488
489
|
* If you receive the error message `ALREADY_EXISTS` when creating
|
|
489
490
|
* a space, try a different `displayName`. An existing space within
|
|
490
491
|
* the Google Workspace organization might already use this display name.
|
|
491
492
|
*
|
|
492
493
|
* Requires [user
|
|
493
|
-
* authentication](https://developers.google.com/chat/
|
|
494
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
494
495
|
*
|
|
495
496
|
* @param {Object} request
|
|
496
497
|
* The request object that will be sent.
|
|
@@ -531,8 +532,8 @@ export declare class ChatServiceClient {
|
|
|
531
532
|
* Creates a space and adds specified users to it. The calling user is
|
|
532
533
|
* automatically added to the space, and shouldn't be specified as a
|
|
533
534
|
* membership in the request. For an example, see
|
|
534
|
-
* [Set up a
|
|
535
|
-
*
|
|
535
|
+
* [Set up a space with initial
|
|
536
|
+
* members](https://developers.google.com/workspace/chat/set-up-spaces).
|
|
536
537
|
*
|
|
537
538
|
* To specify the human members to add, add memberships with the appropriate
|
|
538
539
|
* `member.name` in the `SetUpSpaceRequest`. To add a human user, use
|
|
@@ -556,8 +557,8 @@ export declare class ChatServiceClient {
|
|
|
556
557
|
* can only use this method to set up a DM with the calling app. To add the
|
|
557
558
|
* calling app as a member of a space or an existing DM between two human
|
|
558
559
|
* users, see
|
|
559
|
-
* [
|
|
560
|
-
*
|
|
560
|
+
* [Invite or add a user or app to a
|
|
561
|
+
* space](https://developers.google.com/workspace/chat/create-members).
|
|
561
562
|
*
|
|
562
563
|
* If a DM already exists between two users, even when one user blocks the
|
|
563
564
|
* other at the time a request is made, then the existing DM is returned.
|
|
@@ -568,7 +569,7 @@ export declare class ChatServiceClient {
|
|
|
568
569
|
* might already use this display name.
|
|
569
570
|
*
|
|
570
571
|
* Requires [user
|
|
571
|
-
* authentication](https://developers.google.com/chat/
|
|
572
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
572
573
|
*
|
|
573
574
|
* @param {Object} request
|
|
574
575
|
* The request object that will be sent.
|
|
@@ -648,14 +649,14 @@ export declare class ChatServiceClient {
|
|
|
648
649
|
/**
|
|
649
650
|
* Updates a space. For an example, see
|
|
650
651
|
* [Update a
|
|
651
|
-
* space](https://developers.google.com/chat/
|
|
652
|
+
* space](https://developers.google.com/workspace/chat/update-spaces).
|
|
652
653
|
*
|
|
653
654
|
* If you're updating the `displayName` field and receive the error message
|
|
654
655
|
* `ALREADY_EXISTS`, try a different display name.. An existing space within
|
|
655
656
|
* the Google Workspace organization might already use this display name.
|
|
656
657
|
*
|
|
657
658
|
* Requires [user
|
|
658
|
-
* authentication](https://developers.google.com/chat/
|
|
659
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
659
660
|
*
|
|
660
661
|
* @param {Object} request
|
|
661
662
|
* The request object that will be sent.
|
|
@@ -678,12 +679,13 @@ export declare class ChatServiceClient {
|
|
|
678
679
|
* Google Workspace organization might already use this display name.)
|
|
679
680
|
*
|
|
680
681
|
* - `space_type` (Only supports changing a `GROUP_CHAT` space type to
|
|
681
|
-
* `SPACE`. Include `display_name` together
|
|
682
|
-
* mask and ensure that the specified space
|
|
683
|
-
* the `SPACE` space type. Including the
|
|
684
|
-
* type in the specified space when updating
|
|
685
|
-
* the existing space already has the `SPACE`
|
|
686
|
-
* space type in other ways results in an invalid
|
|
682
|
+
* `SPACE`. Include `display_name` together
|
|
683
|
+
* with `space_type` in the update mask and ensure that the specified space
|
|
684
|
+
* has a non-empty display name and the `SPACE` space type. Including the
|
|
685
|
+
* `space_type` mask and the `SPACE` type in the specified space when updating
|
|
686
|
+
* the display name is optional if the existing space already has the `SPACE`
|
|
687
|
+
* type. Trying to update the space type in other ways results in an invalid
|
|
688
|
+
* argument error).
|
|
687
689
|
*
|
|
688
690
|
* - `space_details`
|
|
689
691
|
*
|
|
@@ -692,6 +694,7 @@ export declare class ChatServiceClient {
|
|
|
692
694
|
* allows users to change their history
|
|
693
695
|
* setting](https://support.google.com/a/answer/7664184).
|
|
694
696
|
* Warning: mutually exclusive with all other field paths.)
|
|
697
|
+
*
|
|
695
698
|
* - Developer Preview: `access_settings.audience` (Supports changing the
|
|
696
699
|
* [access setting](https://support.google.com/chat/answer/11971020) of a
|
|
697
700
|
* space. If no audience is specified in the access setting, the space's
|
|
@@ -718,9 +721,9 @@ export declare class ChatServiceClient {
|
|
|
718
721
|
* that the space's child resources—like messages posted in the space and
|
|
719
722
|
* memberships in the space—are also deleted. For an example, see
|
|
720
723
|
* [Delete a
|
|
721
|
-
* space](https://developers.google.com/chat/
|
|
724
|
+
* space](https://developers.google.com/workspace/chat/delete-spaces).
|
|
722
725
|
* Requires [user
|
|
723
|
-
* authentication](https://developers.google.com/chat/
|
|
726
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
|
724
727
|
* from a user who has permission to delete the space.
|
|
725
728
|
*
|
|
726
729
|
* @param {Object} request
|
|
@@ -747,11 +750,11 @@ export declare class ChatServiceClient {
|
|
|
747
750
|
deleteSpace(request: protos.google.chat.v1.IDeleteSpaceRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.chat.v1.IDeleteSpaceRequest | null | undefined, {} | null | undefined>): void;
|
|
748
751
|
/**
|
|
749
752
|
* Completes the
|
|
750
|
-
* [import process](https://developers.google.com/chat/
|
|
753
|
+
* [import process](https://developers.google.com/workspace/chat/import-data)
|
|
751
754
|
* for the specified space and makes it visible to users.
|
|
752
755
|
* Requires app authentication and domain-wide delegation. For more
|
|
753
756
|
* information, see [Authorize Google Chat apps to import
|
|
754
|
-
* data](https://developers.google.com/chat/
|
|
757
|
+
* data](https://developers.google.com/workspace/chat/authorize-import).
|
|
755
758
|
*
|
|
756
759
|
* @param {Object} request
|
|
757
760
|
* The request object that will be sent.
|
|
@@ -782,19 +785,19 @@ export declare class ChatServiceClient {
|
|
|
782
785
|
* [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message).
|
|
783
786
|
*
|
|
784
787
|
* With [user
|
|
785
|
-
* authentication](https://developers.google.com/chat/
|
|
788
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
|
|
786
789
|
* returns the direct message space between the specified user and the
|
|
787
790
|
* authenticated user.
|
|
788
791
|
*
|
|
789
792
|
* With [app
|
|
790
|
-
* authentication](https://developers.google.com/chat/
|
|
793
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app),
|
|
791
794
|
* returns the direct message space between the specified user and the calling
|
|
792
795
|
* Chat app.
|
|
793
796
|
*
|
|
794
797
|
* Requires [user
|
|
795
|
-
* authentication](https://developers.google.com/chat/
|
|
798
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
|
796
799
|
* or [app
|
|
797
|
-
* authentication](https://developers.google.com/chat/
|
|
800
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
|
|
798
801
|
*
|
|
799
802
|
* @param {Object} request
|
|
800
803
|
* The request object that will be sent.
|
|
@@ -808,8 +811,8 @@ export declare class ChatServiceClient {
|
|
|
808
811
|
* in the Directory API. For example, if the People API profile ID is
|
|
809
812
|
* `123456789`, you can find a direct message with that person by using
|
|
810
813
|
* `users/123456789` as the `name`. When [authenticated as a
|
|
811
|
-
* user](https://developers.google.com/chat/
|
|
812
|
-
* use the email as an alias for `{user}`. For example,
|
|
814
|
+
* user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
|
|
815
|
+
* you can use the email as an alias for `{user}`. For example,
|
|
813
816
|
* `users/example@gmail.com` where `example@gmail.com` is the email of the
|
|
814
817
|
* Google Chat user.
|
|
815
818
|
* @param {object} [options]
|
|
@@ -831,13 +834,13 @@ export declare class ChatServiceClient {
|
|
|
831
834
|
/**
|
|
832
835
|
* Creates a human membership or app membership for the calling app. Creating
|
|
833
836
|
* memberships for other apps isn't supported. For an example, see
|
|
834
|
-
* [
|
|
835
|
-
*
|
|
837
|
+
* [Invite or add a user or a Google Chat app to a
|
|
838
|
+
* space](https://developers.google.com/workspace/chat/create-members).
|
|
836
839
|
* When creating a membership, if the specified member has their auto-accept
|
|
837
840
|
* policy turned off, then they're invited, and must accept the space
|
|
838
841
|
* invitation before joining. Otherwise, creating a membership adds the member
|
|
839
842
|
* directly to the specified space. Requires [user
|
|
840
|
-
* authentication](https://developers.google.com/chat/
|
|
843
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
841
844
|
*
|
|
842
845
|
* To specify the member to add, set the `membership.member.name` in the
|
|
843
846
|
* `CreateMembershipRequest`:
|
|
@@ -894,13 +897,45 @@ export declare class ChatServiceClient {
|
|
|
894
897
|
]>;
|
|
895
898
|
createMembership(request: protos.google.chat.v1.ICreateMembershipRequest, options: CallOptions, callback: Callback<protos.google.chat.v1.IMembership, protos.google.chat.v1.ICreateMembershipRequest | null | undefined, {} | null | undefined>): void;
|
|
896
899
|
createMembership(request: protos.google.chat.v1.ICreateMembershipRequest, callback: Callback<protos.google.chat.v1.IMembership, protos.google.chat.v1.ICreateMembershipRequest | null | undefined, {} | null | undefined>): void;
|
|
900
|
+
/**
|
|
901
|
+
* Updates a membership. Requires [user
|
|
902
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/users).
|
|
903
|
+
*
|
|
904
|
+
* @param {Object} request
|
|
905
|
+
* The request object that will be sent.
|
|
906
|
+
* @param {google.chat.v1.Membership} request.membership
|
|
907
|
+
* Required. The membership to update. Only fields specified by `update_mask`
|
|
908
|
+
* are updated.
|
|
909
|
+
* @param {google.protobuf.FieldMask} request.updateMask
|
|
910
|
+
* Required. The field paths to update. Separate multiple values with commas
|
|
911
|
+
* or use `*` to update all field paths.
|
|
912
|
+
*
|
|
913
|
+
* Currently supported field paths:
|
|
914
|
+
*
|
|
915
|
+
* - `role`
|
|
916
|
+
* @param {object} [options]
|
|
917
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
918
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
919
|
+
* The first element of the array is an object representing {@link protos.google.chat.v1.Membership|Membership}.
|
|
920
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
921
|
+
* for more details and examples.
|
|
922
|
+
* @example <caption>include:samples/generated/v1/chat_service.update_membership.js</caption>
|
|
923
|
+
* region_tag:chat_v1_generated_ChatService_UpdateMembership_async
|
|
924
|
+
*/
|
|
925
|
+
updateMembership(request?: protos.google.chat.v1.IUpdateMembershipRequest, options?: CallOptions): Promise<[
|
|
926
|
+
protos.google.chat.v1.IMembership,
|
|
927
|
+
protos.google.chat.v1.IUpdateMembershipRequest | undefined,
|
|
928
|
+
{} | undefined
|
|
929
|
+
]>;
|
|
930
|
+
updateMembership(request: protos.google.chat.v1.IUpdateMembershipRequest, options: CallOptions, callback: Callback<protos.google.chat.v1.IMembership, protos.google.chat.v1.IUpdateMembershipRequest | null | undefined, {} | null | undefined>): void;
|
|
931
|
+
updateMembership(request: protos.google.chat.v1.IUpdateMembershipRequest, callback: Callback<protos.google.chat.v1.IMembership, protos.google.chat.v1.IUpdateMembershipRequest | null | undefined, {} | null | undefined>): void;
|
|
897
932
|
/**
|
|
898
933
|
* Deletes a membership. For an example, see
|
|
899
|
-
* [
|
|
900
|
-
*
|
|
934
|
+
* [Remove a user or a Google Chat app from a
|
|
935
|
+
* space](https://developers.google.com/workspace/chat/delete-members).
|
|
901
936
|
*
|
|
902
937
|
* Requires [user
|
|
903
|
-
* authentication](https://developers.google.com/chat/
|
|
938
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
904
939
|
*
|
|
905
940
|
* @param {Object} request
|
|
906
941
|
* The request object that will be sent.
|
|
@@ -936,12 +971,12 @@ export declare class ChatServiceClient {
|
|
|
936
971
|
deleteMembership(request: protos.google.chat.v1.IDeleteMembershipRequest, options: CallOptions, callback: Callback<protos.google.chat.v1.IMembership, protos.google.chat.v1.IDeleteMembershipRequest | null | undefined, {} | null | undefined>): void;
|
|
937
972
|
deleteMembership(request: protos.google.chat.v1.IDeleteMembershipRequest, callback: Callback<protos.google.chat.v1.IMembership, protos.google.chat.v1.IDeleteMembershipRequest | null | undefined, {} | null | undefined>): void;
|
|
938
973
|
/**
|
|
939
|
-
* Creates a reaction and adds it to a message.
|
|
940
|
-
*
|
|
941
|
-
* reaction
|
|
974
|
+
* Creates a reaction and adds it to a message. Only unicode emojis are
|
|
975
|
+
* supported. For an example, see
|
|
976
|
+
* [Add a reaction to a
|
|
977
|
+
* message](https://developers.google.com/workspace/chat/create-reactions).
|
|
942
978
|
* Requires [user
|
|
943
|
-
* authentication](https://developers.google.com/chat/
|
|
944
|
-
* Only unicode emoji are supported.
|
|
979
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
945
980
|
*
|
|
946
981
|
* @param {Object} request
|
|
947
982
|
* The request object that will be sent.
|
|
@@ -968,11 +1003,12 @@ export declare class ChatServiceClient {
|
|
|
968
1003
|
createReaction(request: protos.google.chat.v1.ICreateReactionRequest, options: CallOptions, callback: Callback<protos.google.chat.v1.IReaction, protos.google.chat.v1.ICreateReactionRequest | null | undefined, {} | null | undefined>): void;
|
|
969
1004
|
createReaction(request: protos.google.chat.v1.ICreateReactionRequest, callback: Callback<protos.google.chat.v1.IReaction, protos.google.chat.v1.ICreateReactionRequest | null | undefined, {} | null | undefined>): void;
|
|
970
1005
|
/**
|
|
971
|
-
* Deletes a reaction to a message.
|
|
1006
|
+
* Deletes a reaction to a message. Only unicode emojis are supported.
|
|
1007
|
+
* For an example, see
|
|
972
1008
|
* [Delete a
|
|
973
|
-
* reaction](https://developers.google.com/chat/
|
|
1009
|
+
* reaction](https://developers.google.com/workspace/chat/delete-reactions).
|
|
974
1010
|
* Requires [user
|
|
975
|
-
* authentication](https://developers.google.com/chat/
|
|
1011
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
976
1012
|
*
|
|
977
1013
|
* @param {Object} request
|
|
978
1014
|
* The request object that will be sent.
|
|
@@ -996,12 +1032,150 @@ export declare class ChatServiceClient {
|
|
|
996
1032
|
]>;
|
|
997
1033
|
deleteReaction(request: protos.google.chat.v1.IDeleteReactionRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.chat.v1.IDeleteReactionRequest | null | undefined, {} | null | undefined>): void;
|
|
998
1034
|
deleteReaction(request: protos.google.chat.v1.IDeleteReactionRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.chat.v1.IDeleteReactionRequest | null | undefined, {} | null | undefined>): void;
|
|
1035
|
+
/**
|
|
1036
|
+
* Returns details about a user's read state within a space, used to identify
|
|
1037
|
+
* read and unread messages.
|
|
1038
|
+
*
|
|
1039
|
+
* Requires [user
|
|
1040
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
1041
|
+
*
|
|
1042
|
+
* @param {Object} request
|
|
1043
|
+
* The request object that will be sent.
|
|
1044
|
+
* @param {string} request.name
|
|
1045
|
+
* Required. Resource name of the space read state to retrieve.
|
|
1046
|
+
*
|
|
1047
|
+
* Only supports getting read state for the calling user.
|
|
1048
|
+
*
|
|
1049
|
+
* To refer to the calling user, set one of the following:
|
|
1050
|
+
*
|
|
1051
|
+
* - The `me` alias. For example, `users/me/spaces/{space}/spaceReadState`.
|
|
1052
|
+
*
|
|
1053
|
+
* - Their Workspace email address. For example,
|
|
1054
|
+
* `users/user@example.com/spaces/{space}/spaceReadState`.
|
|
1055
|
+
*
|
|
1056
|
+
* - Their user id. For example,
|
|
1057
|
+
* `users/123456789/spaces/{space}/spaceReadState`.
|
|
1058
|
+
*
|
|
1059
|
+
* Format: users/{user}/spaces/{space}/spaceReadState
|
|
1060
|
+
* @param {object} [options]
|
|
1061
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1062
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
1063
|
+
* The first element of the array is an object representing {@link protos.google.chat.v1.SpaceReadState|SpaceReadState}.
|
|
1064
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
1065
|
+
* for more details and examples.
|
|
1066
|
+
* @example <caption>include:samples/generated/v1/chat_service.get_space_read_state.js</caption>
|
|
1067
|
+
* region_tag:chat_v1_generated_ChatService_GetSpaceReadState_async
|
|
1068
|
+
*/
|
|
1069
|
+
getSpaceReadState(request?: protos.google.chat.v1.IGetSpaceReadStateRequest, options?: CallOptions): Promise<[
|
|
1070
|
+
protos.google.chat.v1.ISpaceReadState,
|
|
1071
|
+
protos.google.chat.v1.IGetSpaceReadStateRequest | undefined,
|
|
1072
|
+
{} | undefined
|
|
1073
|
+
]>;
|
|
1074
|
+
getSpaceReadState(request: protos.google.chat.v1.IGetSpaceReadStateRequest, options: CallOptions, callback: Callback<protos.google.chat.v1.ISpaceReadState, protos.google.chat.v1.IGetSpaceReadStateRequest | null | undefined, {} | null | undefined>): void;
|
|
1075
|
+
getSpaceReadState(request: protos.google.chat.v1.IGetSpaceReadStateRequest, callback: Callback<protos.google.chat.v1.ISpaceReadState, protos.google.chat.v1.IGetSpaceReadStateRequest | null | undefined, {} | null | undefined>): void;
|
|
1076
|
+
/**
|
|
1077
|
+
* Updates a user's read state within a space, used to identify read and
|
|
1078
|
+
* unread messages.
|
|
1079
|
+
*
|
|
1080
|
+
* Requires [user
|
|
1081
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
1082
|
+
*
|
|
1083
|
+
* @param {Object} request
|
|
1084
|
+
* The request object that will be sent.
|
|
1085
|
+
* @param {google.chat.v1.SpaceReadState} request.spaceReadState
|
|
1086
|
+
* Required. The space read state and fields to update.
|
|
1087
|
+
*
|
|
1088
|
+
* Only supports updating read state for the calling user.
|
|
1089
|
+
*
|
|
1090
|
+
* To refer to the calling user, set one of the following:
|
|
1091
|
+
*
|
|
1092
|
+
* - The `me` alias. For example, `users/me/spaces/{space}/spaceReadState`.
|
|
1093
|
+
*
|
|
1094
|
+
* - Their Workspace email address. For example,
|
|
1095
|
+
* `users/user@example.com/spaces/{space}/spaceReadState`.
|
|
1096
|
+
*
|
|
1097
|
+
* - Their user id. For example,
|
|
1098
|
+
* `users/123456789/spaces/{space}/spaceReadState`.
|
|
1099
|
+
*
|
|
1100
|
+
* Format: users/{user}/spaces/{space}/spaceReadState
|
|
1101
|
+
* @param {google.protobuf.FieldMask} request.updateMask
|
|
1102
|
+
* Required. The field paths to update. Currently supported field paths:
|
|
1103
|
+
*
|
|
1104
|
+
* - `last_read_time`
|
|
1105
|
+
*
|
|
1106
|
+
* When the `last_read_time` is before the latest message create time, the
|
|
1107
|
+
* space appears as unread in the UI.
|
|
1108
|
+
*
|
|
1109
|
+
* To mark the space as read, set `last_read_time` to any value later (larger)
|
|
1110
|
+
* than the latest message create time. The `last_read_time` is coerced to
|
|
1111
|
+
* match the latest message create time. Note that the space read state only
|
|
1112
|
+
* affects the read state of messages that are visible in the space's
|
|
1113
|
+
* top-level conversation. Replies in threads are unaffected by this
|
|
1114
|
+
* timestamp, and instead rely on the thread read state.
|
|
1115
|
+
* @param {object} [options]
|
|
1116
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1117
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
1118
|
+
* The first element of the array is an object representing {@link protos.google.chat.v1.SpaceReadState|SpaceReadState}.
|
|
1119
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
1120
|
+
* for more details and examples.
|
|
1121
|
+
* @example <caption>include:samples/generated/v1/chat_service.update_space_read_state.js</caption>
|
|
1122
|
+
* region_tag:chat_v1_generated_ChatService_UpdateSpaceReadState_async
|
|
1123
|
+
*/
|
|
1124
|
+
updateSpaceReadState(request?: protos.google.chat.v1.IUpdateSpaceReadStateRequest, options?: CallOptions): Promise<[
|
|
1125
|
+
protos.google.chat.v1.ISpaceReadState,
|
|
1126
|
+
protos.google.chat.v1.IUpdateSpaceReadStateRequest | undefined,
|
|
1127
|
+
{} | undefined
|
|
1128
|
+
]>;
|
|
1129
|
+
updateSpaceReadState(request: protos.google.chat.v1.IUpdateSpaceReadStateRequest, options: CallOptions, callback: Callback<protos.google.chat.v1.ISpaceReadState, protos.google.chat.v1.IUpdateSpaceReadStateRequest | null | undefined, {} | null | undefined>): void;
|
|
1130
|
+
updateSpaceReadState(request: protos.google.chat.v1.IUpdateSpaceReadStateRequest, callback: Callback<protos.google.chat.v1.ISpaceReadState, protos.google.chat.v1.IUpdateSpaceReadStateRequest | null | undefined, {} | null | undefined>): void;
|
|
1131
|
+
/**
|
|
1132
|
+
* Returns details about a user's read state within a thread, used to identify
|
|
1133
|
+
* read and unread messages.
|
|
1134
|
+
*
|
|
1135
|
+
* Requires [user
|
|
1136
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
1137
|
+
*
|
|
1138
|
+
* @param {Object} request
|
|
1139
|
+
* The request object that will be sent.
|
|
1140
|
+
* @param {string} request.name
|
|
1141
|
+
* Required. Resource name of the thread read state to retrieve.
|
|
1142
|
+
*
|
|
1143
|
+
* Only supports getting read state for the calling user.
|
|
1144
|
+
*
|
|
1145
|
+
* To refer to the calling user, set one of the following:
|
|
1146
|
+
*
|
|
1147
|
+
* - The `me` alias. For example,
|
|
1148
|
+
* `users/me/spaces/{space}/threads/{thread}/threadReadState`.
|
|
1149
|
+
*
|
|
1150
|
+
* - Their Workspace email address. For example,
|
|
1151
|
+
* `users/user@example.com/spaces/{space}/threads/{thread}/threadReadState`.
|
|
1152
|
+
*
|
|
1153
|
+
* - Their user id. For example,
|
|
1154
|
+
* `users/123456789/spaces/{space}/threads/{thread}/threadReadState`.
|
|
1155
|
+
*
|
|
1156
|
+
* Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState
|
|
1157
|
+
* @param {object} [options]
|
|
1158
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1159
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
1160
|
+
* The first element of the array is an object representing {@link protos.google.chat.v1.ThreadReadState|ThreadReadState}.
|
|
1161
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
1162
|
+
* for more details and examples.
|
|
1163
|
+
* @example <caption>include:samples/generated/v1/chat_service.get_thread_read_state.js</caption>
|
|
1164
|
+
* region_tag:chat_v1_generated_ChatService_GetThreadReadState_async
|
|
1165
|
+
*/
|
|
1166
|
+
getThreadReadState(request?: protos.google.chat.v1.IGetThreadReadStateRequest, options?: CallOptions): Promise<[
|
|
1167
|
+
protos.google.chat.v1.IThreadReadState,
|
|
1168
|
+
protos.google.chat.v1.IGetThreadReadStateRequest | undefined,
|
|
1169
|
+
{} | undefined
|
|
1170
|
+
]>;
|
|
1171
|
+
getThreadReadState(request: protos.google.chat.v1.IGetThreadReadStateRequest, options: CallOptions, callback: Callback<protos.google.chat.v1.IThreadReadState, protos.google.chat.v1.IGetThreadReadStateRequest | null | undefined, {} | null | undefined>): void;
|
|
1172
|
+
getThreadReadState(request: protos.google.chat.v1.IGetThreadReadStateRequest, callback: Callback<protos.google.chat.v1.IThreadReadState, protos.google.chat.v1.IGetThreadReadStateRequest | null | undefined, {} | null | undefined>): void;
|
|
999
1173
|
/**
|
|
1000
1174
|
* Lists messages in a space that the caller is a member of, including
|
|
1001
1175
|
* messages from blocked members and spaces. For an example, see
|
|
1002
1176
|
* [List messages](/chat/api/guides/v1/messages/list).
|
|
1003
1177
|
* Requires [user
|
|
1004
|
-
* authentication](https://developers.google.com/chat/
|
|
1178
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
1005
1179
|
*
|
|
1006
1180
|
* @param {Object} request
|
|
1007
1181
|
* The request object that will be sent.
|
|
@@ -1015,8 +1189,8 @@ export declare class ChatServiceClient {
|
|
|
1015
1189
|
*
|
|
1016
1190
|
* If unspecified, at most 25 are returned.
|
|
1017
1191
|
*
|
|
1018
|
-
* The maximum value is
|
|
1019
|
-
* automatically changed to
|
|
1192
|
+
* The maximum value is 1000. If you use a value more than 1000, it's
|
|
1193
|
+
* automatically changed to 1000.
|
|
1020
1194
|
*
|
|
1021
1195
|
* Negative values return an `INVALID_ARGUMENT` error.
|
|
1022
1196
|
* @param {string} request.pageToken
|
|
@@ -1113,8 +1287,8 @@ export declare class ChatServiceClient {
|
|
|
1113
1287
|
*
|
|
1114
1288
|
* If unspecified, at most 25 are returned.
|
|
1115
1289
|
*
|
|
1116
|
-
* The maximum value is
|
|
1117
|
-
* automatically changed to
|
|
1290
|
+
* The maximum value is 1000. If you use a value more than 1000, it's
|
|
1291
|
+
* automatically changed to 1000.
|
|
1118
1292
|
*
|
|
1119
1293
|
* Negative values return an `INVALID_ARGUMENT` error.
|
|
1120
1294
|
* @param {string} request.pageToken
|
|
@@ -1206,8 +1380,8 @@ export declare class ChatServiceClient {
|
|
|
1206
1380
|
*
|
|
1207
1381
|
* If unspecified, at most 25 are returned.
|
|
1208
1382
|
*
|
|
1209
|
-
* The maximum value is
|
|
1210
|
-
* automatically changed to
|
|
1383
|
+
* The maximum value is 1000. If you use a value more than 1000, it's
|
|
1384
|
+
* automatically changed to 1000.
|
|
1211
1385
|
*
|
|
1212
1386
|
* Negative values return an `INVALID_ARGUMENT` error.
|
|
1213
1387
|
* @param {string} request.pageToken
|
|
@@ -1285,25 +1459,25 @@ export declare class ChatServiceClient {
|
|
|
1285
1459
|
*/
|
|
1286
1460
|
listMessagesAsync(request?: protos.google.chat.v1.IListMessagesRequest, options?: CallOptions): AsyncIterable<protos.google.chat.v1.IMessage>;
|
|
1287
1461
|
/**
|
|
1288
|
-
* Lists memberships in a space. For an example, see [List
|
|
1289
|
-
*
|
|
1290
|
-
* Listing
|
|
1291
|
-
* [app
|
|
1292
|
-
* authentication](https://developers.google.com/chat/
|
|
1462
|
+
* Lists memberships in a space. For an example, see [List users and Google
|
|
1463
|
+
* Chat apps in a
|
|
1464
|
+
* space](https://developers.google.com/workspace/chat/list-members). Listing
|
|
1465
|
+
* memberships with [app
|
|
1466
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
1293
1467
|
* lists memberships in spaces that the Chat app has
|
|
1294
1468
|
* access to, but excludes Chat app memberships,
|
|
1295
1469
|
* including its own. Listing memberships with
|
|
1296
1470
|
* [User
|
|
1297
|
-
* authentication](https://developers.google.com/chat/
|
|
1471
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
|
1298
1472
|
* lists memberships in spaces that the authenticated user has access to.
|
|
1299
1473
|
*
|
|
1300
1474
|
* Requires
|
|
1301
|
-
* [authentication](https://developers.google.com/chat/
|
|
1475
|
+
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
|
|
1302
1476
|
* Supports
|
|
1303
1477
|
* [app
|
|
1304
|
-
* authentication](https://developers.google.com/chat/
|
|
1478
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
1305
1479
|
* and [user
|
|
1306
|
-
* authentication](https://developers.google.com/chat/
|
|
1480
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
1307
1481
|
*
|
|
1308
1482
|
* @param {Object} request
|
|
1309
1483
|
* The request object that will be sent.
|
|
@@ -1318,8 +1492,8 @@ export declare class ChatServiceClient {
|
|
|
1318
1492
|
*
|
|
1319
1493
|
* If unspecified, at most 100 memberships are returned.
|
|
1320
1494
|
*
|
|
1321
|
-
* The maximum value is
|
|
1322
|
-
* automatically changed to
|
|
1495
|
+
* The maximum value is 1000. If you use a value more than 1000, it's
|
|
1496
|
+
* automatically changed to 1000.
|
|
1323
1497
|
*
|
|
1324
1498
|
* Negative values return an `INVALID_ARGUMENT` error.
|
|
1325
1499
|
* @param {string} [request.pageToken]
|
|
@@ -1333,9 +1507,9 @@ export declare class ChatServiceClient {
|
|
|
1333
1507
|
* Optional. A query filter.
|
|
1334
1508
|
*
|
|
1335
1509
|
* You can filter memberships by a member's role
|
|
1336
|
-
* ([`role`](https://developers.google.com/chat/api/reference/rest/v1/spaces.members#membershiprole))
|
|
1510
|
+
* ([`role`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole))
|
|
1337
1511
|
* and type
|
|
1338
|
-
* ([`member.type`](https://developers.google.com/chat/api/reference/rest/v1/User#type)).
|
|
1512
|
+
* ([`member.type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/User#type)).
|
|
1339
1513
|
*
|
|
1340
1514
|
* To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`.
|
|
1341
1515
|
*
|
|
@@ -1358,6 +1532,7 @@ export declare class ChatServiceClient {
|
|
|
1358
1532
|
* role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"
|
|
1359
1533
|
* ```
|
|
1360
1534
|
*
|
|
1535
|
+
*
|
|
1361
1536
|
* Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
|
|
1362
1537
|
* error.
|
|
1363
1538
|
* @param {boolean} [request.showGroups]
|
|
@@ -1376,7 +1551,7 @@ export declare class ChatServiceClient {
|
|
|
1376
1551
|
* that don't match the filter criteria aren't returned.
|
|
1377
1552
|
*
|
|
1378
1553
|
* Currently requires [user
|
|
1379
|
-
* authentication](https://developers.google.com/chat/
|
|
1554
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
1380
1555
|
* @param {object} [options]
|
|
1381
1556
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1382
1557
|
* @returns {Promise} - The promise which resolves to an array.
|
|
@@ -1411,8 +1586,8 @@ export declare class ChatServiceClient {
|
|
|
1411
1586
|
*
|
|
1412
1587
|
* If unspecified, at most 100 memberships are returned.
|
|
1413
1588
|
*
|
|
1414
|
-
* The maximum value is
|
|
1415
|
-
* automatically changed to
|
|
1589
|
+
* The maximum value is 1000. If you use a value more than 1000, it's
|
|
1590
|
+
* automatically changed to 1000.
|
|
1416
1591
|
*
|
|
1417
1592
|
* Negative values return an `INVALID_ARGUMENT` error.
|
|
1418
1593
|
* @param {string} [request.pageToken]
|
|
@@ -1426,9 +1601,9 @@ export declare class ChatServiceClient {
|
|
|
1426
1601
|
* Optional. A query filter.
|
|
1427
1602
|
*
|
|
1428
1603
|
* You can filter memberships by a member's role
|
|
1429
|
-
* ([`role`](https://developers.google.com/chat/api/reference/rest/v1/spaces.members#membershiprole))
|
|
1604
|
+
* ([`role`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole))
|
|
1430
1605
|
* and type
|
|
1431
|
-
* ([`member.type`](https://developers.google.com/chat/api/reference/rest/v1/User#type)).
|
|
1606
|
+
* ([`member.type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/User#type)).
|
|
1432
1607
|
*
|
|
1433
1608
|
* To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`.
|
|
1434
1609
|
*
|
|
@@ -1451,6 +1626,7 @@ export declare class ChatServiceClient {
|
|
|
1451
1626
|
* role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"
|
|
1452
1627
|
* ```
|
|
1453
1628
|
*
|
|
1629
|
+
*
|
|
1454
1630
|
* Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
|
|
1455
1631
|
* error.
|
|
1456
1632
|
* @param {boolean} [request.showGroups]
|
|
@@ -1469,7 +1645,7 @@ export declare class ChatServiceClient {
|
|
|
1469
1645
|
* that don't match the filter criteria aren't returned.
|
|
1470
1646
|
*
|
|
1471
1647
|
* Currently requires [user
|
|
1472
|
-
* authentication](https://developers.google.com/chat/
|
|
1648
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
1473
1649
|
* @param {object} [options]
|
|
1474
1650
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1475
1651
|
* @returns {Stream}
|
|
@@ -1499,8 +1675,8 @@ export declare class ChatServiceClient {
|
|
|
1499
1675
|
*
|
|
1500
1676
|
* If unspecified, at most 100 memberships are returned.
|
|
1501
1677
|
*
|
|
1502
|
-
* The maximum value is
|
|
1503
|
-
* automatically changed to
|
|
1678
|
+
* The maximum value is 1000. If you use a value more than 1000, it's
|
|
1679
|
+
* automatically changed to 1000.
|
|
1504
1680
|
*
|
|
1505
1681
|
* Negative values return an `INVALID_ARGUMENT` error.
|
|
1506
1682
|
* @param {string} [request.pageToken]
|
|
@@ -1514,9 +1690,9 @@ export declare class ChatServiceClient {
|
|
|
1514
1690
|
* Optional. A query filter.
|
|
1515
1691
|
*
|
|
1516
1692
|
* You can filter memberships by a member's role
|
|
1517
|
-
* ([`role`](https://developers.google.com/chat/api/reference/rest/v1/spaces.members#membershiprole))
|
|
1693
|
+
* ([`role`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole))
|
|
1518
1694
|
* and type
|
|
1519
|
-
* ([`member.type`](https://developers.google.com/chat/api/reference/rest/v1/User#type)).
|
|
1695
|
+
* ([`member.type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/User#type)).
|
|
1520
1696
|
*
|
|
1521
1697
|
* To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`.
|
|
1522
1698
|
*
|
|
@@ -1539,6 +1715,7 @@ export declare class ChatServiceClient {
|
|
|
1539
1715
|
* role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"
|
|
1540
1716
|
* ```
|
|
1541
1717
|
*
|
|
1718
|
+
*
|
|
1542
1719
|
* Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
|
|
1543
1720
|
* error.
|
|
1544
1721
|
* @param {boolean} [request.showGroups]
|
|
@@ -1557,7 +1734,7 @@ export declare class ChatServiceClient {
|
|
|
1557
1734
|
* that don't match the filter criteria aren't returned.
|
|
1558
1735
|
*
|
|
1559
1736
|
* Currently requires [user
|
|
1560
|
-
* authentication](https://developers.google.com/chat/
|
|
1737
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
1561
1738
|
* @param {object} [options]
|
|
1562
1739
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1563
1740
|
* @returns {Object}
|
|
@@ -1575,15 +1752,15 @@ export declare class ChatServiceClient {
|
|
|
1575
1752
|
* Lists spaces the caller is a member of. Group chats and DMs aren't listed
|
|
1576
1753
|
* until the first message is sent. For an example, see
|
|
1577
1754
|
* [List
|
|
1578
|
-
* spaces](https://developers.google.com/chat/
|
|
1755
|
+
* spaces](https://developers.google.com/workspace/chat/list-spaces).
|
|
1579
1756
|
*
|
|
1580
1757
|
* Requires
|
|
1581
|
-
* [authentication](https://developers.google.com/chat/
|
|
1758
|
+
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
|
|
1582
1759
|
* Supports
|
|
1583
1760
|
* [app
|
|
1584
|
-
* authentication](https://developers.google.com/chat/
|
|
1761
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
1585
1762
|
* and [user
|
|
1586
|
-
* authentication](https://developers.google.com/chat/
|
|
1763
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
1587
1764
|
*
|
|
1588
1765
|
* Lists spaces visible to the caller or authenticated user. Group chats
|
|
1589
1766
|
* and DMs aren't listed until the first message is sent.
|
|
@@ -1596,8 +1773,8 @@ export declare class ChatServiceClient {
|
|
|
1596
1773
|
*
|
|
1597
1774
|
* If unspecified, at most 100 spaces are returned.
|
|
1598
1775
|
*
|
|
1599
|
-
* The maximum value is
|
|
1600
|
-
* automatically changed to
|
|
1776
|
+
* The maximum value is 1000. If you use a value more than 1000, it's
|
|
1777
|
+
* automatically changed to 1000.
|
|
1601
1778
|
*
|
|
1602
1779
|
* Negative values return an `INVALID_ARGUMENT` error.
|
|
1603
1780
|
* @param {string} [request.pageToken]
|
|
@@ -1610,7 +1787,7 @@ export declare class ChatServiceClient {
|
|
|
1610
1787
|
* Optional. A query filter.
|
|
1611
1788
|
*
|
|
1612
1789
|
* You can filter spaces by the space type
|
|
1613
|
-
* ([`space_type`](https://developers.google.com/chat/api/reference/rest/v1/spaces#spacetype)).
|
|
1790
|
+
* ([`space_type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#spacetype)).
|
|
1614
1791
|
*
|
|
1615
1792
|
* To filter by space type, you must specify valid enum value, such as
|
|
1616
1793
|
* `SPACE` or `GROUP_CHAT` (the `space_type` can't be
|
|
@@ -1655,8 +1832,8 @@ export declare class ChatServiceClient {
|
|
|
1655
1832
|
*
|
|
1656
1833
|
* If unspecified, at most 100 spaces are returned.
|
|
1657
1834
|
*
|
|
1658
|
-
* The maximum value is
|
|
1659
|
-
* automatically changed to
|
|
1835
|
+
* The maximum value is 1000. If you use a value more than 1000, it's
|
|
1836
|
+
* automatically changed to 1000.
|
|
1660
1837
|
*
|
|
1661
1838
|
* Negative values return an `INVALID_ARGUMENT` error.
|
|
1662
1839
|
* @param {string} [request.pageToken]
|
|
@@ -1669,7 +1846,7 @@ export declare class ChatServiceClient {
|
|
|
1669
1846
|
* Optional. A query filter.
|
|
1670
1847
|
*
|
|
1671
1848
|
* You can filter spaces by the space type
|
|
1672
|
-
* ([`space_type`](https://developers.google.com/chat/api/reference/rest/v1/spaces#spacetype)).
|
|
1849
|
+
* ([`space_type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#spacetype)).
|
|
1673
1850
|
*
|
|
1674
1851
|
* To filter by space type, you must specify valid enum value, such as
|
|
1675
1852
|
* `SPACE` or `GROUP_CHAT` (the `space_type` can't be
|
|
@@ -1709,8 +1886,8 @@ export declare class ChatServiceClient {
|
|
|
1709
1886
|
*
|
|
1710
1887
|
* If unspecified, at most 100 spaces are returned.
|
|
1711
1888
|
*
|
|
1712
|
-
* The maximum value is
|
|
1713
|
-
* automatically changed to
|
|
1889
|
+
* The maximum value is 1000. If you use a value more than 1000, it's
|
|
1890
|
+
* automatically changed to 1000.
|
|
1714
1891
|
*
|
|
1715
1892
|
* Negative values return an `INVALID_ARGUMENT` error.
|
|
1716
1893
|
* @param {string} [request.pageToken]
|
|
@@ -1723,7 +1900,7 @@ export declare class ChatServiceClient {
|
|
|
1723
1900
|
* Optional. A query filter.
|
|
1724
1901
|
*
|
|
1725
1902
|
* You can filter spaces by the space type
|
|
1726
|
-
* ([`space_type`](https://developers.google.com/chat/api/reference/rest/v1/spaces#spacetype)).
|
|
1903
|
+
* ([`space_type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#spacetype)).
|
|
1727
1904
|
*
|
|
1728
1905
|
* To filter by space type, you must specify valid enum value, such as
|
|
1729
1906
|
* `SPACE` or `GROUP_CHAT` (the `space_type` can't be
|
|
@@ -1754,10 +1931,10 @@ export declare class ChatServiceClient {
|
|
|
1754
1931
|
listSpacesAsync(request?: protos.google.chat.v1.IListSpacesRequest, options?: CallOptions): AsyncIterable<protos.google.chat.v1.ISpace>;
|
|
1755
1932
|
/**
|
|
1756
1933
|
* Lists reactions to a message. For an example, see
|
|
1757
|
-
* [List
|
|
1758
|
-
*
|
|
1934
|
+
* [List reactions for a
|
|
1935
|
+
* message](https://developers.google.com/workspace/chat/list-reactions).
|
|
1759
1936
|
* Requires [user
|
|
1760
|
-
* authentication](https://developers.google.com/chat/
|
|
1937
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
1761
1938
|
*
|
|
1762
1939
|
* @param {Object} request
|
|
1763
1940
|
* The request object that will be sent.
|
|
@@ -1781,9 +1958,9 @@ export declare class ChatServiceClient {
|
|
|
1781
1958
|
* Optional. A query filter.
|
|
1782
1959
|
*
|
|
1783
1960
|
* You can filter reactions by
|
|
1784
|
-
* [emoji](https://developers.google.com/chat/api/reference/rest/v1/Emoji)
|
|
1961
|
+
* [emoji](https://developers.google.com/workspace/chat/api/reference/rest/v1/Emoji)
|
|
1785
1962
|
* (either `emoji.unicode` or `emoji.custom_emoji.uid`) and
|
|
1786
|
-
* [user](https://developers.google.com/chat/api/reference/rest/v1/User)
|
|
1963
|
+
* [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User)
|
|
1787
1964
|
* (`user.name`).
|
|
1788
1965
|
*
|
|
1789
1966
|
* To filter reactions for multiple emojis or users, join similar fields
|
|
@@ -1865,9 +2042,9 @@ export declare class ChatServiceClient {
|
|
|
1865
2042
|
* Optional. A query filter.
|
|
1866
2043
|
*
|
|
1867
2044
|
* You can filter reactions by
|
|
1868
|
-
* [emoji](https://developers.google.com/chat/api/reference/rest/v1/Emoji)
|
|
2045
|
+
* [emoji](https://developers.google.com/workspace/chat/api/reference/rest/v1/Emoji)
|
|
1869
2046
|
* (either `emoji.unicode` or `emoji.custom_emoji.uid`) and
|
|
1870
|
-
* [user](https://developers.google.com/chat/api/reference/rest/v1/User)
|
|
2047
|
+
* [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User)
|
|
1871
2048
|
* (`user.name`).
|
|
1872
2049
|
*
|
|
1873
2050
|
* To filter reactions for multiple emojis or users, join similar fields
|
|
@@ -1944,9 +2121,9 @@ export declare class ChatServiceClient {
|
|
|
1944
2121
|
* Optional. A query filter.
|
|
1945
2122
|
*
|
|
1946
2123
|
* You can filter reactions by
|
|
1947
|
-
* [emoji](https://developers.google.com/chat/api/reference/rest/v1/Emoji)
|
|
2124
|
+
* [emoji](https://developers.google.com/workspace/chat/api/reference/rest/v1/Emoji)
|
|
1948
2125
|
* (either `emoji.unicode` or `emoji.custom_emoji.uid`) and
|
|
1949
|
-
* [user](https://developers.google.com/chat/api/reference/rest/v1/User)
|
|
2126
|
+
* [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User)
|
|
1950
2127
|
* (`user.name`).
|
|
1951
2128
|
*
|
|
1952
2129
|
* To filter reactions for multiple emojis or users, join similar fields
|
|
@@ -2160,6 +2337,30 @@ export declare class ChatServiceClient {
|
|
|
2160
2337
|
* @returns {string} A string representing the space.
|
|
2161
2338
|
*/
|
|
2162
2339
|
matchSpaceFromSpaceName(spaceName: string): string | number;
|
|
2340
|
+
/**
|
|
2341
|
+
* Return a fully-qualified spaceReadState resource name string.
|
|
2342
|
+
*
|
|
2343
|
+
* @param {string} user
|
|
2344
|
+
* @param {string} space
|
|
2345
|
+
* @returns {string} Resource name string.
|
|
2346
|
+
*/
|
|
2347
|
+
spaceReadStatePath(user: string, space: string): string;
|
|
2348
|
+
/**
|
|
2349
|
+
* Parse the user from SpaceReadState resource.
|
|
2350
|
+
*
|
|
2351
|
+
* @param {string} spaceReadStateName
|
|
2352
|
+
* A fully-qualified path representing SpaceReadState resource.
|
|
2353
|
+
* @returns {string} A string representing the user.
|
|
2354
|
+
*/
|
|
2355
|
+
matchUserFromSpaceReadStateName(spaceReadStateName: string): string | number;
|
|
2356
|
+
/**
|
|
2357
|
+
* Parse the space from SpaceReadState resource.
|
|
2358
|
+
*
|
|
2359
|
+
* @param {string} spaceReadStateName
|
|
2360
|
+
* A fully-qualified path representing SpaceReadState resource.
|
|
2361
|
+
* @returns {string} A string representing the space.
|
|
2362
|
+
*/
|
|
2363
|
+
matchSpaceFromSpaceReadStateName(spaceReadStateName: string): string | number;
|
|
2163
2364
|
/**
|
|
2164
2365
|
* Return a fully-qualified thread resource name string.
|
|
2165
2366
|
*
|
|
@@ -2184,6 +2385,39 @@ export declare class ChatServiceClient {
|
|
|
2184
2385
|
* @returns {string} A string representing the thread.
|
|
2185
2386
|
*/
|
|
2186
2387
|
matchThreadFromThreadName(threadName: string): string | number;
|
|
2388
|
+
/**
|
|
2389
|
+
* Return a fully-qualified threadReadState resource name string.
|
|
2390
|
+
*
|
|
2391
|
+
* @param {string} user
|
|
2392
|
+
* @param {string} space
|
|
2393
|
+
* @param {string} thread
|
|
2394
|
+
* @returns {string} Resource name string.
|
|
2395
|
+
*/
|
|
2396
|
+
threadReadStatePath(user: string, space: string, thread: string): string;
|
|
2397
|
+
/**
|
|
2398
|
+
* Parse the user from ThreadReadState resource.
|
|
2399
|
+
*
|
|
2400
|
+
* @param {string} threadReadStateName
|
|
2401
|
+
* A fully-qualified path representing ThreadReadState resource.
|
|
2402
|
+
* @returns {string} A string representing the user.
|
|
2403
|
+
*/
|
|
2404
|
+
matchUserFromThreadReadStateName(threadReadStateName: string): string | number;
|
|
2405
|
+
/**
|
|
2406
|
+
* Parse the space from ThreadReadState resource.
|
|
2407
|
+
*
|
|
2408
|
+
* @param {string} threadReadStateName
|
|
2409
|
+
* A fully-qualified path representing ThreadReadState resource.
|
|
2410
|
+
* @returns {string} A string representing the space.
|
|
2411
|
+
*/
|
|
2412
|
+
matchSpaceFromThreadReadStateName(threadReadStateName: string): string | number;
|
|
2413
|
+
/**
|
|
2414
|
+
* Parse the thread from ThreadReadState resource.
|
|
2415
|
+
*
|
|
2416
|
+
* @param {string} threadReadStateName
|
|
2417
|
+
* A fully-qualified path representing ThreadReadState resource.
|
|
2418
|
+
* @returns {string} A string representing the thread.
|
|
2419
|
+
*/
|
|
2420
|
+
matchThreadFromThreadReadStateName(threadReadStateName: string): string | number;
|
|
2187
2421
|
/**
|
|
2188
2422
|
* Terminate the gRPC channel and close the client.
|
|
2189
2423
|
*
|