@google-apps/chat 0.15.0 → 0.16.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/README.md +6 -2
- package/build/protos/google/chat/v1/chat_service.proto +81 -0
- package/build/protos/google/chat/v1/reaction.proto +148 -3
- package/build/protos/protos.d.ts +730 -40
- package/build/protos/protos.js +2553 -552
- package/build/protos/protos.json +269 -17
- package/build/src/v1/chat_service_client.d.ts +916 -636
- package/build/src/v1/chat_service_client.js +591 -365
- package/build/src/v1/chat_service_client.js.map +1 -1
- package/build/src/v1/chat_service_client_config.json +20 -0
- package/build/src/v1/gapic_metadata.json +44 -0
- package/package.json +4 -4
- package/CHANGELOG.md +0 -119
|
@@ -1284,6 +1284,121 @@ export declare class ChatServiceClient {
|
|
|
1284
1284
|
]>;
|
|
1285
1285
|
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;
|
|
1286
1286
|
deleteReaction(request: protos.google.chat.v1.IDeleteReactionRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.chat.v1.IDeleteReactionRequest | null | undefined, {} | null | undefined>): void;
|
|
1287
|
+
/**
|
|
1288
|
+
* Creates a custom emoji.
|
|
1289
|
+
*
|
|
1290
|
+
* Custom emojis are only available for Google Workspace accounts, and the
|
|
1291
|
+
* administrator must turn custom emojis on for the organization. For more
|
|
1292
|
+
* information, see [Learn about custom emojis in Google
|
|
1293
|
+
* Chat](https://support.google.com/chat/answer/12800149) and
|
|
1294
|
+
* [Manage custom emoji
|
|
1295
|
+
* permissions](https://support.google.com/a/answer/12850085).
|
|
1296
|
+
*
|
|
1297
|
+
* Requires [user
|
|
1298
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
1299
|
+
*
|
|
1300
|
+
* @param {Object} request
|
|
1301
|
+
* The request object that will be sent.
|
|
1302
|
+
* @param {google.chat.v1.CustomEmoji} request.customEmoji
|
|
1303
|
+
* Required. The custom emoji to create.
|
|
1304
|
+
* @param {object} [options]
|
|
1305
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1306
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
1307
|
+
* The first element of the array is an object representing {@link protos.google.chat.v1.CustomEmoji|CustomEmoji}.
|
|
1308
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
1309
|
+
* for more details and examples.
|
|
1310
|
+
* @example <caption>include:samples/generated/v1/chat_service.create_custom_emoji.js</caption>
|
|
1311
|
+
* region_tag:chat_v1_generated_ChatService_CreateCustomEmoji_async
|
|
1312
|
+
*/
|
|
1313
|
+
createCustomEmoji(request?: protos.google.chat.v1.ICreateCustomEmojiRequest, options?: CallOptions): Promise<[
|
|
1314
|
+
protos.google.chat.v1.ICustomEmoji,
|
|
1315
|
+
protos.google.chat.v1.ICreateCustomEmojiRequest | undefined,
|
|
1316
|
+
{} | undefined
|
|
1317
|
+
]>;
|
|
1318
|
+
createCustomEmoji(request: protos.google.chat.v1.ICreateCustomEmojiRequest, options: CallOptions, callback: Callback<protos.google.chat.v1.ICustomEmoji, protos.google.chat.v1.ICreateCustomEmojiRequest | null | undefined, {} | null | undefined>): void;
|
|
1319
|
+
createCustomEmoji(request: protos.google.chat.v1.ICreateCustomEmojiRequest, callback: Callback<protos.google.chat.v1.ICustomEmoji, protos.google.chat.v1.ICreateCustomEmojiRequest | null | undefined, {} | null | undefined>): void;
|
|
1320
|
+
/**
|
|
1321
|
+
* Returns details about a custom emoji.
|
|
1322
|
+
*
|
|
1323
|
+
* Custom emojis are only available for Google Workspace accounts, and the
|
|
1324
|
+
* administrator must turn custom emojis on for the organization. For more
|
|
1325
|
+
* information, see [Learn about custom emojis in Google
|
|
1326
|
+
* Chat](https://support.google.com/chat/answer/12800149) and
|
|
1327
|
+
* [Manage custom emoji
|
|
1328
|
+
* permissions](https://support.google.com/a/answer/12850085).
|
|
1329
|
+
*
|
|
1330
|
+
* Requires [user
|
|
1331
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
1332
|
+
*
|
|
1333
|
+
* @param {Object} request
|
|
1334
|
+
* The request object that will be sent.
|
|
1335
|
+
* @param {string} request.name
|
|
1336
|
+
* Required. Resource name of the custom emoji.
|
|
1337
|
+
*
|
|
1338
|
+
* Format: `customEmojis/{customEmoji}`
|
|
1339
|
+
*
|
|
1340
|
+
* You can use the emoji name as an alias for `{customEmoji}`. For example,
|
|
1341
|
+
* `customEmojis/:example-emoji:` where `:example-emoji:` is the emoji name
|
|
1342
|
+
* for a custom emoji.
|
|
1343
|
+
* @param {object} [options]
|
|
1344
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1345
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
1346
|
+
* The first element of the array is an object representing {@link protos.google.chat.v1.CustomEmoji|CustomEmoji}.
|
|
1347
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
1348
|
+
* for more details and examples.
|
|
1349
|
+
* @example <caption>include:samples/generated/v1/chat_service.get_custom_emoji.js</caption>
|
|
1350
|
+
* region_tag:chat_v1_generated_ChatService_GetCustomEmoji_async
|
|
1351
|
+
*/
|
|
1352
|
+
getCustomEmoji(request?: protos.google.chat.v1.IGetCustomEmojiRequest, options?: CallOptions): Promise<[
|
|
1353
|
+
protos.google.chat.v1.ICustomEmoji,
|
|
1354
|
+
protos.google.chat.v1.IGetCustomEmojiRequest | undefined,
|
|
1355
|
+
{} | undefined
|
|
1356
|
+
]>;
|
|
1357
|
+
getCustomEmoji(request: protos.google.chat.v1.IGetCustomEmojiRequest, options: CallOptions, callback: Callback<protos.google.chat.v1.ICustomEmoji, protos.google.chat.v1.IGetCustomEmojiRequest | null | undefined, {} | null | undefined>): void;
|
|
1358
|
+
getCustomEmoji(request: protos.google.chat.v1.IGetCustomEmojiRequest, callback: Callback<protos.google.chat.v1.ICustomEmoji, protos.google.chat.v1.IGetCustomEmojiRequest | null | undefined, {} | null | undefined>): void;
|
|
1359
|
+
/**
|
|
1360
|
+
* Deletes a custom emoji. By default, users can only delete custom emoji they
|
|
1361
|
+
* created. [Emoji managers](https://support.google.com/a/answer/12850085)
|
|
1362
|
+
* assigned by the administrator can delete any custom emoji in the
|
|
1363
|
+
* organization. See [Learn about custom emojis in Google
|
|
1364
|
+
* Chat](https://support.google.com/chat/answer/12800149).
|
|
1365
|
+
*
|
|
1366
|
+
* Custom emojis are only available for Google Workspace accounts, and the
|
|
1367
|
+
* administrator must turn custom emojis on for the organization. For more
|
|
1368
|
+
* information, see [Learn about custom emojis in Google
|
|
1369
|
+
* Chat](https://support.google.com/chat/answer/12800149) and
|
|
1370
|
+
* [Manage custom emoji
|
|
1371
|
+
* permissions](https://support.google.com/a/answer/12850085).
|
|
1372
|
+
*
|
|
1373
|
+
* Requires [user
|
|
1374
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
1375
|
+
*
|
|
1376
|
+
* @param {Object} request
|
|
1377
|
+
* The request object that will be sent.
|
|
1378
|
+
* @param {string} request.name
|
|
1379
|
+
* Required. Resource name of the custom emoji to delete.
|
|
1380
|
+
*
|
|
1381
|
+
* Format: `customEmojis/{customEmoji}`
|
|
1382
|
+
*
|
|
1383
|
+
* You can use the emoji name as an alias for `{customEmoji}`. For example,
|
|
1384
|
+
* `customEmojis/:example-emoji:` where `:example-emoji:` is the emoji name
|
|
1385
|
+
* for a custom emoji.
|
|
1386
|
+
* @param {object} [options]
|
|
1387
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1388
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
1389
|
+
* The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
|
|
1390
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
1391
|
+
* for more details and examples.
|
|
1392
|
+
* @example <caption>include:samples/generated/v1/chat_service.delete_custom_emoji.js</caption>
|
|
1393
|
+
* region_tag:chat_v1_generated_ChatService_DeleteCustomEmoji_async
|
|
1394
|
+
*/
|
|
1395
|
+
deleteCustomEmoji(request?: protos.google.chat.v1.IDeleteCustomEmojiRequest, options?: CallOptions): Promise<[
|
|
1396
|
+
protos.google.protobuf.IEmpty,
|
|
1397
|
+
protos.google.chat.v1.IDeleteCustomEmojiRequest | undefined,
|
|
1398
|
+
{} | undefined
|
|
1399
|
+
]>;
|
|
1400
|
+
deleteCustomEmoji(request: protos.google.chat.v1.IDeleteCustomEmojiRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.chat.v1.IDeleteCustomEmojiRequest | null | undefined, {} | null | undefined>): void;
|
|
1401
|
+
deleteCustomEmoji(request: protos.google.chat.v1.IDeleteCustomEmojiRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.chat.v1.IDeleteCustomEmojiRequest | null | undefined, {} | null | undefined>): void;
|
|
1287
1402
|
/**
|
|
1288
1403
|
* Returns details about a user's read state within a space, used to identify
|
|
1289
1404
|
* read and unread messages. For an example, see [Get details about a user's
|
|
@@ -1539,103 +1654,103 @@ export declare class ChatServiceClient {
|
|
|
1539
1654
|
updateSpaceNotificationSetting(request: protos.google.chat.v1.IUpdateSpaceNotificationSettingRequest, options: CallOptions, callback: Callback<protos.google.chat.v1.ISpaceNotificationSetting, protos.google.chat.v1.IUpdateSpaceNotificationSettingRequest | null | undefined, {} | null | undefined>): void;
|
|
1540
1655
|
updateSpaceNotificationSetting(request: protos.google.chat.v1.IUpdateSpaceNotificationSettingRequest, callback: Callback<protos.google.chat.v1.ISpaceNotificationSetting, protos.google.chat.v1.IUpdateSpaceNotificationSettingRequest | null | undefined, {} | null | undefined>): void;
|
|
1541
1656
|
/**
|
|
1542
|
-
|
|
1543
|
-
|
|
1544
|
-
|
|
1545
|
-
|
|
1546
|
-
|
|
1547
|
-
|
|
1548
|
-
|
|
1549
|
-
|
|
1550
|
-
|
|
1551
|
-
|
|
1552
|
-
|
|
1553
|
-
|
|
1554
|
-
|
|
1555
|
-
|
|
1556
|
-
|
|
1557
|
-
|
|
1558
|
-
|
|
1559
|
-
|
|
1560
|
-
|
|
1561
|
-
|
|
1562
|
-
|
|
1563
|
-
|
|
1564
|
-
|
|
1565
|
-
|
|
1566
|
-
|
|
1567
|
-
|
|
1568
|
-
|
|
1569
|
-
|
|
1570
|
-
|
|
1571
|
-
|
|
1572
|
-
|
|
1573
|
-
|
|
1574
|
-
|
|
1575
|
-
|
|
1576
|
-
|
|
1577
|
-
|
|
1578
|
-
|
|
1579
|
-
|
|
1580
|
-
|
|
1581
|
-
|
|
1582
|
-
|
|
1583
|
-
|
|
1584
|
-
|
|
1585
|
-
|
|
1586
|
-
|
|
1587
|
-
|
|
1588
|
-
|
|
1589
|
-
|
|
1590
|
-
|
|
1591
|
-
|
|
1592
|
-
|
|
1593
|
-
|
|
1594
|
-
|
|
1595
|
-
|
|
1596
|
-
|
|
1597
|
-
|
|
1598
|
-
|
|
1599
|
-
|
|
1600
|
-
|
|
1601
|
-
|
|
1602
|
-
|
|
1603
|
-
|
|
1604
|
-
|
|
1605
|
-
|
|
1606
|
-
|
|
1607
|
-
|
|
1608
|
-
|
|
1609
|
-
|
|
1610
|
-
|
|
1611
|
-
|
|
1612
|
-
|
|
1613
|
-
|
|
1614
|
-
|
|
1615
|
-
|
|
1616
|
-
|
|
1617
|
-
|
|
1618
|
-
|
|
1619
|
-
|
|
1620
|
-
|
|
1621
|
-
|
|
1622
|
-
|
|
1623
|
-
|
|
1624
|
-
|
|
1625
|
-
|
|
1626
|
-
|
|
1627
|
-
|
|
1628
|
-
|
|
1629
|
-
|
|
1630
|
-
|
|
1631
|
-
|
|
1632
|
-
|
|
1633
|
-
|
|
1634
|
-
|
|
1635
|
-
|
|
1636
|
-
|
|
1637
|
-
|
|
1638
|
-
|
|
1657
|
+
* Lists messages in a space that the caller is a member of, including
|
|
1658
|
+
* messages from blocked members and spaces. If you list messages from a
|
|
1659
|
+
* space with no messages, the response is an empty object. When using a
|
|
1660
|
+
* REST/HTTP interface, the response contains an empty JSON object, `{}`.
|
|
1661
|
+
* For an example, see
|
|
1662
|
+
* [List
|
|
1663
|
+
* messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list).
|
|
1664
|
+
*
|
|
1665
|
+
* Requires [user
|
|
1666
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
1667
|
+
*
|
|
1668
|
+
* @param {Object} request
|
|
1669
|
+
* The request object that will be sent.
|
|
1670
|
+
* @param {string} request.parent
|
|
1671
|
+
* Required. The resource name of the space to list messages from.
|
|
1672
|
+
*
|
|
1673
|
+
* Format: `spaces/{space}`
|
|
1674
|
+
* @param {number} [request.pageSize]
|
|
1675
|
+
* Optional. The maximum number of messages returned. The service might return
|
|
1676
|
+
* fewer messages than this value.
|
|
1677
|
+
*
|
|
1678
|
+
* If unspecified, at most 25 are returned.
|
|
1679
|
+
*
|
|
1680
|
+
* The maximum value is 1000. If you use a value more than 1000, it's
|
|
1681
|
+
* automatically changed to 1000.
|
|
1682
|
+
*
|
|
1683
|
+
* Negative values return an `INVALID_ARGUMENT` error.
|
|
1684
|
+
* @param {string} [request.pageToken]
|
|
1685
|
+
* Optional. A page token received from a previous list messages call. Provide
|
|
1686
|
+
* this parameter to retrieve the subsequent page.
|
|
1687
|
+
*
|
|
1688
|
+
* When paginating, all other parameters provided should match the call that
|
|
1689
|
+
* provided the page token. Passing different values to the other parameters
|
|
1690
|
+
* might lead to unexpected results.
|
|
1691
|
+
* @param {string} [request.filter]
|
|
1692
|
+
* Optional. A query filter.
|
|
1693
|
+
*
|
|
1694
|
+
* You can filter messages by date (`create_time`) and thread (`thread.name`).
|
|
1695
|
+
*
|
|
1696
|
+
* To filter messages by the date they were created, specify the `create_time`
|
|
1697
|
+
* with a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339)
|
|
1698
|
+
* format and double quotation marks. For example,
|
|
1699
|
+
* `"2023-04-21T11:30:00-04:00"`. You can use the greater than operator `>` to
|
|
1700
|
+
* list messages that were created after a timestamp, or the less than
|
|
1701
|
+
* operator `<` to list messages that were created before a timestamp. To
|
|
1702
|
+
* filter messages within a time interval, use the `AND` operator between two
|
|
1703
|
+
* timestamps.
|
|
1704
|
+
*
|
|
1705
|
+
* To filter by thread, specify the `thread.name`, formatted as
|
|
1706
|
+
* `spaces/{space}/threads/{thread}`. You can only specify one
|
|
1707
|
+
* `thread.name` per query.
|
|
1708
|
+
*
|
|
1709
|
+
* To filter by both thread and date, use the `AND` operator in your query.
|
|
1710
|
+
*
|
|
1711
|
+
* For example, the following queries are valid:
|
|
1712
|
+
*
|
|
1713
|
+
* ```
|
|
1714
|
+
* create_time > "2012-04-21T11:30:00-04:00"
|
|
1715
|
+
*
|
|
1716
|
+
* create_time > "2012-04-21T11:30:00-04:00" AND
|
|
1717
|
+
* thread.name = spaces/AAAAAAAAAAA/threads/123
|
|
1718
|
+
*
|
|
1719
|
+
* create_time > "2012-04-21T11:30:00+00:00" AND
|
|
1720
|
+
*
|
|
1721
|
+
* create_time < "2013-01-01T00:00:00+00:00" AND
|
|
1722
|
+
* thread.name = spaces/AAAAAAAAAAA/threads/123
|
|
1723
|
+
*
|
|
1724
|
+
* thread.name = spaces/AAAAAAAAAAA/threads/123
|
|
1725
|
+
* ```
|
|
1726
|
+
*
|
|
1727
|
+
* Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
|
|
1728
|
+
* error.
|
|
1729
|
+
* @param {string} [request.orderBy]
|
|
1730
|
+
* Optional. How the list of messages is ordered. Specify a value to order by
|
|
1731
|
+
* an ordering operation. Valid ordering operation values are as follows:
|
|
1732
|
+
*
|
|
1733
|
+
* - `ASC` for ascending.
|
|
1734
|
+
*
|
|
1735
|
+
* - `DESC` for descending.
|
|
1736
|
+
*
|
|
1737
|
+
* The default ordering is `create_time ASC`.
|
|
1738
|
+
* @param {boolean} [request.showDeleted]
|
|
1739
|
+
* Optional. Whether to include deleted messages. Deleted messages include
|
|
1740
|
+
* deleted time and metadata about their deletion, but message content is
|
|
1741
|
+
* unavailable.
|
|
1742
|
+
* @param {object} [options]
|
|
1743
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1744
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
1745
|
+
* The first element of the array is Array of {@link protos.google.chat.v1.Message|Message}.
|
|
1746
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
1747
|
+
* times as needed and will merge results from all the pages into this array.
|
|
1748
|
+
* Note that it can affect your quota.
|
|
1749
|
+
* We recommend using `listMessagesAsync()`
|
|
1750
|
+
* method described below for async iteration which you can stop as needed.
|
|
1751
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
1752
|
+
* for more details and examples.
|
|
1753
|
+
*/
|
|
1639
1754
|
listMessages(request?: protos.google.chat.v1.IListMessagesRequest, options?: CallOptions): Promise<[
|
|
1640
1755
|
protos.google.chat.v1.IMessage[],
|
|
1641
1756
|
protos.google.chat.v1.IListMessagesRequest | null,
|
|
@@ -1823,133 +1938,133 @@ export declare class ChatServiceClient {
|
|
|
1823
1938
|
*/
|
|
1824
1939
|
listMessagesAsync(request?: protos.google.chat.v1.IListMessagesRequest, options?: CallOptions): AsyncIterable<protos.google.chat.v1.IMessage>;
|
|
1825
1940
|
/**
|
|
1826
|
-
|
|
1827
|
-
|
|
1828
|
-
|
|
1829
|
-
|
|
1830
|
-
|
|
1831
|
-
|
|
1832
|
-
|
|
1833
|
-
|
|
1834
|
-
|
|
1835
|
-
|
|
1836
|
-
|
|
1837
|
-
|
|
1838
|
-
|
|
1839
|
-
|
|
1840
|
-
|
|
1841
|
-
|
|
1842
|
-
|
|
1843
|
-
|
|
1844
|
-
|
|
1845
|
-
|
|
1846
|
-
|
|
1847
|
-
|
|
1848
|
-
|
|
1849
|
-
|
|
1850
|
-
|
|
1851
|
-
|
|
1852
|
-
|
|
1853
|
-
|
|
1854
|
-
|
|
1855
|
-
|
|
1856
|
-
|
|
1857
|
-
|
|
1858
|
-
|
|
1859
|
-
|
|
1860
|
-
|
|
1861
|
-
|
|
1862
|
-
|
|
1863
|
-
|
|
1864
|
-
|
|
1865
|
-
|
|
1866
|
-
|
|
1867
|
-
|
|
1868
|
-
|
|
1869
|
-
|
|
1870
|
-
|
|
1871
|
-
|
|
1872
|
-
|
|
1873
|
-
|
|
1874
|
-
|
|
1875
|
-
|
|
1876
|
-
|
|
1877
|
-
|
|
1878
|
-
|
|
1879
|
-
|
|
1880
|
-
|
|
1881
|
-
|
|
1882
|
-
|
|
1883
|
-
|
|
1884
|
-
|
|
1885
|
-
|
|
1886
|
-
|
|
1887
|
-
|
|
1888
|
-
|
|
1889
|
-
|
|
1890
|
-
|
|
1891
|
-
|
|
1892
|
-
|
|
1893
|
-
|
|
1894
|
-
|
|
1895
|
-
|
|
1896
|
-
|
|
1897
|
-
|
|
1898
|
-
|
|
1899
|
-
|
|
1900
|
-
|
|
1901
|
-
|
|
1902
|
-
|
|
1903
|
-
|
|
1904
|
-
|
|
1905
|
-
|
|
1906
|
-
|
|
1907
|
-
|
|
1908
|
-
|
|
1909
|
-
|
|
1910
|
-
|
|
1911
|
-
|
|
1912
|
-
|
|
1913
|
-
|
|
1914
|
-
|
|
1915
|
-
|
|
1916
|
-
|
|
1917
|
-
|
|
1918
|
-
|
|
1919
|
-
|
|
1920
|
-
|
|
1921
|
-
|
|
1922
|
-
|
|
1923
|
-
|
|
1924
|
-
|
|
1925
|
-
|
|
1926
|
-
|
|
1927
|
-
|
|
1928
|
-
|
|
1929
|
-
|
|
1930
|
-
|
|
1931
|
-
|
|
1932
|
-
|
|
1933
|
-
|
|
1934
|
-
|
|
1935
|
-
|
|
1936
|
-
|
|
1937
|
-
|
|
1938
|
-
|
|
1939
|
-
|
|
1940
|
-
|
|
1941
|
-
|
|
1942
|
-
|
|
1943
|
-
|
|
1944
|
-
|
|
1945
|
-
|
|
1946
|
-
|
|
1947
|
-
|
|
1948
|
-
|
|
1949
|
-
|
|
1950
|
-
|
|
1951
|
-
|
|
1952
|
-
|
|
1941
|
+
* Lists memberships in a space. For an example, see [List users and Google
|
|
1942
|
+
* Chat apps in a
|
|
1943
|
+
* space](https://developers.google.com/workspace/chat/list-members). Listing
|
|
1944
|
+
* memberships with [app
|
|
1945
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
1946
|
+
* lists memberships in spaces that the Chat app has
|
|
1947
|
+
* access to, but excludes Chat app memberships,
|
|
1948
|
+
* including its own. Listing memberships with
|
|
1949
|
+
* [User
|
|
1950
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
|
1951
|
+
* lists memberships in spaces that the authenticated user has access to.
|
|
1952
|
+
*
|
|
1953
|
+
* Supports the following types of
|
|
1954
|
+
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
|
|
1955
|
+
*
|
|
1956
|
+
* - [App
|
|
1957
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
1958
|
+
*
|
|
1959
|
+
* - [User
|
|
1960
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
|
1961
|
+
* You can authenticate and authorize this method with administrator
|
|
1962
|
+
* privileges by setting the `use_admin_access` field in the request.
|
|
1963
|
+
*
|
|
1964
|
+
* @param {Object} request
|
|
1965
|
+
* The request object that will be sent.
|
|
1966
|
+
* @param {string} request.parent
|
|
1967
|
+
* Required. The resource name of the space for which to fetch a membership
|
|
1968
|
+
* list.
|
|
1969
|
+
*
|
|
1970
|
+
* Format: spaces/{space}
|
|
1971
|
+
* @param {number} [request.pageSize]
|
|
1972
|
+
* Optional. The maximum number of memberships to return. The service might
|
|
1973
|
+
* return fewer than this value.
|
|
1974
|
+
*
|
|
1975
|
+
* If unspecified, at most 100 memberships are returned.
|
|
1976
|
+
*
|
|
1977
|
+
* The maximum value is 1000. If you use a value more than 1000, it's
|
|
1978
|
+
* automatically changed to 1000.
|
|
1979
|
+
*
|
|
1980
|
+
* Negative values return an `INVALID_ARGUMENT` error.
|
|
1981
|
+
* @param {string} [request.pageToken]
|
|
1982
|
+
* Optional. A page token, received from a previous call to list memberships.
|
|
1983
|
+
* Provide this parameter to retrieve the subsequent page.
|
|
1984
|
+
*
|
|
1985
|
+
* When paginating, all other parameters provided should match the call that
|
|
1986
|
+
* provided the page token. Passing different values to the other parameters
|
|
1987
|
+
* might lead to unexpected results.
|
|
1988
|
+
* @param {string} [request.filter]
|
|
1989
|
+
* Optional. A query filter.
|
|
1990
|
+
*
|
|
1991
|
+
* You can filter memberships by a member's role
|
|
1992
|
+
* ([`role`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole))
|
|
1993
|
+
* and type
|
|
1994
|
+
* ([`member.type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/User#type)).
|
|
1995
|
+
*
|
|
1996
|
+
* To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`.
|
|
1997
|
+
*
|
|
1998
|
+
* To filter by type, set `member.type` to `HUMAN` or `BOT`. You can also
|
|
1999
|
+
* filter for `member.type` using the `!=` operator.
|
|
2000
|
+
*
|
|
2001
|
+
* To filter by both role and type, use the `AND` operator. To filter by
|
|
2002
|
+
* either role or type, use the `OR` operator.
|
|
2003
|
+
*
|
|
2004
|
+
* Either `member.type = "HUMAN"` or `member.type != "BOT"` is required
|
|
2005
|
+
* when `use_admin_access` is set to true. Other member type filters will be
|
|
2006
|
+
* rejected.
|
|
2007
|
+
*
|
|
2008
|
+
* For example, the following queries are valid:
|
|
2009
|
+
*
|
|
2010
|
+
* ```
|
|
2011
|
+
* role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
|
|
2012
|
+
* member.type = "HUMAN" AND role = "ROLE_MANAGER"
|
|
2013
|
+
*
|
|
2014
|
+
* member.type != "BOT"
|
|
2015
|
+
* ```
|
|
2016
|
+
*
|
|
2017
|
+
* The following queries are invalid:
|
|
2018
|
+
*
|
|
2019
|
+
* ```
|
|
2020
|
+
* member.type = "HUMAN" AND member.type = "BOT"
|
|
2021
|
+
* role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"
|
|
2022
|
+
* ```
|
|
2023
|
+
*
|
|
2024
|
+
* Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
|
|
2025
|
+
* error.
|
|
2026
|
+
* @param {boolean} [request.showGroups]
|
|
2027
|
+
* Optional. When `true`, also returns memberships associated with a
|
|
2028
|
+
* {@link protos.google.chat.v1.Membership.group_member|Google Group}, in
|
|
2029
|
+
* addition to other types of memberships. If a
|
|
2030
|
+
* {@link protos.google.chat.v1.ListMembershipsRequest.filter|filter} is set,
|
|
2031
|
+
* {@link protos.google.chat.v1.Membership.group_member|Google Group}
|
|
2032
|
+
* memberships that don't match the filter criteria aren't returned.
|
|
2033
|
+
* @param {boolean} [request.showInvited]
|
|
2034
|
+
* Optional. When `true`, also returns memberships associated with
|
|
2035
|
+
* {@link protos.google.chat.v1.Membership.MembershipState.INVITED|invited} members, in
|
|
2036
|
+
* addition to other types of memberships. If a
|
|
2037
|
+
* filter is set,
|
|
2038
|
+
* {@link protos.google.chat.v1.Membership.MembershipState.INVITED|invited} memberships
|
|
2039
|
+
* that don't match the filter criteria aren't returned.
|
|
2040
|
+
*
|
|
2041
|
+
* Currently requires [user
|
|
2042
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
2043
|
+
* @param {boolean} [request.useAdminAccess]
|
|
2044
|
+
* Optional. When `true`, the method runs using the user's Google Workspace
|
|
2045
|
+
* administrator privileges.
|
|
2046
|
+
*
|
|
2047
|
+
* The calling user must be a Google Workspace administrator with the
|
|
2048
|
+
* [manage chat and spaces conversations
|
|
2049
|
+
* privilege](https://support.google.com/a/answer/13369245).
|
|
2050
|
+
*
|
|
2051
|
+
* Requires either the `chat.admin.memberships.readonly` or
|
|
2052
|
+
* `chat.admin.memberships` [OAuth 2.0
|
|
2053
|
+
* scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
|
|
2054
|
+
*
|
|
2055
|
+
* Listing app memberships in a space isn't supported when using admin access.
|
|
2056
|
+
* @param {object} [options]
|
|
2057
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
2058
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
2059
|
+
* The first element of the array is Array of {@link protos.google.chat.v1.Membership|Membership}.
|
|
2060
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
2061
|
+
* times as needed and will merge results from all the pages into this array.
|
|
2062
|
+
* Note that it can affect your quota.
|
|
2063
|
+
* We recommend using `listMembershipsAsync()`
|
|
2064
|
+
* method described below for async iteration which you can stop as needed.
|
|
2065
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
2066
|
+
* for more details and examples.
|
|
2067
|
+
*/
|
|
1953
2068
|
listMemberships(request?: protos.google.chat.v1.IListMembershipsRequest, options?: CallOptions): Promise<[
|
|
1954
2069
|
protos.google.chat.v1.IMembership[],
|
|
1955
2070
|
protos.google.chat.v1.IListMembershipsRequest | null,
|
|
@@ -2173,74 +2288,74 @@ export declare class ChatServiceClient {
|
|
|
2173
2288
|
*/
|
|
2174
2289
|
listMembershipsAsync(request?: protos.google.chat.v1.IListMembershipsRequest, options?: CallOptions): AsyncIterable<protos.google.chat.v1.IMembership>;
|
|
2175
2290
|
/**
|
|
2176
|
-
|
|
2177
|
-
|
|
2178
|
-
|
|
2179
|
-
|
|
2180
|
-
|
|
2181
|
-
|
|
2182
|
-
|
|
2183
|
-
|
|
2184
|
-
|
|
2185
|
-
|
|
2186
|
-
|
|
2187
|
-
|
|
2188
|
-
|
|
2189
|
-
|
|
2190
|
-
|
|
2191
|
-
|
|
2192
|
-
|
|
2193
|
-
|
|
2194
|
-
|
|
2195
|
-
|
|
2196
|
-
|
|
2197
|
-
|
|
2198
|
-
|
|
2199
|
-
|
|
2200
|
-
|
|
2201
|
-
|
|
2202
|
-
|
|
2203
|
-
|
|
2204
|
-
|
|
2205
|
-
|
|
2206
|
-
|
|
2207
|
-
|
|
2208
|
-
|
|
2209
|
-
|
|
2210
|
-
|
|
2211
|
-
|
|
2212
|
-
|
|
2213
|
-
|
|
2214
|
-
|
|
2215
|
-
|
|
2216
|
-
|
|
2217
|
-
|
|
2218
|
-
|
|
2219
|
-
|
|
2220
|
-
|
|
2221
|
-
|
|
2222
|
-
|
|
2223
|
-
|
|
2224
|
-
|
|
2225
|
-
|
|
2226
|
-
|
|
2227
|
-
|
|
2228
|
-
|
|
2229
|
-
|
|
2230
|
-
|
|
2231
|
-
|
|
2232
|
-
|
|
2233
|
-
|
|
2234
|
-
|
|
2235
|
-
|
|
2236
|
-
|
|
2237
|
-
|
|
2238
|
-
|
|
2239
|
-
|
|
2240
|
-
|
|
2241
|
-
|
|
2242
|
-
|
|
2243
|
-
|
|
2291
|
+
* Lists spaces the caller is a member of. Group chats and DMs aren't listed
|
|
2292
|
+
* until the first message is sent. For an example, see
|
|
2293
|
+
* [List
|
|
2294
|
+
* spaces](https://developers.google.com/workspace/chat/list-spaces).
|
|
2295
|
+
*
|
|
2296
|
+
* Supports the following types of
|
|
2297
|
+
* [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
|
|
2298
|
+
*
|
|
2299
|
+
* - [App
|
|
2300
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
|
2301
|
+
*
|
|
2302
|
+
* - [User
|
|
2303
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
|
2304
|
+
*
|
|
2305
|
+
* To list all named spaces by Google Workspace organization, use the
|
|
2306
|
+
* [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search)
|
|
2307
|
+
* method using Workspace administrator privileges instead.
|
|
2308
|
+
*
|
|
2309
|
+
* @param {Object} request
|
|
2310
|
+
* The request object that will be sent.
|
|
2311
|
+
* @param {number} [request.pageSize]
|
|
2312
|
+
* Optional. The maximum number of spaces to return. The service might return
|
|
2313
|
+
* fewer than this value.
|
|
2314
|
+
*
|
|
2315
|
+
* If unspecified, at most 100 spaces are returned.
|
|
2316
|
+
*
|
|
2317
|
+
* The maximum value is 1000. If you use a value more than 1000, it's
|
|
2318
|
+
* automatically changed to 1000.
|
|
2319
|
+
*
|
|
2320
|
+
* Negative values return an `INVALID_ARGUMENT` error.
|
|
2321
|
+
* @param {string} [request.pageToken]
|
|
2322
|
+
* Optional. A page token, received from a previous list spaces call.
|
|
2323
|
+
* Provide this parameter to retrieve the subsequent page.
|
|
2324
|
+
*
|
|
2325
|
+
* When paginating, the filter value should match the call that provided the
|
|
2326
|
+
* page token. Passing a different value may lead to unexpected results.
|
|
2327
|
+
* @param {string} [request.filter]
|
|
2328
|
+
* Optional. A query filter.
|
|
2329
|
+
*
|
|
2330
|
+
* You can filter spaces by the space type
|
|
2331
|
+
* ([`space_type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#spacetype)).
|
|
2332
|
+
*
|
|
2333
|
+
* To filter by space type, you must specify valid enum value, such as
|
|
2334
|
+
* `SPACE` or `GROUP_CHAT` (the `space_type` can't be
|
|
2335
|
+
* `SPACE_TYPE_UNSPECIFIED`). To query for multiple space types, use the `OR`
|
|
2336
|
+
* operator.
|
|
2337
|
+
*
|
|
2338
|
+
* For example, the following queries are valid:
|
|
2339
|
+
*
|
|
2340
|
+
* ```
|
|
2341
|
+
* space_type = "SPACE"
|
|
2342
|
+
* spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"
|
|
2343
|
+
* ```
|
|
2344
|
+
*
|
|
2345
|
+
* Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
|
|
2346
|
+
* error.
|
|
2347
|
+
* @param {object} [options]
|
|
2348
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
2349
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
2350
|
+
* The first element of the array is Array of {@link protos.google.chat.v1.Space|Space}.
|
|
2351
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
2352
|
+
* times as needed and will merge results from all the pages into this array.
|
|
2353
|
+
* Note that it can affect your quota.
|
|
2354
|
+
* We recommend using `listSpacesAsync()`
|
|
2355
|
+
* method described below for async iteration which you can stop as needed.
|
|
2356
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
2357
|
+
* for more details and examples.
|
|
2358
|
+
*/
|
|
2244
2359
|
listSpaces(request?: protos.google.chat.v1.IListSpacesRequest, options?: CallOptions): Promise<[
|
|
2245
2360
|
protos.google.chat.v1.ISpace[],
|
|
2246
2361
|
protos.google.chat.v1.IListSpacesRequest | null,
|
|
@@ -2310,197 +2425,197 @@ export declare class ChatServiceClient {
|
|
|
2310
2425
|
* Optional. The maximum number of spaces to return. The service might return
|
|
2311
2426
|
* fewer than this value.
|
|
2312
2427
|
*
|
|
2313
|
-
* If unspecified, at most 100 spaces are returned.
|
|
2314
|
-
*
|
|
2315
|
-
* The maximum value is 1000. If you use a value more than 1000, it's
|
|
2316
|
-
* automatically changed to 1000.
|
|
2317
|
-
*
|
|
2318
|
-
* Negative values return an `INVALID_ARGUMENT` error.
|
|
2319
|
-
* @param {string} [request.pageToken]
|
|
2320
|
-
* Optional. A page token, received from a previous list spaces call.
|
|
2321
|
-
* Provide this parameter to retrieve the subsequent page.
|
|
2322
|
-
*
|
|
2323
|
-
* When paginating, the filter value should match the call that provided the
|
|
2324
|
-
* page token. Passing a different value may lead to unexpected results.
|
|
2325
|
-
* @param {string} [request.filter]
|
|
2326
|
-
* Optional. A query filter.
|
|
2327
|
-
*
|
|
2328
|
-
* You can filter spaces by the space type
|
|
2329
|
-
* ([`space_type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#spacetype)).
|
|
2330
|
-
*
|
|
2331
|
-
* To filter by space type, you must specify valid enum value, such as
|
|
2332
|
-
* `SPACE` or `GROUP_CHAT` (the `space_type` can't be
|
|
2333
|
-
* `SPACE_TYPE_UNSPECIFIED`). To query for multiple space types, use the `OR`
|
|
2334
|
-
* operator.
|
|
2335
|
-
*
|
|
2336
|
-
* For example, the following queries are valid:
|
|
2337
|
-
*
|
|
2338
|
-
* ```
|
|
2339
|
-
* space_type = "SPACE"
|
|
2340
|
-
* spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"
|
|
2341
|
-
* ```
|
|
2342
|
-
*
|
|
2343
|
-
* Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
|
|
2344
|
-
* error.
|
|
2345
|
-
* @param {object} [options]
|
|
2346
|
-
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
2347
|
-
* @returns {Object}
|
|
2348
|
-
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
|
2349
|
-
* When you iterate the returned iterable, each element will be an object representing
|
|
2350
|
-
* {@link protos.google.chat.v1.Space|Space}. The API will be called under the hood as needed, once per the page,
|
|
2351
|
-
* so you can stop the iteration when you don't need more results.
|
|
2352
|
-
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
2353
|
-
* for more details and examples.
|
|
2354
|
-
* @example <caption>include:samples/generated/v1/chat_service.list_spaces.js</caption>
|
|
2355
|
-
* region_tag:chat_v1_generated_ChatService_ListSpaces_async
|
|
2356
|
-
*/
|
|
2357
|
-
listSpacesAsync(request?: protos.google.chat.v1.IListSpacesRequest, options?: CallOptions): AsyncIterable<protos.google.chat.v1.ISpace>;
|
|
2358
|
-
/**
|
|
2359
|
-
* Returns a list of spaces in a Google Workspace organization based on an
|
|
2360
|
-
* administrator's search.
|
|
2361
|
-
*
|
|
2362
|
-
* Requires [user
|
|
2363
|
-
* authentication with administrator
|
|
2364
|
-
* privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges).
|
|
2365
|
-
* In the request, set `use_admin_access` to `true`.
|
|
2366
|
-
*
|
|
2367
|
-
* @param {Object} request
|
|
2368
|
-
* The request object that will be sent.
|
|
2369
|
-
* @param {boolean} request.useAdminAccess
|
|
2370
|
-
* When `true`, the method runs using the user's Google Workspace
|
|
2371
|
-
* administrator privileges.
|
|
2372
|
-
*
|
|
2373
|
-
* The calling user must be a Google Workspace administrator with the
|
|
2374
|
-
* [manage chat and spaces conversations
|
|
2375
|
-
* privilege](https://support.google.com/a/answer/13369245).
|
|
2376
|
-
*
|
|
2377
|
-
* Requires either the `chat.admin.spaces.readonly` or `chat.admin.spaces`
|
|
2378
|
-
* [OAuth 2.0
|
|
2379
|
-
* scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
|
|
2380
|
-
*
|
|
2381
|
-
* This method currently only supports admin access, thus only `true` is
|
|
2382
|
-
* accepted for this field.
|
|
2383
|
-
* @param {number} request.pageSize
|
|
2384
|
-
* The maximum number of spaces to return. The service may return fewer than
|
|
2385
|
-
* this value.
|
|
2386
|
-
*
|
|
2387
|
-
* If unspecified, at most 100 spaces are returned.
|
|
2388
|
-
*
|
|
2389
|
-
* The maximum value is 1000. If you use a value more than 1000, it's
|
|
2390
|
-
* automatically changed to 1000.
|
|
2391
|
-
* @param {string} request.pageToken
|
|
2392
|
-
* A token, received from the previous search spaces call. Provide this
|
|
2393
|
-
* parameter to retrieve the subsequent page.
|
|
2394
|
-
*
|
|
2395
|
-
* When paginating, all other parameters provided should match the call that
|
|
2396
|
-
* provided the page token. Passing different values to the other parameters
|
|
2397
|
-
* might lead to unexpected results.
|
|
2398
|
-
* @param {string} request.query
|
|
2399
|
-
* Required. A search query.
|
|
2400
|
-
*
|
|
2401
|
-
* You can search by using the following parameters:
|
|
2402
|
-
*
|
|
2403
|
-
* - `create_time`
|
|
2404
|
-
* - `customer`
|
|
2405
|
-
* - `display_name`
|
|
2406
|
-
* - `external_user_allowed`
|
|
2407
|
-
* - `last_active_time`
|
|
2408
|
-
* - `space_history_state`
|
|
2409
|
-
* - `space_type`
|
|
2410
|
-
*
|
|
2411
|
-
* `create_time` and `last_active_time` accept a timestamp in
|
|
2412
|
-
* [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported
|
|
2413
|
-
* comparison operators are: `=`, `<`, `>`, `<=`, `>=`.
|
|
2414
|
-
*
|
|
2415
|
-
* `customer` is required and is used to indicate which customer
|
|
2416
|
-
* to fetch spaces from. `customers/my_customer` is the only supported value.
|
|
2417
|
-
*
|
|
2418
|
-
* `display_name` only accepts the `HAS` (`:`) operator. The text to
|
|
2419
|
-
* match is first tokenized into tokens and each token is prefix-matched
|
|
2420
|
-
* case-insensitively and independently as a substring anywhere in the space's
|
|
2421
|
-
* `display_name`. For example, `Fun Eve` matches `Fun event` or `The
|
|
2422
|
-
* evening was fun`, but not `notFun event` or `even`.
|
|
2423
|
-
*
|
|
2424
|
-
* `external_user_allowed` accepts either `true` or `false`.
|
|
2425
|
-
*
|
|
2426
|
-
* `space_history_state` only accepts values from the [`historyState`]
|
|
2427
|
-
* (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState)
|
|
2428
|
-
* field of a `space` resource.
|
|
2429
|
-
*
|
|
2430
|
-
* `space_type` is required and the only valid value is `SPACE`.
|
|
2431
|
-
*
|
|
2432
|
-
* Across different fields, only `AND` operators are supported. A valid
|
|
2433
|
-
* example is `space_type = "SPACE" AND display_name:"Hello"` and an invalid
|
|
2434
|
-
* example is `space_type = "SPACE" OR display_name:"Hello"`.
|
|
2435
|
-
*
|
|
2436
|
-
* Among the same field,
|
|
2437
|
-
* `space_type` doesn't support `AND` or `OR` operators.
|
|
2438
|
-
* `display_name`, 'space_history_state', and 'external_user_allowed' only
|
|
2439
|
-
* support `OR` operators.
|
|
2440
|
-
* `last_active_time` and `create_time` support both `AND` and `OR` operators.
|
|
2441
|
-
* `AND` can only be used to represent an interval, such as `last_active_time
|
|
2442
|
-
* < "2022-01-01T00:00:00+00:00" AND last_active_time >
|
|
2443
|
-
* "2023-01-01T00:00:00+00:00"`.
|
|
2444
|
-
*
|
|
2445
|
-
* The following example queries are valid:
|
|
2446
|
-
*
|
|
2447
|
-
* ```
|
|
2448
|
-
* customer = "customers/my_customer" AND space_type = "SPACE"
|
|
2449
|
-
*
|
|
2450
|
-
* customer = "customers/my_customer" AND space_type = "SPACE" AND
|
|
2451
|
-
* display_name:"Hello World"
|
|
2452
|
-
*
|
|
2453
|
-
* customer = "customers/my_customer" AND space_type = "SPACE" AND
|
|
2454
|
-
* (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
|
|
2455
|
-
* "2022-01-01T00:00:00+00:00")
|
|
2456
|
-
*
|
|
2457
|
-
* customer = "customers/my_customer" AND space_type = "SPACE" AND
|
|
2458
|
-
* (display_name:"Hello World" OR display_name:"Fun event") AND
|
|
2459
|
-
* (last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
|
|
2460
|
-
* "2022-01-01T00:00:00+00:00")
|
|
2428
|
+
* If unspecified, at most 100 spaces are returned.
|
|
2461
2429
|
*
|
|
2462
|
-
*
|
|
2463
|
-
*
|
|
2464
|
-
* "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
|
|
2465
|
-
* (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
|
|
2466
|
-
* ```
|
|
2467
|
-
* @param {string} [request.orderBy]
|
|
2468
|
-
* Optional. How the list of spaces is ordered.
|
|
2430
|
+
* The maximum value is 1000. If you use a value more than 1000, it's
|
|
2431
|
+
* automatically changed to 1000.
|
|
2469
2432
|
*
|
|
2470
|
-
*
|
|
2433
|
+
* Negative values return an `INVALID_ARGUMENT` error.
|
|
2434
|
+
* @param {string} [request.pageToken]
|
|
2435
|
+
* Optional. A page token, received from a previous list spaces call.
|
|
2436
|
+
* Provide this parameter to retrieve the subsequent page.
|
|
2471
2437
|
*
|
|
2472
|
-
*
|
|
2473
|
-
*
|
|
2474
|
-
*
|
|
2475
|
-
*
|
|
2476
|
-
* - `create_time` — Denotes the time of the space creation.
|
|
2438
|
+
* When paginating, the filter value should match the call that provided the
|
|
2439
|
+
* page token. Passing a different value may lead to unexpected results.
|
|
2440
|
+
* @param {string} [request.filter]
|
|
2441
|
+
* Optional. A query filter.
|
|
2477
2442
|
*
|
|
2478
|
-
*
|
|
2443
|
+
* You can filter spaces by the space type
|
|
2444
|
+
* ([`space_type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#spacetype)).
|
|
2479
2445
|
*
|
|
2480
|
-
*
|
|
2446
|
+
* To filter by space type, you must specify valid enum value, such as
|
|
2447
|
+
* `SPACE` or `GROUP_CHAT` (the `space_type` can't be
|
|
2448
|
+
* `SPACE_TYPE_UNSPECIFIED`). To query for multiple space types, use the `OR`
|
|
2449
|
+
* operator.
|
|
2481
2450
|
*
|
|
2482
|
-
*
|
|
2451
|
+
* For example, the following queries are valid:
|
|
2483
2452
|
*
|
|
2484
|
-
*
|
|
2453
|
+
* ```
|
|
2454
|
+
* space_type = "SPACE"
|
|
2455
|
+
* spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"
|
|
2456
|
+
* ```
|
|
2485
2457
|
*
|
|
2486
|
-
*
|
|
2487
|
-
*
|
|
2488
|
-
* - `last_active_time DESC`
|
|
2489
|
-
* - `last_active_time ASC`
|
|
2490
|
-
* - `create_time DESC`
|
|
2491
|
-
* - `create_time ASC`
|
|
2458
|
+
* Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
|
|
2459
|
+
* error.
|
|
2492
2460
|
* @param {object} [options]
|
|
2493
2461
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
2494
|
-
* @returns {
|
|
2495
|
-
*
|
|
2496
|
-
*
|
|
2497
|
-
*
|
|
2498
|
-
*
|
|
2499
|
-
* We recommend using `searchSpacesAsync()`
|
|
2500
|
-
* method described below for async iteration which you can stop as needed.
|
|
2462
|
+
* @returns {Object}
|
|
2463
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
|
2464
|
+
* When you iterate the returned iterable, each element will be an object representing
|
|
2465
|
+
* {@link protos.google.chat.v1.Space|Space}. The API will be called under the hood as needed, once per the page,
|
|
2466
|
+
* so you can stop the iteration when you don't need more results.
|
|
2501
2467
|
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
2502
2468
|
* for more details and examples.
|
|
2469
|
+
* @example <caption>include:samples/generated/v1/chat_service.list_spaces.js</caption>
|
|
2470
|
+
* region_tag:chat_v1_generated_ChatService_ListSpaces_async
|
|
2503
2471
|
*/
|
|
2472
|
+
listSpacesAsync(request?: protos.google.chat.v1.IListSpacesRequest, options?: CallOptions): AsyncIterable<protos.google.chat.v1.ISpace>;
|
|
2473
|
+
/**
|
|
2474
|
+
* Returns a list of spaces in a Google Workspace organization based on an
|
|
2475
|
+
* administrator's search.
|
|
2476
|
+
*
|
|
2477
|
+
* Requires [user
|
|
2478
|
+
* authentication with administrator
|
|
2479
|
+
* privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges).
|
|
2480
|
+
* In the request, set `use_admin_access` to `true`.
|
|
2481
|
+
*
|
|
2482
|
+
* @param {Object} request
|
|
2483
|
+
* The request object that will be sent.
|
|
2484
|
+
* @param {boolean} request.useAdminAccess
|
|
2485
|
+
* When `true`, the method runs using the user's Google Workspace
|
|
2486
|
+
* administrator privileges.
|
|
2487
|
+
*
|
|
2488
|
+
* The calling user must be a Google Workspace administrator with the
|
|
2489
|
+
* [manage chat and spaces conversations
|
|
2490
|
+
* privilege](https://support.google.com/a/answer/13369245).
|
|
2491
|
+
*
|
|
2492
|
+
* Requires either the `chat.admin.spaces.readonly` or `chat.admin.spaces`
|
|
2493
|
+
* [OAuth 2.0
|
|
2494
|
+
* scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
|
|
2495
|
+
*
|
|
2496
|
+
* This method currently only supports admin access, thus only `true` is
|
|
2497
|
+
* accepted for this field.
|
|
2498
|
+
* @param {number} request.pageSize
|
|
2499
|
+
* The maximum number of spaces to return. The service may return fewer than
|
|
2500
|
+
* this value.
|
|
2501
|
+
*
|
|
2502
|
+
* If unspecified, at most 100 spaces are returned.
|
|
2503
|
+
*
|
|
2504
|
+
* The maximum value is 1000. If you use a value more than 1000, it's
|
|
2505
|
+
* automatically changed to 1000.
|
|
2506
|
+
* @param {string} request.pageToken
|
|
2507
|
+
* A token, received from the previous search spaces call. Provide this
|
|
2508
|
+
* parameter to retrieve the subsequent page.
|
|
2509
|
+
*
|
|
2510
|
+
* When paginating, all other parameters provided should match the call that
|
|
2511
|
+
* provided the page token. Passing different values to the other parameters
|
|
2512
|
+
* might lead to unexpected results.
|
|
2513
|
+
* @param {string} request.query
|
|
2514
|
+
* Required. A search query.
|
|
2515
|
+
*
|
|
2516
|
+
* You can search by using the following parameters:
|
|
2517
|
+
*
|
|
2518
|
+
* - `create_time`
|
|
2519
|
+
* - `customer`
|
|
2520
|
+
* - `display_name`
|
|
2521
|
+
* - `external_user_allowed`
|
|
2522
|
+
* - `last_active_time`
|
|
2523
|
+
* - `space_history_state`
|
|
2524
|
+
* - `space_type`
|
|
2525
|
+
*
|
|
2526
|
+
* `create_time` and `last_active_time` accept a timestamp in
|
|
2527
|
+
* [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported
|
|
2528
|
+
* comparison operators are: `=`, `<`, `>`, `<=`, `>=`.
|
|
2529
|
+
*
|
|
2530
|
+
* `customer` is required and is used to indicate which customer
|
|
2531
|
+
* to fetch spaces from. `customers/my_customer` is the only supported value.
|
|
2532
|
+
*
|
|
2533
|
+
* `display_name` only accepts the `HAS` (`:`) operator. The text to
|
|
2534
|
+
* match is first tokenized into tokens and each token is prefix-matched
|
|
2535
|
+
* case-insensitively and independently as a substring anywhere in the space's
|
|
2536
|
+
* `display_name`. For example, `Fun Eve` matches `Fun event` or `The
|
|
2537
|
+
* evening was fun`, but not `notFun event` or `even`.
|
|
2538
|
+
*
|
|
2539
|
+
* `external_user_allowed` accepts either `true` or `false`.
|
|
2540
|
+
*
|
|
2541
|
+
* `space_history_state` only accepts values from the [`historyState`]
|
|
2542
|
+
* (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState)
|
|
2543
|
+
* field of a `space` resource.
|
|
2544
|
+
*
|
|
2545
|
+
* `space_type` is required and the only valid value is `SPACE`.
|
|
2546
|
+
*
|
|
2547
|
+
* Across different fields, only `AND` operators are supported. A valid
|
|
2548
|
+
* example is `space_type = "SPACE" AND display_name:"Hello"` and an invalid
|
|
2549
|
+
* example is `space_type = "SPACE" OR display_name:"Hello"`.
|
|
2550
|
+
*
|
|
2551
|
+
* Among the same field,
|
|
2552
|
+
* `space_type` doesn't support `AND` or `OR` operators.
|
|
2553
|
+
* `display_name`, 'space_history_state', and 'external_user_allowed' only
|
|
2554
|
+
* support `OR` operators.
|
|
2555
|
+
* `last_active_time` and `create_time` support both `AND` and `OR` operators.
|
|
2556
|
+
* `AND` can only be used to represent an interval, such as `last_active_time
|
|
2557
|
+
* < "2022-01-01T00:00:00+00:00" AND last_active_time >
|
|
2558
|
+
* "2023-01-01T00:00:00+00:00"`.
|
|
2559
|
+
*
|
|
2560
|
+
* The following example queries are valid:
|
|
2561
|
+
*
|
|
2562
|
+
* ```
|
|
2563
|
+
* customer = "customers/my_customer" AND space_type = "SPACE"
|
|
2564
|
+
*
|
|
2565
|
+
* customer = "customers/my_customer" AND space_type = "SPACE" AND
|
|
2566
|
+
* display_name:"Hello World"
|
|
2567
|
+
*
|
|
2568
|
+
* customer = "customers/my_customer" AND space_type = "SPACE" AND
|
|
2569
|
+
* (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
|
|
2570
|
+
* "2022-01-01T00:00:00+00:00")
|
|
2571
|
+
*
|
|
2572
|
+
* customer = "customers/my_customer" AND space_type = "SPACE" AND
|
|
2573
|
+
* (display_name:"Hello World" OR display_name:"Fun event") AND
|
|
2574
|
+
* (last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
|
|
2575
|
+
* "2022-01-01T00:00:00+00:00")
|
|
2576
|
+
*
|
|
2577
|
+
* customer = "customers/my_customer" AND space_type = "SPACE" AND
|
|
2578
|
+
* (create_time > "2019-01-01T00:00:00+00:00" AND create_time <
|
|
2579
|
+
* "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
|
|
2580
|
+
* (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
|
|
2581
|
+
* ```
|
|
2582
|
+
* @param {string} [request.orderBy]
|
|
2583
|
+
* Optional. How the list of spaces is ordered.
|
|
2584
|
+
*
|
|
2585
|
+
* Supported attributes to order by are:
|
|
2586
|
+
*
|
|
2587
|
+
* - `membership_count.joined_direct_human_user_count` — Denotes the count of
|
|
2588
|
+
* human users that have directly joined a space.
|
|
2589
|
+
* - `last_active_time` — Denotes the time when last eligible item is added to
|
|
2590
|
+
* any topic of this space.
|
|
2591
|
+
* - `create_time` — Denotes the time of the space creation.
|
|
2592
|
+
*
|
|
2593
|
+
* Valid ordering operation values are:
|
|
2594
|
+
*
|
|
2595
|
+
* - `ASC` for ascending. Default value.
|
|
2596
|
+
*
|
|
2597
|
+
* - `DESC` for descending.
|
|
2598
|
+
*
|
|
2599
|
+
* The supported syntax are:
|
|
2600
|
+
*
|
|
2601
|
+
* - `membership_count.joined_direct_human_user_count DESC`
|
|
2602
|
+
* - `membership_count.joined_direct_human_user_count ASC`
|
|
2603
|
+
* - `last_active_time DESC`
|
|
2604
|
+
* - `last_active_time ASC`
|
|
2605
|
+
* - `create_time DESC`
|
|
2606
|
+
* - `create_time ASC`
|
|
2607
|
+
* @param {object} [options]
|
|
2608
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
2609
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
2610
|
+
* The first element of the array is Array of {@link protos.google.chat.v1.Space|Space}.
|
|
2611
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
2612
|
+
* times as needed and will merge results from all the pages into this array.
|
|
2613
|
+
* Note that it can affect your quota.
|
|
2614
|
+
* We recommend using `searchSpacesAsync()`
|
|
2615
|
+
* method described below for async iteration which you can stop as needed.
|
|
2616
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
2617
|
+
* for more details and examples.
|
|
2618
|
+
*/
|
|
2504
2619
|
searchSpaces(request?: protos.google.chat.v1.ISearchSpacesRequest, options?: CallOptions): Promise<[
|
|
2505
2620
|
protos.google.chat.v1.ISpace[],
|
|
2506
2621
|
protos.google.chat.v1.ISearchSpacesRequest | null,
|
|
@@ -2790,88 +2905,87 @@ export declare class ChatServiceClient {
|
|
|
2790
2905
|
*/
|
|
2791
2906
|
searchSpacesAsync(request?: protos.google.chat.v1.ISearchSpacesRequest, options?: CallOptions): AsyncIterable<protos.google.chat.v1.ISpace>;
|
|
2792
2907
|
/**
|
|
2793
|
-
|
|
2794
|
-
|
|
2795
|
-
|
|
2796
|
-
|
|
2797
|
-
|
|
2798
|
-
|
|
2799
|
-
|
|
2800
|
-
|
|
2801
|
-
|
|
2802
|
-
|
|
2803
|
-
|
|
2804
|
-
|
|
2805
|
-
|
|
2806
|
-
|
|
2807
|
-
|
|
2808
|
-
|
|
2809
|
-
|
|
2810
|
-
|
|
2811
|
-
|
|
2812
|
-
|
|
2813
|
-
|
|
2814
|
-
|
|
2815
|
-
|
|
2816
|
-
|
|
2817
|
-
|
|
2818
|
-
|
|
2819
|
-
|
|
2820
|
-
|
|
2821
|
-
|
|
2822
|
-
|
|
2823
|
-
|
|
2824
|
-
|
|
2825
|
-
|
|
2826
|
-
|
|
2827
|
-
|
|
2828
|
-
|
|
2829
|
-
|
|
2830
|
-
|
|
2831
|
-
|
|
2832
|
-
|
|
2833
|
-
|
|
2834
|
-
|
|
2835
|
-
|
|
2836
|
-
|
|
2837
|
-
|
|
2838
|
-
|
|
2839
|
-
|
|
2840
|
-
|
|
2841
|
-
|
|
2842
|
-
|
|
2843
|
-
|
|
2844
|
-
|
|
2845
|
-
|
|
2846
|
-
|
|
2847
|
-
|
|
2848
|
-
|
|
2849
|
-
|
|
2850
|
-
|
|
2851
|
-
|
|
2852
|
-
|
|
2853
|
-
|
|
2854
|
-
|
|
2855
|
-
|
|
2856
|
-
|
|
2857
|
-
|
|
2858
|
-
|
|
2859
|
-
|
|
2860
|
-
|
|
2861
|
-
|
|
2862
|
-
|
|
2863
|
-
|
|
2864
|
-
|
|
2865
|
-
|
|
2866
|
-
|
|
2867
|
-
|
|
2868
|
-
|
|
2869
|
-
|
|
2870
|
-
|
|
2871
|
-
|
|
2872
|
-
|
|
2873
|
-
|
|
2874
|
-
*/
|
|
2908
|
+
* Lists reactions to a message. For an example, see
|
|
2909
|
+
* [List reactions for a
|
|
2910
|
+
* message](https://developers.google.com/workspace/chat/list-reactions).
|
|
2911
|
+
*
|
|
2912
|
+
* Requires [user
|
|
2913
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
2914
|
+
*
|
|
2915
|
+
* @param {Object} request
|
|
2916
|
+
* The request object that will be sent.
|
|
2917
|
+
* @param {string} request.parent
|
|
2918
|
+
* Required. The message users reacted to.
|
|
2919
|
+
*
|
|
2920
|
+
* Format: `spaces/{space}/messages/{message}`
|
|
2921
|
+
* @param {number} [request.pageSize]
|
|
2922
|
+
* Optional. The maximum number of reactions returned. The service can return
|
|
2923
|
+
* fewer reactions than this value. If unspecified, the default value is 25.
|
|
2924
|
+
* The maximum value is 200; values above 200 are changed to 200.
|
|
2925
|
+
* @param {string} [request.pageToken]
|
|
2926
|
+
* Optional. (If resuming from a previous query.)
|
|
2927
|
+
*
|
|
2928
|
+
* A page token received from a previous list reactions call. Provide this
|
|
2929
|
+
* to retrieve the subsequent page.
|
|
2930
|
+
*
|
|
2931
|
+
* When paginating, the filter value should match the call that provided the
|
|
2932
|
+
* page token. Passing a different value might lead to unexpected results.
|
|
2933
|
+
* @param {string} [request.filter]
|
|
2934
|
+
* Optional. A query filter.
|
|
2935
|
+
*
|
|
2936
|
+
* You can filter reactions by
|
|
2937
|
+
* [emoji](https://developers.google.com/workspace/chat/api/reference/rest/v1/Emoji)
|
|
2938
|
+
* (either `emoji.unicode` or `emoji.custom_emoji.uid`) and
|
|
2939
|
+
* [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User)
|
|
2940
|
+
* (`user.name`).
|
|
2941
|
+
*
|
|
2942
|
+
* To filter reactions for multiple emojis or users, join similar fields
|
|
2943
|
+
* with the `OR` operator, such as `emoji.unicode = "🙂" OR emoji.unicode =
|
|
2944
|
+
* "👍"` and `user.name = "users/AAAAAA" OR user.name = "users/BBBBBB"`.
|
|
2945
|
+
*
|
|
2946
|
+
* To filter reactions by emoji and user, use the `AND` operator, such as
|
|
2947
|
+
* `emoji.unicode = "🙂" AND user.name = "users/AAAAAA"`.
|
|
2948
|
+
*
|
|
2949
|
+
* If your query uses both `AND` and `OR`, group them with parentheses.
|
|
2950
|
+
*
|
|
2951
|
+
* For example, the following queries are valid:
|
|
2952
|
+
*
|
|
2953
|
+
* ```
|
|
2954
|
+
* user.name = "users/{user}"
|
|
2955
|
+
* emoji.unicode = "🙂"
|
|
2956
|
+
* emoji.custom_emoji.uid = "{uid}"
|
|
2957
|
+
* emoji.unicode = "🙂" OR emoji.unicode = "👍"
|
|
2958
|
+
* emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
|
|
2959
|
+
* emoji.unicode = "🙂" AND user.name = "users/{user}"
|
|
2960
|
+
* (emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
|
|
2961
|
+
* AND user.name = "users/{user}"
|
|
2962
|
+
* ```
|
|
2963
|
+
*
|
|
2964
|
+
* The following queries are invalid:
|
|
2965
|
+
*
|
|
2966
|
+
* ```
|
|
2967
|
+
* emoji.unicode = "🙂" AND emoji.unicode = "👍"
|
|
2968
|
+
* emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
|
|
2969
|
+
* emoji.unicode = "🙂" OR user.name = "users/{user}"
|
|
2970
|
+
* emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
|
|
2971
|
+
* user.name = "users/{user}"
|
|
2972
|
+
* emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
|
|
2973
|
+
* AND user.name = "users/{user}"
|
|
2974
|
+
* ```
|
|
2975
|
+
*
|
|
2976
|
+
* Invalid queries are rejected with an `INVALID_ARGUMENT` error.
|
|
2977
|
+
* @param {object} [options]
|
|
2978
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
2979
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
2980
|
+
* The first element of the array is Array of {@link protos.google.chat.v1.Reaction|Reaction}.
|
|
2981
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
2982
|
+
* times as needed and will merge results from all the pages into this array.
|
|
2983
|
+
* Note that it can affect your quota.
|
|
2984
|
+
* We recommend using `listReactionsAsync()`
|
|
2985
|
+
* method described below for async iteration which you can stop as needed.
|
|
2986
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
2987
|
+
* for more details and examples.
|
|
2988
|
+
*/
|
|
2875
2989
|
listReactions(request?: protos.google.chat.v1.IListReactionsRequest, options?: CallOptions): Promise<[
|
|
2876
2990
|
protos.google.chat.v1.IReaction[],
|
|
2877
2991
|
protos.google.chat.v1.IListReactionsRequest | null,
|
|
@@ -2942,8 +3056,7 @@ export declare class ChatServiceClient {
|
|
|
2942
3056
|
* AND user.name = "users/{user}"
|
|
2943
3057
|
* ```
|
|
2944
3058
|
*
|
|
2945
|
-
* Invalid queries are rejected
|
|
2946
|
-
* error.
|
|
3059
|
+
* Invalid queries are rejected with an `INVALID_ARGUMENT` error.
|
|
2947
3060
|
* @param {object} [options]
|
|
2948
3061
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
2949
3062
|
* @returns {Stream}
|
|
@@ -3021,8 +3134,7 @@ export declare class ChatServiceClient {
|
|
|
3021
3134
|
* AND user.name = "users/{user}"
|
|
3022
3135
|
* ```
|
|
3023
3136
|
*
|
|
3024
|
-
* Invalid queries are rejected
|
|
3025
|
-
* error.
|
|
3137
|
+
* Invalid queries are rejected with an `INVALID_ARGUMENT` error.
|
|
3026
3138
|
* @param {object} [options]
|
|
3027
3139
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
3028
3140
|
* @returns {Object}
|
|
@@ -3037,106 +3149,259 @@ export declare class ChatServiceClient {
|
|
|
3037
3149
|
*/
|
|
3038
3150
|
listReactionsAsync(request?: protos.google.chat.v1.IListReactionsRequest, options?: CallOptions): AsyncIterable<protos.google.chat.v1.IReaction>;
|
|
3039
3151
|
/**
|
|
3040
|
-
|
|
3041
|
-
|
|
3042
|
-
|
|
3043
|
-
|
|
3044
|
-
|
|
3045
|
-
|
|
3046
|
-
|
|
3047
|
-
|
|
3048
|
-
|
|
3049
|
-
|
|
3050
|
-
|
|
3051
|
-
|
|
3052
|
-
|
|
3053
|
-
|
|
3054
|
-
|
|
3152
|
+
* Lists custom emojis visible to the authenticated user.
|
|
3153
|
+
*
|
|
3154
|
+
* Custom emojis are only available for Google Workspace accounts, and the
|
|
3155
|
+
* administrator must turn custom emojis on for the organization. For more
|
|
3156
|
+
* information, see [Learn about custom emojis in Google
|
|
3157
|
+
* Chat](https://support.google.com/chat/answer/12800149) and
|
|
3158
|
+
* [Manage custom emoji
|
|
3159
|
+
* permissions](https://support.google.com/a/answer/12850085).
|
|
3160
|
+
*
|
|
3161
|
+
* Requires [user
|
|
3162
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
3163
|
+
*
|
|
3164
|
+
* @param {Object} request
|
|
3165
|
+
* The request object that will be sent.
|
|
3166
|
+
* @param {number} [request.pageSize]
|
|
3167
|
+
* Optional. The maximum number of custom emojis returned. The service can
|
|
3168
|
+
* return fewer custom emojis than this value. If unspecified, the default
|
|
3169
|
+
* value is 25. The maximum value is 200; values above 200 are changed to 200.
|
|
3170
|
+
* @param {string} [request.pageToken]
|
|
3171
|
+
* Optional. (If resuming from a previous query.)
|
|
3172
|
+
*
|
|
3173
|
+
* A page token received from a previous list custom emoji call. Provide this
|
|
3174
|
+
* to retrieve the subsequent page.
|
|
3175
|
+
*
|
|
3176
|
+
* When paginating, the filter value should match the call that provided the
|
|
3177
|
+
* page token. Passing a different value might lead to unexpected results.
|
|
3178
|
+
* @param {string} [request.filter]
|
|
3179
|
+
* Optional. A query filter.
|
|
3180
|
+
*
|
|
3181
|
+
* Supports filtering by creator.
|
|
3182
|
+
*
|
|
3183
|
+
* To filter by creator, you must specify a valid value. Currently only
|
|
3184
|
+
* `creator("users/me")` and `NOT creator("users/me")` are accepted to filter
|
|
3185
|
+
* custom emojis by whether they were created by the calling user or not.
|
|
3186
|
+
*
|
|
3187
|
+
* For example, the following query returns custom emojis created by the
|
|
3188
|
+
* caller:
|
|
3189
|
+
* ```
|
|
3190
|
+
* creator("users/me")
|
|
3191
|
+
* ```
|
|
3192
|
+
*
|
|
3193
|
+
* Invalid queries are rejected with an `INVALID_ARGUMENT` error.
|
|
3194
|
+
* @param {object} [options]
|
|
3195
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
3196
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
3197
|
+
* The first element of the array is Array of {@link protos.google.chat.v1.CustomEmoji|CustomEmoji}.
|
|
3198
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
3199
|
+
* times as needed and will merge results from all the pages into this array.
|
|
3200
|
+
* Note that it can affect your quota.
|
|
3201
|
+
* We recommend using `listCustomEmojisAsync()`
|
|
3202
|
+
* method described below for async iteration which you can stop as needed.
|
|
3203
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
3204
|
+
* for more details and examples.
|
|
3205
|
+
*/
|
|
3206
|
+
listCustomEmojis(request?: protos.google.chat.v1.IListCustomEmojisRequest, options?: CallOptions): Promise<[
|
|
3207
|
+
protos.google.chat.v1.ICustomEmoji[],
|
|
3208
|
+
protos.google.chat.v1.IListCustomEmojisRequest | null,
|
|
3209
|
+
protos.google.chat.v1.IListCustomEmojisResponse
|
|
3210
|
+
]>;
|
|
3211
|
+
listCustomEmojis(request: protos.google.chat.v1.IListCustomEmojisRequest, options: CallOptions, callback: PaginationCallback<protos.google.chat.v1.IListCustomEmojisRequest, protos.google.chat.v1.IListCustomEmojisResponse | null | undefined, protos.google.chat.v1.ICustomEmoji>): void;
|
|
3212
|
+
listCustomEmojis(request: protos.google.chat.v1.IListCustomEmojisRequest, callback: PaginationCallback<protos.google.chat.v1.IListCustomEmojisRequest, protos.google.chat.v1.IListCustomEmojisResponse | null | undefined, protos.google.chat.v1.ICustomEmoji>): void;
|
|
3213
|
+
/**
|
|
3214
|
+
* Equivalent to `listCustomEmojis`, but returns a NodeJS Stream object.
|
|
3055
3215
|
* @param {Object} request
|
|
3056
3216
|
* The request object that will be sent.
|
|
3057
|
-
* @param {string} request.parent
|
|
3058
|
-
* Required. Resource name of the [Google Chat
|
|
3059
|
-
* space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces)
|
|
3060
|
-
* where the events occurred.
|
|
3061
|
-
*
|
|
3062
|
-
* Format: `spaces/{space}`.
|
|
3063
3217
|
* @param {number} [request.pageSize]
|
|
3064
|
-
* Optional. The maximum number of
|
|
3065
|
-
* return fewer than this value.
|
|
3066
|
-
*
|
|
3067
|
-
* Negative values return an `INVALID_ARGUMENT` error.
|
|
3218
|
+
* Optional. The maximum number of custom emojis returned. The service can
|
|
3219
|
+
* return fewer custom emojis than this value. If unspecified, the default
|
|
3220
|
+
* value is 25. The maximum value is 200; values above 200 are changed to 200.
|
|
3068
3221
|
* @param {string} [request.pageToken]
|
|
3069
|
-
* Optional.
|
|
3070
|
-
* Provide this to retrieve the subsequent page.
|
|
3071
|
-
*
|
|
3072
|
-
* When paginating, all other parameters provided to list space events must
|
|
3073
|
-
* match the call that provided the page token. Passing different values to
|
|
3074
|
-
* the other parameters might lead to unexpected results.
|
|
3075
|
-
* @param {string} request.filter
|
|
3076
|
-
* Required. A query filter.
|
|
3077
|
-
*
|
|
3078
|
-
* You must specify at least one event type (`event_type`)
|
|
3079
|
-
* using the has `:` operator. To filter by multiple event types, use the `OR`
|
|
3080
|
-
* operator. Omit batch event types in your filter. The request automatically
|
|
3081
|
-
* returns any related batch events. For example, if you filter by new
|
|
3082
|
-
* reactions
|
|
3083
|
-
* (`google.workspace.chat.reaction.v1.created`), the server also returns
|
|
3084
|
-
* batch new reactions events
|
|
3085
|
-
* (`google.workspace.chat.reaction.v1.batchCreated`). For a list of supported
|
|
3086
|
-
* event types, see the [`SpaceEvents` reference
|
|
3087
|
-
* documentation](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.event_type).
|
|
3222
|
+
* Optional. (If resuming from a previous query.)
|
|
3088
3223
|
*
|
|
3089
|
-
*
|
|
3090
|
-
*
|
|
3224
|
+
* A page token received from a previous list custom emoji call. Provide this
|
|
3225
|
+
* to retrieve the subsequent page.
|
|
3091
3226
|
*
|
|
3092
|
-
*
|
|
3093
|
-
*
|
|
3094
|
-
*
|
|
3095
|
-
*
|
|
3096
|
-
* * `end_time`: Inclusive timestamp until which space events are listed.
|
|
3097
|
-
* If unspecified, lists events up to the time of the request.
|
|
3227
|
+
* When paginating, the filter value should match the call that provided the
|
|
3228
|
+
* page token. Passing a different value might lead to unexpected results.
|
|
3229
|
+
* @param {string} [request.filter]
|
|
3230
|
+
* Optional. A query filter.
|
|
3098
3231
|
*
|
|
3099
|
-
*
|
|
3100
|
-
* [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339). To filter by both
|
|
3101
|
-
* `start_time` and `end_time`, use the `AND` operator.
|
|
3232
|
+
* Supports filtering by creator.
|
|
3102
3233
|
*
|
|
3103
|
-
*
|
|
3234
|
+
* To filter by creator, you must specify a valid value. Currently only
|
|
3235
|
+
* `creator("users/me")` and `NOT creator("users/me")` are accepted to filter
|
|
3236
|
+
* custom emojis by whether they were created by the calling user or not.
|
|
3104
3237
|
*
|
|
3238
|
+
* For example, the following query returns custom emojis created by the
|
|
3239
|
+
* caller:
|
|
3105
3240
|
* ```
|
|
3106
|
-
*
|
|
3107
|
-
* end_time="2023-08-23T19:21:54+00:00"
|
|
3108
|
-
* ```
|
|
3109
|
-
* ```
|
|
3110
|
-
* start_time="2023-08-23T19:20:33+00:00" AND
|
|
3111
|
-
* (event_types:"google.workspace.chat.space.v1.updated" OR
|
|
3112
|
-
* event_types:"google.workspace.chat.message.v1.created")
|
|
3241
|
+
* creator("users/me")
|
|
3113
3242
|
* ```
|
|
3114
3243
|
*
|
|
3115
|
-
*
|
|
3244
|
+
* Invalid queries are rejected with an `INVALID_ARGUMENT` error.
|
|
3245
|
+
* @param {object} [options]
|
|
3246
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
3247
|
+
* @returns {Stream}
|
|
3248
|
+
* An object stream which emits an object representing {@link protos.google.chat.v1.CustomEmoji|CustomEmoji} on 'data' event.
|
|
3249
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
3250
|
+
* times as needed. Note that it can affect your quota.
|
|
3251
|
+
* We recommend using `listCustomEmojisAsync()`
|
|
3252
|
+
* method described below for async iteration which you can stop as needed.
|
|
3253
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
3254
|
+
* for more details and examples.
|
|
3255
|
+
*/
|
|
3256
|
+
listCustomEmojisStream(request?: protos.google.chat.v1.IListCustomEmojisRequest, options?: CallOptions): Transform;
|
|
3257
|
+
/**
|
|
3258
|
+
* Equivalent to `listCustomEmojis`, but returns an iterable object.
|
|
3116
3259
|
*
|
|
3260
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
|
3261
|
+
* @param {Object} request
|
|
3262
|
+
* The request object that will be sent.
|
|
3263
|
+
* @param {number} [request.pageSize]
|
|
3264
|
+
* Optional. The maximum number of custom emojis returned. The service can
|
|
3265
|
+
* return fewer custom emojis than this value. If unspecified, the default
|
|
3266
|
+
* value is 25. The maximum value is 200; values above 200 are changed to 200.
|
|
3267
|
+
* @param {string} [request.pageToken]
|
|
3268
|
+
* Optional. (If resuming from a previous query.)
|
|
3269
|
+
*
|
|
3270
|
+
* A page token received from a previous list custom emoji call. Provide this
|
|
3271
|
+
* to retrieve the subsequent page.
|
|
3272
|
+
*
|
|
3273
|
+
* When paginating, the filter value should match the call that provided the
|
|
3274
|
+
* page token. Passing a different value might lead to unexpected results.
|
|
3275
|
+
* @param {string} [request.filter]
|
|
3276
|
+
* Optional. A query filter.
|
|
3277
|
+
*
|
|
3278
|
+
* Supports filtering by creator.
|
|
3279
|
+
*
|
|
3280
|
+
* To filter by creator, you must specify a valid value. Currently only
|
|
3281
|
+
* `creator("users/me")` and `NOT creator("users/me")` are accepted to filter
|
|
3282
|
+
* custom emojis by whether they were created by the calling user or not.
|
|
3283
|
+
*
|
|
3284
|
+
* For example, the following query returns custom emojis created by the
|
|
3285
|
+
* caller:
|
|
3117
3286
|
* ```
|
|
3118
|
-
*
|
|
3119
|
-
* end_time="2023-08-23T19:21:54+00:00"
|
|
3120
|
-
* ```
|
|
3121
|
-
* ```
|
|
3122
|
-
* event_types:"google.workspace.chat.space.v1.updated" AND
|
|
3123
|
-
* event_types:"google.workspace.chat.message.v1.created"
|
|
3287
|
+
* creator("users/me")
|
|
3124
3288
|
* ```
|
|
3125
3289
|
*
|
|
3126
|
-
* Invalid queries are rejected
|
|
3127
|
-
* error.
|
|
3290
|
+
* Invalid queries are rejected with an `INVALID_ARGUMENT` error.
|
|
3128
3291
|
* @param {object} [options]
|
|
3129
3292
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
3130
|
-
* @returns {
|
|
3131
|
-
*
|
|
3132
|
-
*
|
|
3133
|
-
*
|
|
3134
|
-
*
|
|
3135
|
-
* We recommend using `listSpaceEventsAsync()`
|
|
3136
|
-
* method described below for async iteration which you can stop as needed.
|
|
3293
|
+
* @returns {Object}
|
|
3294
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
|
3295
|
+
* When you iterate the returned iterable, each element will be an object representing
|
|
3296
|
+
* {@link protos.google.chat.v1.CustomEmoji|CustomEmoji}. The API will be called under the hood as needed, once per the page,
|
|
3297
|
+
* so you can stop the iteration when you don't need more results.
|
|
3137
3298
|
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
3138
3299
|
* for more details and examples.
|
|
3139
|
-
|
|
3300
|
+
* @example <caption>include:samples/generated/v1/chat_service.list_custom_emojis.js</caption>
|
|
3301
|
+
* region_tag:chat_v1_generated_ChatService_ListCustomEmojis_async
|
|
3302
|
+
*/
|
|
3303
|
+
listCustomEmojisAsync(request?: protos.google.chat.v1.IListCustomEmojisRequest, options?: CallOptions): AsyncIterable<protos.google.chat.v1.ICustomEmoji>;
|
|
3304
|
+
/**
|
|
3305
|
+
* Lists events from a Google Chat space. For each event, the
|
|
3306
|
+
* [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload)
|
|
3307
|
+
* contains the most recent version of the Chat resource. For example, if you
|
|
3308
|
+
* list events about new space members, the server returns `Membership`
|
|
3309
|
+
* resources that contain the latest membership details. If new members were
|
|
3310
|
+
* removed during the requested period, the event payload contains an empty
|
|
3311
|
+
* `Membership` resource.
|
|
3312
|
+
*
|
|
3313
|
+
* Requires [user
|
|
3314
|
+
* authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
3315
|
+
* To list events, the authenticated user must be a member of the space.
|
|
3316
|
+
*
|
|
3317
|
+
* For an example, see [List events from a Google Chat
|
|
3318
|
+
* space](https://developers.google.com/workspace/chat/list-space-events).
|
|
3319
|
+
*
|
|
3320
|
+
* @param {Object} request
|
|
3321
|
+
* The request object that will be sent.
|
|
3322
|
+
* @param {string} request.parent
|
|
3323
|
+
* Required. Resource name of the [Google Chat
|
|
3324
|
+
* space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces)
|
|
3325
|
+
* where the events occurred.
|
|
3326
|
+
*
|
|
3327
|
+
* Format: `spaces/{space}`.
|
|
3328
|
+
* @param {number} [request.pageSize]
|
|
3329
|
+
* Optional. The maximum number of space events returned. The service might
|
|
3330
|
+
* return fewer than this value.
|
|
3331
|
+
*
|
|
3332
|
+
* Negative values return an `INVALID_ARGUMENT` error.
|
|
3333
|
+
* @param {string} [request.pageToken]
|
|
3334
|
+
* Optional. A page token, received from a previous list space events call.
|
|
3335
|
+
* Provide this to retrieve the subsequent page.
|
|
3336
|
+
*
|
|
3337
|
+
* When paginating, all other parameters provided to list space events must
|
|
3338
|
+
* match the call that provided the page token. Passing different values to
|
|
3339
|
+
* the other parameters might lead to unexpected results.
|
|
3340
|
+
* @param {string} request.filter
|
|
3341
|
+
* Required. A query filter.
|
|
3342
|
+
*
|
|
3343
|
+
* You must specify at least one event type (`event_type`)
|
|
3344
|
+
* using the has `:` operator. To filter by multiple event types, use the `OR`
|
|
3345
|
+
* operator. Omit batch event types in your filter. The request automatically
|
|
3346
|
+
* returns any related batch events. For example, if you filter by new
|
|
3347
|
+
* reactions
|
|
3348
|
+
* (`google.workspace.chat.reaction.v1.created`), the server also returns
|
|
3349
|
+
* batch new reactions events
|
|
3350
|
+
* (`google.workspace.chat.reaction.v1.batchCreated`). For a list of supported
|
|
3351
|
+
* event types, see the [`SpaceEvents` reference
|
|
3352
|
+
* documentation](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.event_type).
|
|
3353
|
+
*
|
|
3354
|
+
* Optionally, you can also filter by start time (`start_time`) and
|
|
3355
|
+
* end time (`end_time`):
|
|
3356
|
+
*
|
|
3357
|
+
* * `start_time`: Exclusive timestamp from which to start listing space
|
|
3358
|
+
* events.
|
|
3359
|
+
* You can list events that occurred up to 28 days ago. If unspecified, lists
|
|
3360
|
+
* space events from the past 28 days.
|
|
3361
|
+
* * `end_time`: Inclusive timestamp until which space events are listed.
|
|
3362
|
+
* If unspecified, lists events up to the time of the request.
|
|
3363
|
+
*
|
|
3364
|
+
* To specify a start or end time, use the equals `=` operator and format in
|
|
3365
|
+
* [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339). To filter by both
|
|
3366
|
+
* `start_time` and `end_time`, use the `AND` operator.
|
|
3367
|
+
*
|
|
3368
|
+
* For example, the following queries are valid:
|
|
3369
|
+
*
|
|
3370
|
+
* ```
|
|
3371
|
+
* start_time="2023-08-23T19:20:33+00:00" AND
|
|
3372
|
+
* end_time="2023-08-23T19:21:54+00:00"
|
|
3373
|
+
* ```
|
|
3374
|
+
* ```
|
|
3375
|
+
* start_time="2023-08-23T19:20:33+00:00" AND
|
|
3376
|
+
* (event_types:"google.workspace.chat.space.v1.updated" OR
|
|
3377
|
+
* event_types:"google.workspace.chat.message.v1.created")
|
|
3378
|
+
* ```
|
|
3379
|
+
*
|
|
3380
|
+
* The following queries are invalid:
|
|
3381
|
+
*
|
|
3382
|
+
* ```
|
|
3383
|
+
* start_time="2023-08-23T19:20:33+00:00" OR
|
|
3384
|
+
* end_time="2023-08-23T19:21:54+00:00"
|
|
3385
|
+
* ```
|
|
3386
|
+
* ```
|
|
3387
|
+
* event_types:"google.workspace.chat.space.v1.updated" AND
|
|
3388
|
+
* event_types:"google.workspace.chat.message.v1.created"
|
|
3389
|
+
* ```
|
|
3390
|
+
*
|
|
3391
|
+
* Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
|
|
3392
|
+
* error.
|
|
3393
|
+
* @param {object} [options]
|
|
3394
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
3395
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
3396
|
+
* The first element of the array is Array of {@link protos.google.chat.v1.SpaceEvent|SpaceEvent}.
|
|
3397
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
3398
|
+
* times as needed and will merge results from all the pages into this array.
|
|
3399
|
+
* Note that it can affect your quota.
|
|
3400
|
+
* We recommend using `listSpaceEventsAsync()`
|
|
3401
|
+
* method described below for async iteration which you can stop as needed.
|
|
3402
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
3403
|
+
* for more details and examples.
|
|
3404
|
+
*/
|
|
3140
3405
|
listSpaceEvents(request?: protos.google.chat.v1.IListSpaceEventsRequest, options?: CallOptions): Promise<[
|
|
3141
3406
|
protos.google.chat.v1.ISpaceEvent[],
|
|
3142
3407
|
protos.google.chat.v1.IListSpaceEventsRequest | null,
|
|
@@ -3354,6 +3619,21 @@ export declare class ChatServiceClient {
|
|
|
3354
3619
|
* @returns {string} A string representing the attachment.
|
|
3355
3620
|
*/
|
|
3356
3621
|
matchAttachmentFromAttachmentName(attachmentName: string): string | number;
|
|
3622
|
+
/**
|
|
3623
|
+
* Return a fully-qualified customEmoji resource name string.
|
|
3624
|
+
*
|
|
3625
|
+
* @param {string} custom_emoji
|
|
3626
|
+
* @returns {string} Resource name string.
|
|
3627
|
+
*/
|
|
3628
|
+
customEmojiPath(customEmoji: string): string;
|
|
3629
|
+
/**
|
|
3630
|
+
* Parse the custom_emoji from CustomEmoji resource.
|
|
3631
|
+
*
|
|
3632
|
+
* @param {string} customEmojiName
|
|
3633
|
+
* A fully-qualified path representing CustomEmoji resource.
|
|
3634
|
+
* @returns {string} A string representing the custom_emoji.
|
|
3635
|
+
*/
|
|
3636
|
+
matchCustomEmojiFromCustomEmojiName(customEmojiName: string): string | number;
|
|
3357
3637
|
/**
|
|
3358
3638
|
* Return a fully-qualified membership resource name string.
|
|
3359
3639
|
*
|