@google-apps/chat 0.10.0 → 0.11.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 +8 -0
- package/build/protos/google/chat/v1/attachment.proto +15 -13
- package/build/protos/google/chat/v1/chat_service.proto +166 -74
- package/build/protos/google/chat/v1/deletion_metadata.proto +2 -1
- package/build/protos/google/chat/v1/membership.proto +52 -32
- package/build/protos/google/chat/v1/message.proto +63 -54
- package/build/protos/google/chat/v1/reaction.proto +16 -12
- package/build/protos/google/chat/v1/space.proto +97 -51
- package/build/protos/google/chat/v1/space_event.proto +4 -4
- package/build/protos/protos.d.ts +118 -0
- package/build/protos/protos.js +313 -0
- package/build/protos/protos.json +237 -53
- package/build/src/v1/chat_service_client.d.ts +287 -181
- package/build/src/v1/chat_service_client.js +42 -48
- package/build/src/v1/chat_service_client.js.map +1 -1
- package/package.json +1 -1
|
@@ -119,8 +119,11 @@ export declare class ChatServiceClient {
|
|
|
119
119
|
* Creates a message in a Google Chat space. For an example, see [Send a
|
|
120
120
|
* message](https://developers.google.com/workspace/chat/create-messages).
|
|
121
121
|
*
|
|
122
|
-
* The `create()` method requires either user
|
|
123
|
-
*
|
|
122
|
+
* The `create()` method requires either [user
|
|
123
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
|
124
|
+
* or [app
|
|
125
|
+
* authentication](https://developers.google.com/workspace/chat/authorize-import).
|
|
126
|
+
* Chat attributes the message sender differently depending on the type of
|
|
124
127
|
* authentication that you use in your request.
|
|
125
128
|
*
|
|
126
129
|
* The following image shows how Chat attributes a message when you use app
|
|
@@ -141,6 +144,12 @@ export declare class ChatServiceClient {
|
|
|
141
144
|
*
|
|
142
145
|
* The maximum message size, including the message contents, is 32,000 bytes.
|
|
143
146
|
*
|
|
147
|
+
* For
|
|
148
|
+
* [webhook](https://developers.google.com/workspace/chat/quickstart/webhooks)
|
|
149
|
+
* requests, the response doesn't contain the full message. The response only
|
|
150
|
+
* populates the `name` and `thread.name` fields in addition to the
|
|
151
|
+
* information that was in the request.
|
|
152
|
+
*
|
|
144
153
|
* @param {Object} request
|
|
145
154
|
* The request object that will be sent.
|
|
146
155
|
* @param {string} request.parent
|
|
@@ -164,6 +173,12 @@ export declare class ChatServiceClient {
|
|
|
164
173
|
* @param {google.chat.v1.CreateMessageRequest.MessageReplyOption} [request.messageReplyOption]
|
|
165
174
|
* Optional. Specifies whether a message starts a thread or replies to one.
|
|
166
175
|
* Only supported in named spaces.
|
|
176
|
+
*
|
|
177
|
+
* When [responding to user
|
|
178
|
+
* interactions](https://developers.google.com/workspace/chat/receive-respond-interactions),
|
|
179
|
+
* this field is ignored. For interactions within a thread, the reply is
|
|
180
|
+
* created in the same thread. Otherwise, the reply is created as a new
|
|
181
|
+
* thread.
|
|
167
182
|
* @param {string} [request.messageId]
|
|
168
183
|
* Optional. A custom ID for a message. Lets Chat apps get, update, or delete
|
|
169
184
|
* a message without needing to store the system-assigned ID in the message's
|
|
@@ -201,13 +216,16 @@ export declare class ChatServiceClient {
|
|
|
201
216
|
* [Get details about a user's or Google Chat app's
|
|
202
217
|
* membership](https://developers.google.com/workspace/chat/get-members).
|
|
203
218
|
*
|
|
204
|
-
*
|
|
205
|
-
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize)
|
|
206
|
-
*
|
|
207
|
-
* [
|
|
219
|
+
* Supports the following types of
|
|
220
|
+
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
|
|
221
|
+
*
|
|
222
|
+
* - [App
|
|
208
223
|
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
209
|
-
*
|
|
210
|
-
*
|
|
224
|
+
*
|
|
225
|
+
* - [User
|
|
226
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
|
227
|
+
* You can authenticate and authorize this method with administrator
|
|
228
|
+
* privileges by setting the `use_admin_access` field in the request.
|
|
211
229
|
*
|
|
212
230
|
* @param {Object} request
|
|
213
231
|
* The request object that will be sent.
|
|
@@ -220,13 +238,11 @@ export declare class ChatServiceClient {
|
|
|
220
238
|
*
|
|
221
239
|
* Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`
|
|
222
240
|
*
|
|
223
|
-
*
|
|
224
|
-
* user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
|
|
225
|
-
* you can use the user's email as an alias for `{member}`. For example,
|
|
241
|
+
* You can use the user's email as an alias for `{member}`. For example,
|
|
226
242
|
* `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the
|
|
227
243
|
* email of the Google Chat user.
|
|
228
|
-
* @param {boolean} request.useAdminAccess
|
|
229
|
-
* When `true`, the method runs using the user's Google Workspace
|
|
244
|
+
* @param {boolean} [request.useAdminAccess]
|
|
245
|
+
* Optional. When `true`, the method runs using the user's Google Workspace
|
|
230
246
|
* administrator privileges.
|
|
231
247
|
*
|
|
232
248
|
* The calling user must be a Google Workspace administrator with the
|
|
@@ -259,13 +275,14 @@ export declare class ChatServiceClient {
|
|
|
259
275
|
* For an example, see [Get details about a
|
|
260
276
|
* message](https://developers.google.com/workspace/chat/get-messages).
|
|
261
277
|
*
|
|
262
|
-
*
|
|
263
|
-
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize)
|
|
264
|
-
*
|
|
265
|
-
* [
|
|
278
|
+
* Supports the following types of
|
|
279
|
+
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
|
|
280
|
+
*
|
|
281
|
+
* - [App
|
|
266
282
|
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
267
|
-
*
|
|
268
|
-
*
|
|
283
|
+
*
|
|
284
|
+
* - [User
|
|
285
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
|
269
286
|
*
|
|
270
287
|
* Note: Might return a message from a blocked member or space.
|
|
271
288
|
*
|
|
@@ -304,13 +321,15 @@ export declare class ChatServiceClient {
|
|
|
304
321
|
* [Update a
|
|
305
322
|
* message](https://developers.google.com/workspace/chat/update-messages).
|
|
306
323
|
*
|
|
307
|
-
*
|
|
308
|
-
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize)
|
|
309
|
-
*
|
|
310
|
-
* [
|
|
324
|
+
* Supports the following types of
|
|
325
|
+
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
|
|
326
|
+
*
|
|
327
|
+
* - [App
|
|
311
328
|
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
312
|
-
*
|
|
313
|
-
*
|
|
329
|
+
*
|
|
330
|
+
* - [User
|
|
331
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
|
332
|
+
*
|
|
314
333
|
* When using app authentication, requests can only update messages
|
|
315
334
|
* created by the calling Chat app.
|
|
316
335
|
*
|
|
@@ -362,13 +381,15 @@ export declare class ChatServiceClient {
|
|
|
362
381
|
* For an example, see [Delete a
|
|
363
382
|
* message](https://developers.google.com/workspace/chat/delete-messages).
|
|
364
383
|
*
|
|
365
|
-
*
|
|
366
|
-
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize)
|
|
367
|
-
*
|
|
368
|
-
* [
|
|
384
|
+
* Supports the following types of
|
|
385
|
+
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
|
|
386
|
+
*
|
|
387
|
+
* - [App
|
|
369
388
|
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
370
|
-
*
|
|
371
|
-
*
|
|
389
|
+
*
|
|
390
|
+
* - [User
|
|
391
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
|
392
|
+
*
|
|
372
393
|
* When using app authentication, requests can only delete messages
|
|
373
394
|
* created by the calling Chat app.
|
|
374
395
|
*
|
|
@@ -383,9 +404,9 @@ export declare class ChatServiceClient {
|
|
|
383
404
|
* `clientAssignedMessageId` field for `{message}`. For details, see [Name a
|
|
384
405
|
* message]
|
|
385
406
|
* (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
|
|
386
|
-
* @param {boolean} request.force
|
|
387
|
-
* When `true`, deleting a message also deletes its threaded
|
|
388
|
-
* `false`, if a message has threaded replies, deletion fails.
|
|
407
|
+
* @param {boolean} [request.force]
|
|
408
|
+
* Optional. When `true`, deleting a message also deletes its threaded
|
|
409
|
+
* replies. When `false`, if a message has threaded replies, deletion fails.
|
|
389
410
|
*
|
|
390
411
|
* Only applies when [authenticating as a
|
|
391
412
|
* user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
@@ -442,6 +463,7 @@ export declare class ChatServiceClient {
|
|
|
442
463
|
* Uploads an attachment. For an example, see
|
|
443
464
|
* [Upload media as a file
|
|
444
465
|
* attachment](https://developers.google.com/workspace/chat/upload-media-attachments).
|
|
466
|
+
*
|
|
445
467
|
* Requires user
|
|
446
468
|
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
447
469
|
*
|
|
@@ -477,13 +499,16 @@ export declare class ChatServiceClient {
|
|
|
477
499
|
* [Get details about a
|
|
478
500
|
* space](https://developers.google.com/workspace/chat/get-spaces).
|
|
479
501
|
*
|
|
480
|
-
*
|
|
481
|
-
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize)
|
|
482
|
-
*
|
|
483
|
-
* [
|
|
502
|
+
* Supports the following types of
|
|
503
|
+
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
|
|
504
|
+
*
|
|
505
|
+
* - [App
|
|
484
506
|
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
485
|
-
*
|
|
486
|
-
*
|
|
507
|
+
*
|
|
508
|
+
* - [User
|
|
509
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
|
510
|
+
* You can authenticate and authorize this method with administrator
|
|
511
|
+
* privileges by setting the `use_admin_access` field in the request.
|
|
487
512
|
*
|
|
488
513
|
* @param {Object} request
|
|
489
514
|
* The request object that will be sent.
|
|
@@ -491,8 +516,8 @@ export declare class ChatServiceClient {
|
|
|
491
516
|
* Required. Resource name of the space, in the form `spaces/{space}`.
|
|
492
517
|
*
|
|
493
518
|
* Format: `spaces/{space}`
|
|
494
|
-
* @param {boolean} request.useAdminAccess
|
|
495
|
-
* When `true`, the method runs using the user's Google Workspace
|
|
519
|
+
* @param {boolean} [request.useAdminAccess]
|
|
520
|
+
* Optional. When `true`, the method runs using the user's Google Workspace
|
|
496
521
|
* administrator privileges.
|
|
497
522
|
*
|
|
498
523
|
* The calling user must be a Google Workspace administrator with the
|
|
@@ -518,35 +543,39 @@ export declare class ChatServiceClient {
|
|
|
518
543
|
getSpace(request: protos.google.chat.v1.IGetSpaceRequest, options: CallOptions, callback: Callback<protos.google.chat.v1.ISpace, protos.google.chat.v1.IGetSpaceRequest | null | undefined, {} | null | undefined>): void;
|
|
519
544
|
getSpace(request: protos.google.chat.v1.IGetSpaceRequest, callback: Callback<protos.google.chat.v1.ISpace, protos.google.chat.v1.IGetSpaceRequest | null | undefined, {} | null | undefined>): void;
|
|
520
545
|
/**
|
|
521
|
-
* Creates a space with no members. Can be used to create a named space
|
|
522
|
-
*
|
|
523
|
-
* [Create a
|
|
546
|
+
* Creates a space with no members. Can be used to create a named space, or a
|
|
547
|
+
* group chat in `Import mode`. For an example, see [Create a
|
|
524
548
|
* space](https://developers.google.com/workspace/chat/create-spaces).
|
|
525
549
|
*
|
|
526
550
|
* If you receive the error message `ALREADY_EXISTS` when creating
|
|
527
551
|
* a space, try a different `displayName`. An existing space within
|
|
528
552
|
* the Google Workspace organization might already use this display name.
|
|
529
553
|
*
|
|
530
|
-
*
|
|
531
|
-
*
|
|
532
|
-
* group chat in import mode using `spaceType.GROUP_CHAT`.
|
|
554
|
+
* Supports the following types of
|
|
555
|
+
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
|
|
533
556
|
*
|
|
534
|
-
*
|
|
535
|
-
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-
|
|
557
|
+
* - [App
|
|
558
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
559
|
+
* with [administrator approval](https://support.google.com/a?p=chat-app-auth)
|
|
560
|
+
* in [Developer Preview](https://developers.google.com/workspace/preview)
|
|
561
|
+
*
|
|
562
|
+
* - [User
|
|
563
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
|
564
|
+
*
|
|
565
|
+
* When authenticating as an app, the `space.customer` field must be set in
|
|
566
|
+
* the request.
|
|
536
567
|
*
|
|
537
568
|
* @param {Object} request
|
|
538
569
|
* The request object that will be sent.
|
|
539
570
|
* @param {google.chat.v1.Space} request.space
|
|
540
571
|
* Required. The `displayName` and `spaceType` fields must be populated. Only
|
|
541
|
-
* `SpaceType.SPACE`
|
|
572
|
+
* `SpaceType.SPACE` and `SpaceType.GROUP_CHAT` are supported.
|
|
573
|
+
* `SpaceType.GROUP_CHAT` can only be used if `importMode` is set to true.
|
|
542
574
|
*
|
|
543
575
|
* If you receive the error message `ALREADY_EXISTS`,
|
|
544
576
|
* try a different `displayName`. An existing space within the Google
|
|
545
577
|
* Workspace organization might already use this display name.
|
|
546
578
|
*
|
|
547
|
-
* If you're a member of the [Developer Preview
|
|
548
|
-
* program](https://developers.google.com/workspace/preview),
|
|
549
|
-
* `SpaceType.GROUP_CHAT` can be used if `importMode` is set to true.
|
|
550
579
|
*
|
|
551
580
|
* The space `name` is assigned on the server so anything specified in this
|
|
552
581
|
* field will be ignored.
|
|
@@ -715,8 +744,18 @@ export declare class ChatServiceClient {
|
|
|
715
744
|
* `ALREADY_EXISTS`, try a different display name.. An existing space within
|
|
716
745
|
* the Google Workspace organization might already use this display name.
|
|
717
746
|
*
|
|
718
|
-
*
|
|
719
|
-
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize
|
|
747
|
+
* Supports the following types of
|
|
748
|
+
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
|
|
749
|
+
*
|
|
750
|
+
* - [App
|
|
751
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
752
|
+
* with [administrator approval](https://support.google.com/a?p=chat-app-auth)
|
|
753
|
+
* in [Developer Preview](https://developers.google.com/workspace/preview)
|
|
754
|
+
*
|
|
755
|
+
* - [User
|
|
756
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
|
757
|
+
* You can authenticate and authorize this method with administrator
|
|
758
|
+
* privileges by setting the `use_admin_access` field in the request.
|
|
720
759
|
*
|
|
721
760
|
* @param {Object} request
|
|
722
761
|
* The request object that will be sent.
|
|
@@ -786,8 +825,8 @@ export declare class ChatServiceClient {
|
|
|
786
825
|
* - `permission_settings.manageApps`
|
|
787
826
|
* - `permission_settings.manageWebhooks`
|
|
788
827
|
* - `permission_settings.replyMessages`
|
|
789
|
-
* @param {boolean} request.useAdminAccess
|
|
790
|
-
* When `true`, the method runs using the user's Google Workspace
|
|
828
|
+
* @param {boolean} [request.useAdminAccess]
|
|
829
|
+
* Optional. When `true`, the method runs using the user's Google Workspace
|
|
791
830
|
* administrator privileges.
|
|
792
831
|
*
|
|
793
832
|
* The calling user must be a Google Workspace administrator with the
|
|
@@ -821,9 +860,19 @@ export declare class ChatServiceClient {
|
|
|
821
860
|
* memberships in the space—are also deleted. For an example, see
|
|
822
861
|
* [Delete a
|
|
823
862
|
* space](https://developers.google.com/workspace/chat/delete-spaces).
|
|
824
|
-
*
|
|
863
|
+
*
|
|
864
|
+
* Supports the following types of
|
|
865
|
+
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
|
|
866
|
+
*
|
|
867
|
+
* - [App
|
|
868
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
869
|
+
* with [administrator approval](https://support.google.com/a?p=chat-app-auth)
|
|
870
|
+
* in [Developer Preview](https://developers.google.com/workspace/preview)
|
|
871
|
+
*
|
|
872
|
+
* - [User
|
|
825
873
|
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
|
826
|
-
*
|
|
874
|
+
* You can authenticate and authorize this method with administrator
|
|
875
|
+
* privileges by setting the `use_admin_access` field in the request.
|
|
827
876
|
*
|
|
828
877
|
* @param {Object} request
|
|
829
878
|
* The request object that will be sent.
|
|
@@ -831,8 +880,8 @@ export declare class ChatServiceClient {
|
|
|
831
880
|
* Required. Resource name of the space to delete.
|
|
832
881
|
*
|
|
833
882
|
* Format: `spaces/{space}`
|
|
834
|
-
* @param {boolean} request.useAdminAccess
|
|
835
|
-
* When `true`, the method runs using the user's Google Workspace
|
|
883
|
+
* @param {boolean} [request.useAdminAccess]
|
|
884
|
+
* Optional. When `true`, the method runs using the user's Google Workspace
|
|
836
885
|
* administrator privileges.
|
|
837
886
|
*
|
|
838
887
|
* The calling user must be a Google Workspace administrator with the
|
|
@@ -861,8 +910,11 @@ export declare class ChatServiceClient {
|
|
|
861
910
|
* Completes the
|
|
862
911
|
* [import process](https://developers.google.com/workspace/chat/import-data)
|
|
863
912
|
* for the specified space and makes it visible to users.
|
|
864
|
-
*
|
|
865
|
-
*
|
|
913
|
+
*
|
|
914
|
+
* Requires [app
|
|
915
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
916
|
+
* and domain-wide delegation. For more information, see [Authorize Google
|
|
917
|
+
* Chat apps to import
|
|
866
918
|
* data](https://developers.google.com/workspace/chat/authorize-import).
|
|
867
919
|
*
|
|
868
920
|
* @param {Object} request
|
|
@@ -893,20 +945,24 @@ export declare class ChatServiceClient {
|
|
|
893
945
|
* see
|
|
894
946
|
* [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message).
|
|
895
947
|
*
|
|
948
|
+
* With [app
|
|
949
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app),
|
|
950
|
+
* returns the direct message space between the specified user and the calling
|
|
951
|
+
* Chat app.
|
|
952
|
+
*
|
|
896
953
|
* With [user
|
|
897
954
|
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
|
|
898
955
|
* returns the direct message space between the specified user and the
|
|
899
956
|
* authenticated user.
|
|
900
957
|
*
|
|
901
|
-
*
|
|
902
|
-
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize
|
|
903
|
-
* returns the direct message space between the specified user and the calling
|
|
904
|
-
* Chat app.
|
|
958
|
+
* // Supports the following types of
|
|
959
|
+
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
|
|
905
960
|
*
|
|
906
|
-
*
|
|
961
|
+
* - [App
|
|
962
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
963
|
+
*
|
|
964
|
+
* - [User
|
|
907
965
|
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
|
908
|
-
* or [app
|
|
909
|
-
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
|
|
910
966
|
*
|
|
911
967
|
* @param {Object} request
|
|
912
968
|
* The request object that will be sent.
|
|
@@ -947,8 +1003,19 @@ export declare class ChatServiceClient {
|
|
|
947
1003
|
* policy turned off, then they're invited, and must accept the space
|
|
948
1004
|
* invitation before joining. Otherwise, creating a membership adds the member
|
|
949
1005
|
* directly to the specified space.
|
|
950
|
-
*
|
|
951
|
-
*
|
|
1006
|
+
*
|
|
1007
|
+
* Supports the following types of
|
|
1008
|
+
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
|
|
1009
|
+
*
|
|
1010
|
+
* - [App
|
|
1011
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
1012
|
+
* with [administrator approval](https://support.google.com/a?p=chat-app-auth)
|
|
1013
|
+
* in [Developer Preview](https://developers.google.com/workspace/preview)
|
|
1014
|
+
*
|
|
1015
|
+
* - [User
|
|
1016
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
|
1017
|
+
* You can authenticate and authorize this method with administrator
|
|
1018
|
+
* privileges by setting the `use_admin_access` field in the request.
|
|
952
1019
|
*
|
|
953
1020
|
* For example usage, see:
|
|
954
1021
|
*
|
|
@@ -970,23 +1037,44 @@ export declare class ChatServiceClient {
|
|
|
970
1037
|
* Format: spaces/{space}
|
|
971
1038
|
* @param {google.chat.v1.Membership} request.membership
|
|
972
1039
|
* Required. The membership relation to create.
|
|
1040
|
+
*
|
|
973
1041
|
* The `memberType` field must contain a user with the `user.name` and
|
|
974
1042
|
* `user.type` fields populated. The server will assign a resource name
|
|
975
1043
|
* and overwrite anything specified.
|
|
1044
|
+
*
|
|
976
1045
|
* When a Chat app creates a membership relation for a human user, it must use
|
|
977
|
-
*
|
|
978
|
-
*
|
|
979
|
-
*
|
|
980
|
-
*
|
|
981
|
-
*
|
|
982
|
-
*
|
|
983
|
-
*
|
|
984
|
-
*
|
|
985
|
-
* `
|
|
986
|
-
*
|
|
987
|
-
*
|
|
988
|
-
*
|
|
989
|
-
*
|
|
1046
|
+
* certain authorization scopes and set specific values for certain fields:
|
|
1047
|
+
*
|
|
1048
|
+
* - When [authenticating as a
|
|
1049
|
+
* user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
|
|
1050
|
+
* the `chat.memberships` authorization scope is required.
|
|
1051
|
+
*
|
|
1052
|
+
* - When [authenticating as an
|
|
1053
|
+
* app](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app),
|
|
1054
|
+
* the `chat.app.memberships` authorization scope is required.
|
|
1055
|
+
* Authenticating as an app is available in [Developer
|
|
1056
|
+
* Preview](https://developers.google.com/workspace/preview).
|
|
1057
|
+
*
|
|
1058
|
+
* - Set `user.type` to `HUMAN`, and set `user.name` with format
|
|
1059
|
+
* `users/{user}`, where `{user}` can be the email address for the user. For
|
|
1060
|
+
* users in the same Workspace organization `{user}` can also be the `id` of
|
|
1061
|
+
* the [person](https://developers.google.com/people/api/rest/v1/people) from
|
|
1062
|
+
* the People API, or the `id` for the user in the Directory API. For example,
|
|
1063
|
+
* if the People API Person profile ID for `user@example.com` is `123456789`,
|
|
1064
|
+
* you can add the user to the space by setting the `membership.member.name`
|
|
1065
|
+
* to `users/user@example.com` or `users/123456789`.
|
|
1066
|
+
*
|
|
1067
|
+
* Inviting users external to the Workspace organization that owns the space
|
|
1068
|
+
* requires [user
|
|
1069
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
1070
|
+
*
|
|
1071
|
+
* When a Chat app creates a membership relation for itself, it must
|
|
1072
|
+
* [authenticate as a
|
|
1073
|
+
* user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
|
1074
|
+
* and use the `chat.memberships.app` scope, set `user.type` to `BOT`, and set
|
|
1075
|
+
* `user.name` to `users/app`.
|
|
1076
|
+
* @param {boolean} [request.useAdminAccess]
|
|
1077
|
+
* Optional. When `true`, the method runs using the user's Google Workspace
|
|
990
1078
|
* administrator privileges.
|
|
991
1079
|
*
|
|
992
1080
|
* The calling user must be a Google Workspace administrator with the
|
|
@@ -1019,8 +1107,18 @@ export declare class ChatServiceClient {
|
|
|
1019
1107
|
* Updates a membership. For an example, see [Update a user's membership in
|
|
1020
1108
|
* a space](https://developers.google.com/workspace/chat/update-members).
|
|
1021
1109
|
*
|
|
1022
|
-
*
|
|
1023
|
-
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize
|
|
1110
|
+
* Supports the following types of
|
|
1111
|
+
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
|
|
1112
|
+
*
|
|
1113
|
+
* - [App
|
|
1114
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
1115
|
+
* with [administrator approval](https://support.google.com/a?p=chat-app-auth)
|
|
1116
|
+
* in [Developer Preview](https://developers.google.com/workspace/preview)
|
|
1117
|
+
*
|
|
1118
|
+
* - [User
|
|
1119
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
|
1120
|
+
* You can authenticate and authorize this method with administrator
|
|
1121
|
+
* privileges by setting the `use_admin_access` field in the request.
|
|
1024
1122
|
*
|
|
1025
1123
|
* @param {Object} request
|
|
1026
1124
|
* The request object that will be sent.
|
|
@@ -1034,8 +1132,8 @@ export declare class ChatServiceClient {
|
|
|
1034
1132
|
* Currently supported field paths:
|
|
1035
1133
|
*
|
|
1036
1134
|
* - `role`
|
|
1037
|
-
* @param {boolean} request.useAdminAccess
|
|
1038
|
-
* When `true`, the method runs using the user's Google Workspace
|
|
1135
|
+
* @param {boolean} [request.useAdminAccess]
|
|
1136
|
+
* Optional. When `true`, the method runs using the user's Google Workspace
|
|
1039
1137
|
* administrator privileges.
|
|
1040
1138
|
*
|
|
1041
1139
|
* The calling user must be a Google Workspace administrator with the
|
|
@@ -1065,8 +1163,18 @@ export declare class ChatServiceClient {
|
|
|
1065
1163
|
* [Remove a user or a Google Chat app from a
|
|
1066
1164
|
* space](https://developers.google.com/workspace/chat/delete-members).
|
|
1067
1165
|
*
|
|
1068
|
-
*
|
|
1069
|
-
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize
|
|
1166
|
+
* Supports the following types of
|
|
1167
|
+
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
|
|
1168
|
+
*
|
|
1169
|
+
* - [App
|
|
1170
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
1171
|
+
* with [administrator approval](https://support.google.com/a?p=chat-app-auth)
|
|
1172
|
+
* in [Developer Preview](https://developers.google.com/workspace/preview)
|
|
1173
|
+
*
|
|
1174
|
+
* - [User
|
|
1175
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
|
1176
|
+
* You can authenticate and authorize this method with administrator
|
|
1177
|
+
* privileges by setting the `use_admin_access` field in the request.
|
|
1070
1178
|
*
|
|
1071
1179
|
* @param {Object} request
|
|
1072
1180
|
* The request object that will be sent.
|
|
@@ -1085,8 +1193,8 @@ export declare class ChatServiceClient {
|
|
|
1085
1193
|
* and `spaces/{space}/members/app` format.
|
|
1086
1194
|
*
|
|
1087
1195
|
* Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`.
|
|
1088
|
-
* @param {boolean} request.useAdminAccess
|
|
1089
|
-
* When `true`, the method runs using the user's Google Workspace
|
|
1196
|
+
* @param {boolean} [request.useAdminAccess]
|
|
1197
|
+
* Optional. When `true`, the method runs using the user's Google Workspace
|
|
1090
1198
|
* administrator privileges.
|
|
1091
1199
|
*
|
|
1092
1200
|
* The calling user must be a Google Workspace administrator with the
|
|
@@ -1118,6 +1226,7 @@ export declare class ChatServiceClient {
|
|
|
1118
1226
|
* supported. For an example, see
|
|
1119
1227
|
* [Add a reaction to a
|
|
1120
1228
|
* message](https://developers.google.com/workspace/chat/create-reactions).
|
|
1229
|
+
*
|
|
1121
1230
|
* Requires [user
|
|
1122
1231
|
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
1123
1232
|
*
|
|
@@ -1150,6 +1259,7 @@ export declare class ChatServiceClient {
|
|
|
1150
1259
|
* For an example, see
|
|
1151
1260
|
* [Delete a
|
|
1152
1261
|
* reaction](https://developers.google.com/workspace/chat/delete-reactions).
|
|
1262
|
+
*
|
|
1153
1263
|
* Requires [user
|
|
1154
1264
|
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
1155
1265
|
*
|
|
@@ -1367,6 +1477,7 @@ export declare class ChatServiceClient {
|
|
|
1367
1477
|
* For an example, see
|
|
1368
1478
|
* [List
|
|
1369
1479
|
* messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list).
|
|
1480
|
+
*
|
|
1370
1481
|
* Requires [user
|
|
1371
1482
|
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
1372
1483
|
*
|
|
@@ -1376,9 +1487,9 @@ export declare class ChatServiceClient {
|
|
|
1376
1487
|
* Required. The resource name of the space to list messages from.
|
|
1377
1488
|
*
|
|
1378
1489
|
* Format: `spaces/{space}`
|
|
1379
|
-
* @param {number} request.pageSize
|
|
1380
|
-
* The maximum number of messages returned. The service might return
|
|
1381
|
-
* messages than this value.
|
|
1490
|
+
* @param {number} [request.pageSize]
|
|
1491
|
+
* Optional. The maximum number of messages returned. The service might return
|
|
1492
|
+
* fewer messages than this value.
|
|
1382
1493
|
*
|
|
1383
1494
|
* If unspecified, at most 25 are returned.
|
|
1384
1495
|
*
|
|
@@ -1386,17 +1497,15 @@ export declare class ChatServiceClient {
|
|
|
1386
1497
|
* automatically changed to 1000.
|
|
1387
1498
|
*
|
|
1388
1499
|
* Negative values return an `INVALID_ARGUMENT` error.
|
|
1389
|
-
* @param {string} request.pageToken
|
|
1390
|
-
* Optional
|
|
1391
|
-
*
|
|
1392
|
-
* A page token received from a previous list messages call. Provide this
|
|
1393
|
-
* parameter to retrieve the subsequent page.
|
|
1500
|
+
* @param {string} [request.pageToken]
|
|
1501
|
+
* Optional. A page token received from a previous list messages call. Provide
|
|
1502
|
+
* this parameter to retrieve the subsequent page.
|
|
1394
1503
|
*
|
|
1395
1504
|
* When paginating, all other parameters provided should match the call that
|
|
1396
1505
|
* provided the page token. Passing different values to the other parameters
|
|
1397
1506
|
* might lead to unexpected results.
|
|
1398
|
-
* @param {string} request.filter
|
|
1399
|
-
* A query filter.
|
|
1507
|
+
* @param {string} [request.filter]
|
|
1508
|
+
* Optional. A query filter.
|
|
1400
1509
|
*
|
|
1401
1510
|
* You can filter messages by date (`create_time`) and thread (`thread.name`).
|
|
1402
1511
|
*
|
|
@@ -1433,20 +1542,19 @@ export declare class ChatServiceClient {
|
|
|
1433
1542
|
*
|
|
1434
1543
|
* Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
|
|
1435
1544
|
* error.
|
|
1436
|
-
* @param {string} request.orderBy
|
|
1437
|
-
* Optional
|
|
1438
|
-
*
|
|
1439
|
-
* How the list of messages is ordered. Specify a value to order by an
|
|
1440
|
-
* ordering operation. Valid ordering operation values are as follows:
|
|
1545
|
+
* @param {string} [request.orderBy]
|
|
1546
|
+
* Optional. How the list of messages is ordered. Specify a value to order by
|
|
1547
|
+
* an ordering operation. Valid ordering operation values are as follows:
|
|
1441
1548
|
*
|
|
1442
1549
|
* - `ASC` for ascending.
|
|
1443
1550
|
*
|
|
1444
1551
|
* - `DESC` for descending.
|
|
1445
1552
|
*
|
|
1446
1553
|
* The default ordering is `create_time ASC`.
|
|
1447
|
-
* @param {boolean} request.showDeleted
|
|
1448
|
-
* Whether to include deleted messages. Deleted messages include
|
|
1449
|
-
* and metadata about their deletion, but message content is
|
|
1554
|
+
* @param {boolean} [request.showDeleted]
|
|
1555
|
+
* Optional. Whether to include deleted messages. Deleted messages include
|
|
1556
|
+
* deleted time and metadata about their deletion, but message content is
|
|
1557
|
+
* unavailable.
|
|
1450
1558
|
* @param {object} [options]
|
|
1451
1559
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1452
1560
|
* @returns {Promise} - The promise which resolves to an array.
|
|
@@ -1474,9 +1582,9 @@ export declare class ChatServiceClient {
|
|
|
1474
1582
|
* Required. The resource name of the space to list messages from.
|
|
1475
1583
|
*
|
|
1476
1584
|
* Format: `spaces/{space}`
|
|
1477
|
-
* @param {number} request.pageSize
|
|
1478
|
-
* The maximum number of messages returned. The service might return
|
|
1479
|
-
* messages than this value.
|
|
1585
|
+
* @param {number} [request.pageSize]
|
|
1586
|
+
* Optional. The maximum number of messages returned. The service might return
|
|
1587
|
+
* fewer messages than this value.
|
|
1480
1588
|
*
|
|
1481
1589
|
* If unspecified, at most 25 are returned.
|
|
1482
1590
|
*
|
|
@@ -1484,17 +1592,15 @@ export declare class ChatServiceClient {
|
|
|
1484
1592
|
* automatically changed to 1000.
|
|
1485
1593
|
*
|
|
1486
1594
|
* Negative values return an `INVALID_ARGUMENT` error.
|
|
1487
|
-
* @param {string} request.pageToken
|
|
1488
|
-
* Optional
|
|
1489
|
-
*
|
|
1490
|
-
* A page token received from a previous list messages call. Provide this
|
|
1491
|
-
* parameter to retrieve the subsequent page.
|
|
1595
|
+
* @param {string} [request.pageToken]
|
|
1596
|
+
* Optional. A page token received from a previous list messages call. Provide
|
|
1597
|
+
* this parameter to retrieve the subsequent page.
|
|
1492
1598
|
*
|
|
1493
1599
|
* When paginating, all other parameters provided should match the call that
|
|
1494
1600
|
* provided the page token. Passing different values to the other parameters
|
|
1495
1601
|
* might lead to unexpected results.
|
|
1496
|
-
* @param {string} request.filter
|
|
1497
|
-
* A query filter.
|
|
1602
|
+
* @param {string} [request.filter]
|
|
1603
|
+
* Optional. A query filter.
|
|
1498
1604
|
*
|
|
1499
1605
|
* You can filter messages by date (`create_time`) and thread (`thread.name`).
|
|
1500
1606
|
*
|
|
@@ -1531,20 +1637,19 @@ export declare class ChatServiceClient {
|
|
|
1531
1637
|
*
|
|
1532
1638
|
* Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
|
|
1533
1639
|
* error.
|
|
1534
|
-
* @param {string} request.orderBy
|
|
1535
|
-
* Optional
|
|
1536
|
-
*
|
|
1537
|
-
* How the list of messages is ordered. Specify a value to order by an
|
|
1538
|
-
* ordering operation. Valid ordering operation values are as follows:
|
|
1640
|
+
* @param {string} [request.orderBy]
|
|
1641
|
+
* Optional. How the list of messages is ordered. Specify a value to order by
|
|
1642
|
+
* an ordering operation. Valid ordering operation values are as follows:
|
|
1539
1643
|
*
|
|
1540
1644
|
* - `ASC` for ascending.
|
|
1541
1645
|
*
|
|
1542
1646
|
* - `DESC` for descending.
|
|
1543
1647
|
*
|
|
1544
1648
|
* The default ordering is `create_time ASC`.
|
|
1545
|
-
* @param {boolean} request.showDeleted
|
|
1546
|
-
* Whether to include deleted messages. Deleted messages include
|
|
1547
|
-
* and metadata about their deletion, but message content is
|
|
1649
|
+
* @param {boolean} [request.showDeleted]
|
|
1650
|
+
* Optional. Whether to include deleted messages. Deleted messages include
|
|
1651
|
+
* deleted time and metadata about their deletion, but message content is
|
|
1652
|
+
* unavailable.
|
|
1548
1653
|
* @param {object} [options]
|
|
1549
1654
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1550
1655
|
* @returns {Stream}
|
|
@@ -1567,9 +1672,9 @@ export declare class ChatServiceClient {
|
|
|
1567
1672
|
* Required. The resource name of the space to list messages from.
|
|
1568
1673
|
*
|
|
1569
1674
|
* Format: `spaces/{space}`
|
|
1570
|
-
* @param {number} request.pageSize
|
|
1571
|
-
* The maximum number of messages returned. The service might return
|
|
1572
|
-
* messages than this value.
|
|
1675
|
+
* @param {number} [request.pageSize]
|
|
1676
|
+
* Optional. The maximum number of messages returned. The service might return
|
|
1677
|
+
* fewer messages than this value.
|
|
1573
1678
|
*
|
|
1574
1679
|
* If unspecified, at most 25 are returned.
|
|
1575
1680
|
*
|
|
@@ -1577,17 +1682,15 @@ export declare class ChatServiceClient {
|
|
|
1577
1682
|
* automatically changed to 1000.
|
|
1578
1683
|
*
|
|
1579
1684
|
* Negative values return an `INVALID_ARGUMENT` error.
|
|
1580
|
-
* @param {string} request.pageToken
|
|
1581
|
-
* Optional
|
|
1582
|
-
*
|
|
1583
|
-
* A page token received from a previous list messages call. Provide this
|
|
1584
|
-
* parameter to retrieve the subsequent page.
|
|
1685
|
+
* @param {string} [request.pageToken]
|
|
1686
|
+
* Optional. A page token received from a previous list messages call. Provide
|
|
1687
|
+
* this parameter to retrieve the subsequent page.
|
|
1585
1688
|
*
|
|
1586
1689
|
* When paginating, all other parameters provided should match the call that
|
|
1587
1690
|
* provided the page token. Passing different values to the other parameters
|
|
1588
1691
|
* might lead to unexpected results.
|
|
1589
|
-
* @param {string} request.filter
|
|
1590
|
-
* A query filter.
|
|
1692
|
+
* @param {string} [request.filter]
|
|
1693
|
+
* Optional. A query filter.
|
|
1591
1694
|
*
|
|
1592
1695
|
* You can filter messages by date (`create_time`) and thread (`thread.name`).
|
|
1593
1696
|
*
|
|
@@ -1624,20 +1727,19 @@ export declare class ChatServiceClient {
|
|
|
1624
1727
|
*
|
|
1625
1728
|
* Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
|
|
1626
1729
|
* error.
|
|
1627
|
-
* @param {string} request.orderBy
|
|
1628
|
-
* Optional
|
|
1629
|
-
*
|
|
1630
|
-
* How the list of messages is ordered. Specify a value to order by an
|
|
1631
|
-
* ordering operation. Valid ordering operation values are as follows:
|
|
1730
|
+
* @param {string} [request.orderBy]
|
|
1731
|
+
* Optional. How the list of messages is ordered. Specify a value to order by
|
|
1732
|
+
* an ordering operation. Valid ordering operation values are as follows:
|
|
1632
1733
|
*
|
|
1633
1734
|
* - `ASC` for ascending.
|
|
1634
1735
|
*
|
|
1635
1736
|
* - `DESC` for descending.
|
|
1636
1737
|
*
|
|
1637
1738
|
* The default ordering is `create_time ASC`.
|
|
1638
|
-
* @param {boolean} request.showDeleted
|
|
1639
|
-
* Whether to include deleted messages. Deleted messages include
|
|
1640
|
-
* and metadata about their deletion, but message content is
|
|
1739
|
+
* @param {boolean} [request.showDeleted]
|
|
1740
|
+
* Optional. Whether to include deleted messages. Deleted messages include
|
|
1741
|
+
* deleted time and metadata about their deletion, but message content is
|
|
1742
|
+
* unavailable.
|
|
1641
1743
|
* @param {object} [options]
|
|
1642
1744
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1643
1745
|
* @returns {Object}
|
|
@@ -1664,13 +1766,16 @@ export declare class ChatServiceClient {
|
|
|
1664
1766
|
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
|
1665
1767
|
* lists memberships in spaces that the authenticated user has access to.
|
|
1666
1768
|
*
|
|
1667
|
-
*
|
|
1668
|
-
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize)
|
|
1669
|
-
*
|
|
1670
|
-
* [
|
|
1769
|
+
* Supports the following types of
|
|
1770
|
+
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
|
|
1771
|
+
*
|
|
1772
|
+
* - [App
|
|
1671
1773
|
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
1672
|
-
*
|
|
1673
|
-
*
|
|
1774
|
+
*
|
|
1775
|
+
* - [User
|
|
1776
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
|
1777
|
+
* You can authenticate and authorize this method with administrator
|
|
1778
|
+
* privileges by setting the `use_admin_access` field in the request.
|
|
1674
1779
|
*
|
|
1675
1780
|
* @param {Object} request
|
|
1676
1781
|
* The request object that will be sent.
|
|
@@ -1751,8 +1856,8 @@ export declare class ChatServiceClient {
|
|
|
1751
1856
|
*
|
|
1752
1857
|
* Currently requires [user
|
|
1753
1858
|
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
1754
|
-
* @param {boolean} request.useAdminAccess
|
|
1755
|
-
* When `true`, the method runs using the user's Google Workspace
|
|
1859
|
+
* @param {boolean} [request.useAdminAccess]
|
|
1860
|
+
* Optional. When `true`, the method runs using the user's Google Workspace
|
|
1756
1861
|
* administrator privileges.
|
|
1757
1862
|
*
|
|
1758
1863
|
* The calling user must be a Google Workspace administrator with the
|
|
@@ -1864,8 +1969,8 @@ export declare class ChatServiceClient {
|
|
|
1864
1969
|
*
|
|
1865
1970
|
* Currently requires [user
|
|
1866
1971
|
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
1867
|
-
* @param {boolean} request.useAdminAccess
|
|
1868
|
-
* When `true`, the method runs using the user's Google Workspace
|
|
1972
|
+
* @param {boolean} [request.useAdminAccess]
|
|
1973
|
+
* Optional. When `true`, the method runs using the user's Google Workspace
|
|
1869
1974
|
* administrator privileges.
|
|
1870
1975
|
*
|
|
1871
1976
|
* The calling user must be a Google Workspace administrator with the
|
|
@@ -1972,8 +2077,8 @@ export declare class ChatServiceClient {
|
|
|
1972
2077
|
*
|
|
1973
2078
|
* Currently requires [user
|
|
1974
2079
|
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
1975
|
-
* @param {boolean} request.useAdminAccess
|
|
1976
|
-
* When `true`, the method runs using the user's Google Workspace
|
|
2080
|
+
* @param {boolean} [request.useAdminAccess]
|
|
2081
|
+
* Optional. When `true`, the method runs using the user's Google Workspace
|
|
1977
2082
|
* administrator privileges.
|
|
1978
2083
|
*
|
|
1979
2084
|
* The calling user must be a Google Workspace administrator with the
|
|
@@ -2004,16 +2109,14 @@ export declare class ChatServiceClient {
|
|
|
2004
2109
|
* [List
|
|
2005
2110
|
* spaces](https://developers.google.com/workspace/chat/list-spaces).
|
|
2006
2111
|
*
|
|
2007
|
-
*
|
|
2008
|
-
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize)
|
|
2009
|
-
*
|
|
2010
|
-
* [
|
|
2112
|
+
* Supports the following types of
|
|
2113
|
+
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
|
|
2114
|
+
*
|
|
2115
|
+
* - [App
|
|
2011
2116
|
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
2012
|
-
* and [user
|
|
2013
|
-
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
2014
2117
|
*
|
|
2015
|
-
*
|
|
2016
|
-
*
|
|
2118
|
+
* - [User
|
|
2119
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
|
2017
2120
|
*
|
|
2018
2121
|
* To list all named spaces by Google Workspace organization, use the
|
|
2019
2122
|
* [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search)
|
|
@@ -2185,7 +2288,9 @@ export declare class ChatServiceClient {
|
|
|
2185
2288
|
listSpacesAsync(request?: protos.google.chat.v1.IListSpacesRequest, options?: CallOptions): AsyncIterable<protos.google.chat.v1.ISpace>;
|
|
2186
2289
|
/**
|
|
2187
2290
|
* Returns a list of spaces in a Google Workspace organization based on an
|
|
2188
|
-
* administrator's search.
|
|
2291
|
+
* administrator's search.
|
|
2292
|
+
*
|
|
2293
|
+
* Requires [user
|
|
2189
2294
|
* authentication with administrator
|
|
2190
2295
|
* privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges).
|
|
2191
2296
|
* In the request, set `use_admin_access` to `true`.
|
|
@@ -2619,6 +2724,7 @@ export declare class ChatServiceClient {
|
|
|
2619
2724
|
* Lists reactions to a message. For an example, see
|
|
2620
2725
|
* [List reactions for a
|
|
2621
2726
|
* message](https://developers.google.com/workspace/chat/list-reactions).
|
|
2727
|
+
*
|
|
2622
2728
|
* Requires [user
|
|
2623
2729
|
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
2624
2730
|
*
|
|
@@ -2885,14 +2991,14 @@ export declare class ChatServiceClient {
|
|
|
2885
2991
|
* where the events occurred.
|
|
2886
2992
|
*
|
|
2887
2993
|
* Format: `spaces/{space}`.
|
|
2888
|
-
* @param {number} request.pageSize
|
|
2994
|
+
* @param {number} [request.pageSize]
|
|
2889
2995
|
* Optional. The maximum number of space events returned. The service might
|
|
2890
2996
|
* return fewer than this value.
|
|
2891
2997
|
*
|
|
2892
2998
|
* Negative values return an `INVALID_ARGUMENT` error.
|
|
2893
|
-
* @param {string} request.pageToken
|
|
2894
|
-
* A page token, received from a previous list space events call.
|
|
2895
|
-
* to retrieve the subsequent page.
|
|
2999
|
+
* @param {string} [request.pageToken]
|
|
3000
|
+
* Optional. A page token, received from a previous list space events call.
|
|
3001
|
+
* Provide this to retrieve the subsequent page.
|
|
2896
3002
|
*
|
|
2897
3003
|
* When paginating, all other parameters provided to list space events must
|
|
2898
3004
|
* match the call that provided the page token. Passing different values to
|
|
@@ -2979,14 +3085,14 @@ export declare class ChatServiceClient {
|
|
|
2979
3085
|
* where the events occurred.
|
|
2980
3086
|
*
|
|
2981
3087
|
* Format: `spaces/{space}`.
|
|
2982
|
-
* @param {number} request.pageSize
|
|
3088
|
+
* @param {number} [request.pageSize]
|
|
2983
3089
|
* Optional. The maximum number of space events returned. The service might
|
|
2984
3090
|
* return fewer than this value.
|
|
2985
3091
|
*
|
|
2986
3092
|
* Negative values return an `INVALID_ARGUMENT` error.
|
|
2987
|
-
* @param {string} request.pageToken
|
|
2988
|
-
* A page token, received from a previous list space events call.
|
|
2989
|
-
* to retrieve the subsequent page.
|
|
3093
|
+
* @param {string} [request.pageToken]
|
|
3094
|
+
* Optional. A page token, received from a previous list space events call.
|
|
3095
|
+
* Provide this to retrieve the subsequent page.
|
|
2990
3096
|
*
|
|
2991
3097
|
* When paginating, all other parameters provided to list space events must
|
|
2992
3098
|
* match the call that provided the page token. Passing different values to
|
|
@@ -3068,14 +3174,14 @@ export declare class ChatServiceClient {
|
|
|
3068
3174
|
* where the events occurred.
|
|
3069
3175
|
*
|
|
3070
3176
|
* Format: `spaces/{space}`.
|
|
3071
|
-
* @param {number} request.pageSize
|
|
3177
|
+
* @param {number} [request.pageSize]
|
|
3072
3178
|
* Optional. The maximum number of space events returned. The service might
|
|
3073
3179
|
* return fewer than this value.
|
|
3074
3180
|
*
|
|
3075
3181
|
* Negative values return an `INVALID_ARGUMENT` error.
|
|
3076
|
-
* @param {string} request.pageToken
|
|
3077
|
-
* A page token, received from a previous list space events call.
|
|
3078
|
-
* to retrieve the subsequent page.
|
|
3182
|
+
* @param {string} [request.pageToken]
|
|
3183
|
+
* Optional. A page token, received from a previous list space events call.
|
|
3184
|
+
* Provide this to retrieve the subsequent page.
|
|
3079
3185
|
*
|
|
3080
3186
|
* When paginating, all other parameters provided to list space events must
|
|
3081
3187
|
* match the call that provided the page token. Passing different values to
|