google-apis-chat_v1 0.65.0 → 0.67.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/lib/google/apis/chat_v1/classes.rb +350 -255
- data/lib/google/apis/chat_v1/gem_version.rb +2 -2
- data/lib/google/apis/chat_v1/representations.rb +1 -0
- data/lib/google/apis/chat_v1/service.rb +54 -41
- metadata +3 -3
|
@@ -415,20 +415,22 @@ module Google
|
|
|
415
415
|
# creates a "contact card" that features: - A header with the contact's name,
|
|
416
416
|
# job title, and avatar picture. - A section with the contact information,
|
|
417
417
|
# including formatted text. - Buttons that users can click to share the contact,
|
|
418
|
-
# or see more or less information.
|
|
419
|
-
# google.com/chat/
|
|
420
|
-
#
|
|
421
|
-
#
|
|
422
|
-
#
|
|
423
|
-
# "
|
|
424
|
-
#
|
|
425
|
-
# "
|
|
426
|
-
# ` "
|
|
427
|
-
#
|
|
428
|
-
#
|
|
429
|
-
# "
|
|
430
|
-
#
|
|
431
|
-
#
|
|
418
|
+
# or see more or less information. For more examples, see [Design dynamic,
|
|
419
|
+
# interactive, and consistent UIs with cards](https://developers.google.com/chat/
|
|
420
|
+
# ui).  ``` ` "cardsV2": [ ` "cardId": "unique-card-id", "card"
|
|
422
|
+
# : ` "header": ` "title": "Sasha", "subtitle": "Software Engineer", "imageUrl":
|
|
423
|
+
# "https://developers.google.com/chat/images/quickstart-app-avatar.png", "
|
|
424
|
+
# imageType": "CIRCLE", "imageAltText": "Avatar for Sasha", `, "sections": [ ` "
|
|
425
|
+
# header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "
|
|
426
|
+
# widgets": [ ` "decoratedText": ` "startIcon": ` "knownIcon": "EMAIL", `, "text"
|
|
427
|
+
# : "sasha@example.com", ` `, ` "decoratedText": ` "startIcon": ` "knownIcon": "
|
|
428
|
+
# PERSON", `, "text": "Online", `, `, ` "decoratedText": ` "startIcon": ` "
|
|
429
|
+
# knownIcon": "PHONE", `, "text": "+1 (555) 555-1234", ` `, ` "buttonList": ` "
|
|
430
|
+
# buttons": [ ` "text": "Share", "onClick": ` "openLink": ` "url": "https://
|
|
431
|
+
# example.com/share", ` ` `, ` "text": "Edit", "onClick": ` "action": ` "
|
|
432
|
+
# function": "goToView", "parameters": [ ` "key": "viewType", "value": "EDIT", `
|
|
433
|
+
# ], ` ` `, ], ` `, ], `, ], `, ` ], ` ```
|
|
432
434
|
# Corresponds to the JSON property `card`
|
|
433
435
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Card]
|
|
434
436
|
attr_accessor :card
|
|
@@ -846,7 +848,10 @@ module Google
|
|
|
846
848
|
# @return [String]
|
|
847
849
|
attr_accessor :type
|
|
848
850
|
|
|
849
|
-
# A user in Google Chat.
|
|
851
|
+
# A user in Google Chat. When returned as an output from a request, if your Chat
|
|
852
|
+
# app [authenticates as a user](https://developers.google.com/chat/api/guides/
|
|
853
|
+
# auth/users), the output for a `User` resource only populates the user's `name`
|
|
854
|
+
# and `type`.
|
|
850
855
|
# Corresponds to the JSON property `user`
|
|
851
856
|
# @return [Google::Apis::ChatV1::User]
|
|
852
857
|
attr_accessor :user
|
|
@@ -885,20 +890,22 @@ module Google
|
|
|
885
890
|
# creates a "contact card" that features: - A header with the contact's name,
|
|
886
891
|
# job title, and avatar picture. - A section with the contact information,
|
|
887
892
|
# including formatted text. - Buttons that users can click to share the contact,
|
|
888
|
-
# or see more or less information.
|
|
889
|
-
# google.com/chat/
|
|
890
|
-
#
|
|
891
|
-
#
|
|
892
|
-
#
|
|
893
|
-
# "
|
|
894
|
-
#
|
|
895
|
-
# "
|
|
896
|
-
# ` "
|
|
897
|
-
#
|
|
898
|
-
#
|
|
899
|
-
# "
|
|
900
|
-
#
|
|
901
|
-
#
|
|
893
|
+
# or see more or less information. For more examples, see [Design dynamic,
|
|
894
|
+
# interactive, and consistent UIs with cards](https://developers.google.com/chat/
|
|
895
|
+
# ui).  ``` ` "cardsV2": [ ` "cardId": "unique-card-id", "card"
|
|
897
|
+
# : ` "header": ` "title": "Sasha", "subtitle": "Software Engineer", "imageUrl":
|
|
898
|
+
# "https://developers.google.com/chat/images/quickstart-app-avatar.png", "
|
|
899
|
+
# imageType": "CIRCLE", "imageAltText": "Avatar for Sasha", `, "sections": [ ` "
|
|
900
|
+
# header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "
|
|
901
|
+
# widgets": [ ` "decoratedText": ` "startIcon": ` "knownIcon": "EMAIL", `, "text"
|
|
902
|
+
# : "sasha@example.com", ` `, ` "decoratedText": ` "startIcon": ` "knownIcon": "
|
|
903
|
+
# PERSON", `, "text": "Online", `, `, ` "decoratedText": ` "startIcon": ` "
|
|
904
|
+
# knownIcon": "PHONE", `, "text": "+1 (555) 555-1234", ` `, ` "buttonList": ` "
|
|
905
|
+
# buttons": [ ` "text": "Share", "onClick": ` "openLink": ` "url": "https://
|
|
906
|
+
# example.com/share", ` ` `, ` "text": "Edit", "onClick": ` "action": ` "
|
|
907
|
+
# function": "goToView", "parameters": [ ` "key": "viewType", "value": "EDIT", `
|
|
908
|
+
# ], ` ` `, ], ` `, ], `, ], `, ` ], ` ```
|
|
902
909
|
# Corresponds to the JSON property `body`
|
|
903
910
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Card]
|
|
904
911
|
attr_accessor :body
|
|
@@ -1231,9 +1238,10 @@ module Google
|
|
|
1231
1238
|
end
|
|
1232
1239
|
end
|
|
1233
1240
|
|
|
1234
|
-
# A text, icon, or text and icon button that users can click.
|
|
1235
|
-
#
|
|
1236
|
-
#
|
|
1241
|
+
# A text, icon, or text and icon button that users can click. For an example in
|
|
1242
|
+
# Google Chat apps, see [Button list](https://developers.google.com/chat/ui/
|
|
1243
|
+
# widgets/button-list). To make an image a clickable button, specify an `Image` (
|
|
1244
|
+
# not an `ImageComponent`) and set an `onClick` action.
|
|
1237
1245
|
class GoogleAppsCardV1Button
|
|
1238
1246
|
include Google::Apis::Core::Hashable
|
|
1239
1247
|
|
|
@@ -1301,10 +1309,11 @@ module Google
|
|
|
1301
1309
|
attr_accessor :disabled
|
|
1302
1310
|
alias_method :disabled?, :disabled
|
|
1303
1311
|
|
|
1304
|
-
# An icon displayed in a widget on a card.
|
|
1305
|
-
# developers.google.com/chat/
|
|
1306
|
-
#
|
|
1307
|
-
#
|
|
1312
|
+
# An icon displayed in a widget on a card. For an example in Google Chat apps,
|
|
1313
|
+
# see [Icon](https://developers.google.com/chat/ui/widgets/icon). Supports [
|
|
1314
|
+
# built-in](https://developers.google.com/chat/api/guides/message-formats/cards#
|
|
1315
|
+
# builtinicons) and [custom](https://developers.google.com/chat/api/guides/
|
|
1316
|
+
# message-formats/cards#customicons) icons.
|
|
1308
1317
|
# Corresponds to the JSON property `icon`
|
|
1309
1318
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Icon]
|
|
1310
1319
|
attr_accessor :icon
|
|
@@ -1335,7 +1344,8 @@ module Google
|
|
|
1335
1344
|
end
|
|
1336
1345
|
end
|
|
1337
1346
|
|
|
1338
|
-
# A list of buttons layed out horizontally.
|
|
1347
|
+
# A list of buttons layed out horizontally. For an example in Google Chat apps,
|
|
1348
|
+
# see [Button list](https://developers.google.com/chat/ui/widgets/button-list).
|
|
1339
1349
|
class GoogleAppsCardV1ButtonList
|
|
1340
1350
|
include Google::Apis::Core::Hashable
|
|
1341
1351
|
|
|
@@ -1363,20 +1373,22 @@ module Google
|
|
|
1363
1373
|
# creates a "contact card" that features: - A header with the contact's name,
|
|
1364
1374
|
# job title, and avatar picture. - A section with the contact information,
|
|
1365
1375
|
# including formatted text. - Buttons that users can click to share the contact,
|
|
1366
|
-
# or see more or less information.
|
|
1367
|
-
# google.com/chat/
|
|
1368
|
-
#
|
|
1369
|
-
#
|
|
1370
|
-
#
|
|
1371
|
-
# "
|
|
1372
|
-
#
|
|
1373
|
-
# "
|
|
1374
|
-
# ` "
|
|
1375
|
-
#
|
|
1376
|
-
#
|
|
1377
|
-
# "
|
|
1378
|
-
#
|
|
1379
|
-
#
|
|
1376
|
+
# or see more or less information. For more examples, see [Design dynamic,
|
|
1377
|
+
# interactive, and consistent UIs with cards](https://developers.google.com/chat/
|
|
1378
|
+
# ui).  ``` ` "cardsV2": [ ` "cardId": "unique-card-id", "card"
|
|
1380
|
+
# : ` "header": ` "title": "Sasha", "subtitle": "Software Engineer", "imageUrl":
|
|
1381
|
+
# "https://developers.google.com/chat/images/quickstart-app-avatar.png", "
|
|
1382
|
+
# imageType": "CIRCLE", "imageAltText": "Avatar for Sasha", `, "sections": [ ` "
|
|
1383
|
+
# header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "
|
|
1384
|
+
# widgets": [ ` "decoratedText": ` "startIcon": ` "knownIcon": "EMAIL", `, "text"
|
|
1385
|
+
# : "sasha@example.com", ` `, ` "decoratedText": ` "startIcon": ` "knownIcon": "
|
|
1386
|
+
# PERSON", `, "text": "Online", `, `, ` "decoratedText": ` "startIcon": ` "
|
|
1387
|
+
# knownIcon": "PHONE", `, "text": "+1 (555) 555-1234", ` `, ` "buttonList": ` "
|
|
1388
|
+
# buttons": [ ` "text": "Share", "onClick": ` "openLink": ` "url": "https://
|
|
1389
|
+
# example.com/share", ` ` `, ` "text": "Edit", "onClick": ` "action": ` "
|
|
1390
|
+
# function": "goToView", "parameters": [ ` "key": "viewType", "value": "EDIT", `
|
|
1391
|
+
# ], ` ` `, ], ` `, ], `, ], `, ` ], ` ```
|
|
1380
1392
|
class GoogleAppsCardV1Card
|
|
1381
1393
|
include Google::Apis::Core::Hashable
|
|
1382
1394
|
|
|
@@ -1398,17 +1410,20 @@ module Google
|
|
|
1398
1410
|
# @return [String]
|
|
1399
1411
|
attr_accessor :display_style
|
|
1400
1412
|
|
|
1401
|
-
# A persistent (sticky) footer that that appears at the bottom of the card.
|
|
1402
|
-
#
|
|
1403
|
-
#
|
|
1404
|
-
#
|
|
1405
|
-
#
|
|
1406
|
-
# developers.google.com/chat/
|
|
1413
|
+
# A persistent (sticky) footer that that appears at the bottom of the card. For
|
|
1414
|
+
# an example in Google Chat apps, see [Card footer](https://developers.google.
|
|
1415
|
+
# com/chat/ui/widgets/card-fixed-footer). Setting `fixedFooter` without
|
|
1416
|
+
# specifying a `primaryButton` or a `secondaryButton` causes an error. Supported
|
|
1417
|
+
# by Google Workspace Add-ons and Chat apps. For Chat apps, you can use fixed
|
|
1418
|
+
# footers in [dialogs](https://developers.google.com/chat/how-tos/dialogs), but
|
|
1419
|
+
# not [card messages](https://developers.google.com/chat/api/guides/message-
|
|
1420
|
+
# formats/cards).
|
|
1407
1421
|
# Corresponds to the JSON property `fixedFooter`
|
|
1408
1422
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1CardFixedFooter]
|
|
1409
1423
|
attr_accessor :fixed_footer
|
|
1410
1424
|
|
|
1411
|
-
# Represents a card header.
|
|
1425
|
+
# Represents a card header. For an example in Google Chat apps, see [Card header]
|
|
1426
|
+
# (https://developers.google.com/chat/ui/widgets/card-header).
|
|
1412
1427
|
# Corresponds to the JSON property `header`
|
|
1413
1428
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1CardHeader]
|
|
1414
1429
|
attr_accessor :header
|
|
@@ -1419,7 +1434,8 @@ module Google
|
|
|
1419
1434
|
# @return [String]
|
|
1420
1435
|
attr_accessor :name
|
|
1421
1436
|
|
|
1422
|
-
# Represents a card header.
|
|
1437
|
+
# Represents a card header. For an example in Google Chat apps, see [Card header]
|
|
1438
|
+
# (https://developers.google.com/chat/ui/widgets/card-header).
|
|
1423
1439
|
# Corresponds to the JSON property `peekCardHeader`
|
|
1424
1440
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1CardHeader]
|
|
1425
1441
|
attr_accessor :peek_card_header
|
|
@@ -1430,7 +1446,9 @@ module Google
|
|
|
1430
1446
|
attr_accessor :section_divider_style
|
|
1431
1447
|
|
|
1432
1448
|
# Contains a collection of widgets. Each section has its own, optional header.
|
|
1433
|
-
# Sections are visually separated by a line divider.
|
|
1449
|
+
# Sections are visually separated by a line divider. For an example in Google
|
|
1450
|
+
# Chat apps, see [Card section](https://developers.google.com/chat/ui/widgets/
|
|
1451
|
+
# card-section).
|
|
1434
1452
|
# Corresponds to the JSON property `sections`
|
|
1435
1453
|
# @return [Array<Google::Apis::ChatV1::GoogleAppsCardV1Section>]
|
|
1436
1454
|
attr_accessor :sections
|
|
@@ -1480,25 +1498,29 @@ module Google
|
|
|
1480
1498
|
end
|
|
1481
1499
|
end
|
|
1482
1500
|
|
|
1483
|
-
# A persistent (sticky) footer that that appears at the bottom of the card.
|
|
1484
|
-
#
|
|
1485
|
-
#
|
|
1486
|
-
#
|
|
1487
|
-
#
|
|
1488
|
-
# developers.google.com/chat/
|
|
1501
|
+
# A persistent (sticky) footer that that appears at the bottom of the card. For
|
|
1502
|
+
# an example in Google Chat apps, see [Card footer](https://developers.google.
|
|
1503
|
+
# com/chat/ui/widgets/card-fixed-footer). Setting `fixedFooter` without
|
|
1504
|
+
# specifying a `primaryButton` or a `secondaryButton` causes an error. Supported
|
|
1505
|
+
# by Google Workspace Add-ons and Chat apps. For Chat apps, you can use fixed
|
|
1506
|
+
# footers in [dialogs](https://developers.google.com/chat/how-tos/dialogs), but
|
|
1507
|
+
# not [card messages](https://developers.google.com/chat/api/guides/message-
|
|
1508
|
+
# formats/cards).
|
|
1489
1509
|
class GoogleAppsCardV1CardFixedFooter
|
|
1490
1510
|
include Google::Apis::Core::Hashable
|
|
1491
1511
|
|
|
1492
|
-
# A text, icon, or text and icon button that users can click.
|
|
1493
|
-
#
|
|
1494
|
-
#
|
|
1512
|
+
# A text, icon, or text and icon button that users can click. For an example in
|
|
1513
|
+
# Google Chat apps, see [Button list](https://developers.google.com/chat/ui/
|
|
1514
|
+
# widgets/button-list). To make an image a clickable button, specify an `Image` (
|
|
1515
|
+
# not an `ImageComponent`) and set an `onClick` action.
|
|
1495
1516
|
# Corresponds to the JSON property `primaryButton`
|
|
1496
1517
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Button]
|
|
1497
1518
|
attr_accessor :primary_button
|
|
1498
1519
|
|
|
1499
|
-
# A text, icon, or text and icon button that users can click.
|
|
1500
|
-
#
|
|
1501
|
-
#
|
|
1520
|
+
# A text, icon, or text and icon button that users can click. For an example in
|
|
1521
|
+
# Google Chat apps, see [Button list](https://developers.google.com/chat/ui/
|
|
1522
|
+
# widgets/button-list). To make an image a clickable button, specify an `Image` (
|
|
1523
|
+
# not an `ImageComponent`) and set an `onClick` action.
|
|
1502
1524
|
# Corresponds to the JSON property `secondaryButton`
|
|
1503
1525
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Button]
|
|
1504
1526
|
attr_accessor :secondary_button
|
|
@@ -1514,7 +1536,8 @@ module Google
|
|
|
1514
1536
|
end
|
|
1515
1537
|
end
|
|
1516
1538
|
|
|
1517
|
-
# Represents a card header.
|
|
1539
|
+
# Represents a card header. For an example in Google Chat apps, see [Card header]
|
|
1540
|
+
# (https://developers.google.com/chat/ui/widgets/card-header).
|
|
1518
1541
|
class GoogleAppsCardV1CardHeader
|
|
1519
1542
|
include Google::Apis::Core::Hashable
|
|
1520
1543
|
|
|
@@ -1600,19 +1623,20 @@ module Google
|
|
|
1600
1623
|
|
|
1601
1624
|
# The `Columns` widget displays up to 2 columns in a card message or dialog. You
|
|
1602
1625
|
# can add widgets to each column; the widgets appear in the order that they are
|
|
1603
|
-
# specified.
|
|
1604
|
-
#
|
|
1605
|
-
#
|
|
1606
|
-
#
|
|
1607
|
-
#
|
|
1608
|
-
#
|
|
1609
|
-
#
|
|
1610
|
-
#
|
|
1611
|
-
# On
|
|
1612
|
-
# equal to
|
|
1613
|
-
# width is less than or equal to
|
|
1614
|
-
#
|
|
1615
|
-
#
|
|
1626
|
+
# specified. For an example in Google Chat apps, see [Columns](https://
|
|
1627
|
+
# developers.google.com/chat/ui/widgets/columns). The height of each column is
|
|
1628
|
+
# determined by the taller column. For example, if the first column is taller
|
|
1629
|
+
# than the second column, both columns have the height of the first column.
|
|
1630
|
+
# Because each column can contain a different number of widgets, you can't
|
|
1631
|
+
# define rows or align widgets between the columns. Columns are displayed side-
|
|
1632
|
+
# by-side. You can customize the width of each column using the `
|
|
1633
|
+
# HorizontalSizeStyle` field. If the user's screen width is too narrow, the
|
|
1634
|
+
# second column wraps below the first: * On web, the second column wraps if the
|
|
1635
|
+
# screen width is less than or equal to 480 pixels. * On iOS devices, the second
|
|
1636
|
+
# column wraps if the screen width is less than or equal to 300 pt. * On Android
|
|
1637
|
+
# devices, the second column wraps if the screen width is less than or equal to
|
|
1638
|
+
# 320 dp. To include more than 2 columns, or to use rows, use the `Grid` widget.
|
|
1639
|
+
# Supported by Chat apps, but not Google Workspace Add-ons.
|
|
1616
1640
|
class GoogleAppsCardV1Columns
|
|
1617
1641
|
include Google::Apis::Core::Hashable
|
|
1618
1642
|
|
|
@@ -1631,10 +1655,11 @@ module Google
|
|
|
1631
1655
|
end
|
|
1632
1656
|
end
|
|
1633
1657
|
|
|
1634
|
-
# Lets users input a date, a time, or both a date and a time.
|
|
1635
|
-
#
|
|
1636
|
-
# date
|
|
1637
|
-
#
|
|
1658
|
+
# Lets users input a date, a time, or both a date and a time. For an example in
|
|
1659
|
+
# Google Chat apps, see [Date time picker](https://developers.google.com/chat/ui/
|
|
1660
|
+
# widgets/date-time-picker). Users can input text or use the picker to select
|
|
1661
|
+
# dates and times. If users input an invalid date or time, the picker shows an
|
|
1662
|
+
# error that prompts users to input the information correctly.
|
|
1638
1663
|
class GoogleAppsCardV1DateTimePicker
|
|
1639
1664
|
include Google::Apis::Core::Hashable
|
|
1640
1665
|
|
|
@@ -1647,7 +1672,7 @@ module Google
|
|
|
1647
1672
|
|
|
1648
1673
|
# The name by which the `DateTimePicker` is identified in a form input event.
|
|
1649
1674
|
# For details about working with form inputs, see [Receive form data](https://
|
|
1650
|
-
# developers.google.com/chat/
|
|
1675
|
+
# developers.google.com/chat/ui/read-form-data).
|
|
1651
1676
|
# Corresponds to the JSON property `name`
|
|
1652
1677
|
# @return [String]
|
|
1653
1678
|
attr_accessor :name
|
|
@@ -1700,7 +1725,8 @@ module Google
|
|
|
1700
1725
|
|
|
1701
1726
|
# A widget that displays text with optional decorations such as a label above or
|
|
1702
1727
|
# below the text, an icon in front of the text, a selection widget, or a button
|
|
1703
|
-
# after the text.
|
|
1728
|
+
# after the text. For an example in Google Chat apps, see [Decorated text](https:
|
|
1729
|
+
# //developers.google.com/chat/ui/widgets/decorated-text).
|
|
1704
1730
|
class GoogleAppsCardV1DecoratedText
|
|
1705
1731
|
include Google::Apis::Core::Hashable
|
|
1706
1732
|
|
|
@@ -1709,25 +1735,28 @@ module Google
|
|
|
1709
1735
|
# @return [String]
|
|
1710
1736
|
attr_accessor :bottom_label
|
|
1711
1737
|
|
|
1712
|
-
# A text, icon, or text and icon button that users can click.
|
|
1713
|
-
#
|
|
1714
|
-
#
|
|
1738
|
+
# A text, icon, or text and icon button that users can click. For an example in
|
|
1739
|
+
# Google Chat apps, see [Button list](https://developers.google.com/chat/ui/
|
|
1740
|
+
# widgets/button-list). To make an image a clickable button, specify an `Image` (
|
|
1741
|
+
# not an `ImageComponent`) and set an `onClick` action.
|
|
1715
1742
|
# Corresponds to the JSON property `button`
|
|
1716
1743
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Button]
|
|
1717
1744
|
attr_accessor :button
|
|
1718
1745
|
|
|
1719
|
-
# An icon displayed in a widget on a card.
|
|
1720
|
-
# developers.google.com/chat/
|
|
1721
|
-
#
|
|
1722
|
-
#
|
|
1746
|
+
# An icon displayed in a widget on a card. For an example in Google Chat apps,
|
|
1747
|
+
# see [Icon](https://developers.google.com/chat/ui/widgets/icon). Supports [
|
|
1748
|
+
# built-in](https://developers.google.com/chat/api/guides/message-formats/cards#
|
|
1749
|
+
# builtinicons) and [custom](https://developers.google.com/chat/api/guides/
|
|
1750
|
+
# message-formats/cards#customicons) icons.
|
|
1723
1751
|
# Corresponds to the JSON property `endIcon`
|
|
1724
1752
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Icon]
|
|
1725
1753
|
attr_accessor :end_icon
|
|
1726
1754
|
|
|
1727
|
-
# An icon displayed in a widget on a card.
|
|
1728
|
-
# developers.google.com/chat/
|
|
1729
|
-
#
|
|
1730
|
-
#
|
|
1755
|
+
# An icon displayed in a widget on a card. For an example in Google Chat apps,
|
|
1756
|
+
# see [Icon](https://developers.google.com/chat/ui/widgets/icon). Supports [
|
|
1757
|
+
# built-in](https://developers.google.com/chat/api/guides/message-formats/cards#
|
|
1758
|
+
# builtinicons) and [custom](https://developers.google.com/chat/api/guides/
|
|
1759
|
+
# message-formats/cards#customicons) icons.
|
|
1731
1760
|
# Corresponds to the JSON property `icon`
|
|
1732
1761
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Icon]
|
|
1733
1762
|
attr_accessor :icon
|
|
@@ -1738,10 +1767,11 @@ module Google
|
|
|
1738
1767
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1OnClick]
|
|
1739
1768
|
attr_accessor :on_click
|
|
1740
1769
|
|
|
1741
|
-
# An icon displayed in a widget on a card.
|
|
1742
|
-
# developers.google.com/chat/
|
|
1743
|
-
#
|
|
1744
|
-
#
|
|
1770
|
+
# An icon displayed in a widget on a card. For an example in Google Chat apps,
|
|
1771
|
+
# see [Icon](https://developers.google.com/chat/ui/widgets/icon). Supports [
|
|
1772
|
+
# built-in](https://developers.google.com/chat/api/guides/message-formats/cards#
|
|
1773
|
+
# builtinicons) and [custom](https://developers.google.com/chat/api/guides/
|
|
1774
|
+
# message-formats/cards#customicons) icons.
|
|
1745
1775
|
# Corresponds to the JSON property `startIcon`
|
|
1746
1776
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Icon]
|
|
1747
1777
|
attr_accessor :start_icon
|
|
@@ -1754,9 +1784,9 @@ module Google
|
|
|
1754
1784
|
|
|
1755
1785
|
# Required. The primary text. Supports simple formatting. For more information
|
|
1756
1786
|
# about formatting text, see [Formatting text in Google Chat apps](https://
|
|
1757
|
-
# developers.google.com/chat/api/guides/message-formats/cards#
|
|
1758
|
-
#
|
|
1759
|
-
#
|
|
1787
|
+
# developers.google.com/chat/api/guides/message-formats/cards#card-formatting)
|
|
1788
|
+
# and [Formatting text in Google Workspace Add-ons](https://developers.google.
|
|
1789
|
+
# com/apps-script/add-ons/concepts/widgets#text_formatting).
|
|
1760
1790
|
# Corresponds to the JSON property `text`
|
|
1761
1791
|
# @return [String]
|
|
1762
1792
|
attr_accessor :text
|
|
@@ -1793,8 +1823,10 @@ module Google
|
|
|
1793
1823
|
end
|
|
1794
1824
|
end
|
|
1795
1825
|
|
|
1796
|
-
# Displays a divider between widgets as a horizontal line. For example
|
|
1797
|
-
#
|
|
1826
|
+
# Displays a divider between widgets as a horizontal line. For an example in
|
|
1827
|
+
# Google Chat apps, see [Divider](https://developers.google.com/chat/ui/widgets/
|
|
1828
|
+
# divider). For example, the following JSON creates a divider: ``` "divider": ``
|
|
1829
|
+
# ```
|
|
1798
1830
|
class GoogleAppsCardV1Divider
|
|
1799
1831
|
include Google::Apis::Core::Hashable
|
|
1800
1832
|
|
|
@@ -1808,16 +1840,18 @@ module Google
|
|
|
1808
1840
|
end
|
|
1809
1841
|
|
|
1810
1842
|
# Displays a grid with a collection of items. Items can only include text or
|
|
1811
|
-
# images.
|
|
1812
|
-
#
|
|
1813
|
-
#
|
|
1814
|
-
#
|
|
1815
|
-
#
|
|
1816
|
-
#
|
|
1817
|
-
# :
|
|
1818
|
-
#
|
|
1819
|
-
# "
|
|
1820
|
-
#
|
|
1843
|
+
# images. For responsive columns, or to include more than text or images, use `
|
|
1844
|
+
# Columns`. For an example in Google Chat apps, see [Grid](https://developers.
|
|
1845
|
+
# google.com/chat/ui/widgets/grid). A grid supports any number of columns and
|
|
1846
|
+
# items. The number of rows is determined by items divided by columns. A grid
|
|
1847
|
+
# with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has
|
|
1848
|
+
# 6 rows. For example, the following JSON creates a 2 column grid with a single
|
|
1849
|
+
# item: ``` "grid": ` "title": "A fine collection of items", "columnCount": 2, "
|
|
1850
|
+
# borderStyle": ` "type": "STROKE", "cornerRadius": 4 `, "items": [ ` "image": `
|
|
1851
|
+
# "imageUri": "https://www.example.com/image.png", "cropStyle": ` "type": "
|
|
1852
|
+
# SQUARE" `, "borderStyle": ` "type": "STROKE" ` `, "title": "An item", "
|
|
1853
|
+
# textAlignment": "CENTER" ` ], "onClick": ` "openLink": ` "url": "https://www.
|
|
1854
|
+
# example.com" ` ` ` ```
|
|
1821
1855
|
class GoogleAppsCardV1Grid
|
|
1822
1856
|
include Google::Apis::Core::Hashable
|
|
1823
1857
|
|
|
@@ -1909,10 +1943,11 @@ module Google
|
|
|
1909
1943
|
end
|
|
1910
1944
|
end
|
|
1911
1945
|
|
|
1912
|
-
# An icon displayed in a widget on a card.
|
|
1913
|
-
# developers.google.com/chat/
|
|
1914
|
-
#
|
|
1915
|
-
#
|
|
1946
|
+
# An icon displayed in a widget on a card. For an example in Google Chat apps,
|
|
1947
|
+
# see [Icon](https://developers.google.com/chat/ui/widgets/icon). Supports [
|
|
1948
|
+
# built-in](https://developers.google.com/chat/api/guides/message-formats/cards#
|
|
1949
|
+
# builtinicons) and [custom](https://developers.google.com/chat/api/guides/
|
|
1950
|
+
# message-formats/cards#customicons) icons.
|
|
1916
1951
|
class GoogleAppsCardV1Icon
|
|
1917
1952
|
include Google::Apis::Core::Hashable
|
|
1918
1953
|
|
|
@@ -1962,7 +1997,8 @@ module Google
|
|
|
1962
1997
|
end
|
|
1963
1998
|
end
|
|
1964
1999
|
|
|
1965
|
-
# An image that is specified by a URL and can have an `onClick` action.
|
|
2000
|
+
# An image that is specified by a URL and can have an `onClick` action. For an
|
|
2001
|
+
# example, see [Image](https://developers.google.com/chat/ui/widgets/image).
|
|
1966
2002
|
class GoogleAppsCardV1Image
|
|
1967
2003
|
include Google::Apis::Core::Hashable
|
|
1968
2004
|
|
|
@@ -2085,20 +2121,22 @@ module Google
|
|
|
2085
2121
|
# creates a "contact card" that features: - A header with the contact's name,
|
|
2086
2122
|
# job title, and avatar picture. - A section with the contact information,
|
|
2087
2123
|
# including formatted text. - Buttons that users can click to share the contact,
|
|
2088
|
-
# or see more or less information.
|
|
2089
|
-
# google.com/chat/
|
|
2090
|
-
#
|
|
2091
|
-
#
|
|
2092
|
-
#
|
|
2093
|
-
# "
|
|
2094
|
-
#
|
|
2095
|
-
# "
|
|
2096
|
-
# ` "
|
|
2097
|
-
#
|
|
2098
|
-
#
|
|
2099
|
-
# "
|
|
2100
|
-
#
|
|
2101
|
-
#
|
|
2124
|
+
# or see more or less information. For more examples, see [Design dynamic,
|
|
2125
|
+
# interactive, and consistent UIs with cards](https://developers.google.com/chat/
|
|
2126
|
+
# ui).  ``` ` "cardsV2": [ ` "cardId": "unique-card-id", "card"
|
|
2128
|
+
# : ` "header": ` "title": "Sasha", "subtitle": "Software Engineer", "imageUrl":
|
|
2129
|
+
# "https://developers.google.com/chat/images/quickstart-app-avatar.png", "
|
|
2130
|
+
# imageType": "CIRCLE", "imageAltText": "Avatar for Sasha", `, "sections": [ ` "
|
|
2131
|
+
# header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "
|
|
2132
|
+
# widgets": [ ` "decoratedText": ` "startIcon": ` "knownIcon": "EMAIL", `, "text"
|
|
2133
|
+
# : "sasha@example.com", ` `, ` "decoratedText": ` "startIcon": ` "knownIcon": "
|
|
2134
|
+
# PERSON", `, "text": "Online", `, `, ` "decoratedText": ` "startIcon": ` "
|
|
2135
|
+
# knownIcon": "PHONE", `, "text": "+1 (555) 555-1234", ` `, ` "buttonList": ` "
|
|
2136
|
+
# buttons": [ ` "text": "Share", "onClick": ` "openLink": ` "url": "https://
|
|
2137
|
+
# example.com/share", ` ` `, ` "text": "Edit", "onClick": ` "action": ` "
|
|
2138
|
+
# function": "goToView", "parameters": [ ` "key": "viewType", "value": "EDIT", `
|
|
2139
|
+
# ], ` ` `, ], ` `, ], `, ], `, ` ], ` ```
|
|
2102
2140
|
# Corresponds to the JSON property `card`
|
|
2103
2141
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Card]
|
|
2104
2142
|
attr_accessor :card
|
|
@@ -2212,8 +2250,8 @@ module Google
|
|
|
2212
2250
|
# Text that appears at the top of a section. Supports simple HTML formatted text.
|
|
2213
2251
|
# For more information about formatting text, see [Formatting text in Google
|
|
2214
2252
|
# Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#
|
|
2215
|
-
#
|
|
2216
|
-
#
|
|
2253
|
+
# card-formatting) and [Formatting text in Google Workspace Add-ons](https://
|
|
2254
|
+
# developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
|
|
2217
2255
|
# Corresponds to the JSON property `header`
|
|
2218
2256
|
# @return [String]
|
|
2219
2257
|
attr_accessor :header
|
|
@@ -2248,11 +2286,12 @@ module Google
|
|
|
2248
2286
|
|
|
2249
2287
|
# A widget that creates one or more UI items that users can select. For example,
|
|
2250
2288
|
# a dropdown menu or checkboxes. You can use this widget to collect data that
|
|
2251
|
-
# can be predicted or enumerated.
|
|
2252
|
-
#
|
|
2253
|
-
#
|
|
2254
|
-
#
|
|
2255
|
-
#
|
|
2289
|
+
# can be predicted or enumerated. For an example in Google Chat apps, see [
|
|
2290
|
+
# Selection input](https://developers.google.com/chat/ui/widgets/selection-input)
|
|
2291
|
+
# . Chat apps can process the value of items that users select or input. For
|
|
2292
|
+
# details about working with form inputs, see [Receive form data](https://
|
|
2293
|
+
# developers.google.com/chat/ui/read-form-data). To collect undefined or
|
|
2294
|
+
# abstract data from users, use the TextInput widget.
|
|
2256
2295
|
class GoogleAppsCardV1SelectionInput
|
|
2257
2296
|
include Google::Apis::Core::Hashable
|
|
2258
2297
|
|
|
@@ -2295,7 +2334,7 @@ module Google
|
|
|
2295
2334
|
|
|
2296
2335
|
# The name that identifies the selection input in a form input event. For
|
|
2297
2336
|
# details about working with form inputs, see [Receive form data](https://
|
|
2298
|
-
# developers.google.com/chat/
|
|
2337
|
+
# developers.google.com/chat/ui/read-form-data).
|
|
2299
2338
|
# Corresponds to the JSON property `name`
|
|
2300
2339
|
# @return [String]
|
|
2301
2340
|
attr_accessor :name
|
|
@@ -2377,8 +2416,7 @@ module Google
|
|
|
2377
2416
|
|
|
2378
2417
|
# The value associated with this item. The client should use this as a form
|
|
2379
2418
|
# input value. For details about working with form inputs, see [Receive form
|
|
2380
|
-
# data](https://developers.google.com/chat/
|
|
2381
|
-
# receive_form_data_from_dialogs).
|
|
2419
|
+
# data](https://developers.google.com/chat/ui/read-form-data).
|
|
2382
2420
|
# Corresponds to the JSON property `value`
|
|
2383
2421
|
# @return [String]
|
|
2384
2422
|
attr_accessor :value
|
|
@@ -2458,7 +2496,7 @@ module Google
|
|
|
2458
2496
|
|
|
2459
2497
|
# The name by which the switch widget is identified in a form input event. For
|
|
2460
2498
|
# details about working with form inputs, see [Receive form data](https://
|
|
2461
|
-
# developers.google.com/chat/
|
|
2499
|
+
# developers.google.com/chat/ui/read-form-data).
|
|
2462
2500
|
# Corresponds to the JSON property `name`
|
|
2463
2501
|
# @return [String]
|
|
2464
2502
|
attr_accessor :name
|
|
@@ -2478,7 +2516,7 @@ module Google
|
|
|
2478
2516
|
|
|
2479
2517
|
# The value entered by a user, returned as part of a form input event. For
|
|
2480
2518
|
# details about working with form inputs, see [Receive form data](https://
|
|
2481
|
-
# developers.google.com/chat/
|
|
2519
|
+
# developers.google.com/chat/ui/read-form-data).
|
|
2482
2520
|
# Corresponds to the JSON property `value`
|
|
2483
2521
|
# @return [String]
|
|
2484
2522
|
attr_accessor :value
|
|
@@ -2498,12 +2536,13 @@ module Google
|
|
|
2498
2536
|
end
|
|
2499
2537
|
|
|
2500
2538
|
# A field in which users can enter text. Supports suggestions and on-change
|
|
2501
|
-
# actions.
|
|
2502
|
-
#
|
|
2503
|
-
# form
|
|
2504
|
-
#
|
|
2505
|
-
#
|
|
2506
|
-
# data from users, use
|
|
2539
|
+
# actions. For an example in Google Chat apps, see [Text input](https://
|
|
2540
|
+
# developers.google.com/chat/ui/widgets/text-input). Chat apps receive and can
|
|
2541
|
+
# process the value of entered text during form input events. For details about
|
|
2542
|
+
# working with form inputs, see [Receive form data](https://developers.google.
|
|
2543
|
+
# com/chat/ui/read-form-data). When you need to collect undefined or abstract
|
|
2544
|
+
# data from users, use a text input. To collect defined or enumerated data from
|
|
2545
|
+
# users, use the SelectionInput widget.
|
|
2507
2546
|
class GoogleAppsCardV1TextInput
|
|
2508
2547
|
include Google::Apis::Core::Hashable
|
|
2509
2548
|
|
|
@@ -2546,7 +2585,7 @@ module Google
|
|
|
2546
2585
|
|
|
2547
2586
|
# The name by which the text input is identified in a form input event. For
|
|
2548
2587
|
# details about working with form inputs, see [Receive form data](https://
|
|
2549
|
-
# developers.google.com/chat/
|
|
2588
|
+
# developers.google.com/chat/ui/read-form-data).
|
|
2550
2589
|
# Corresponds to the JSON property `name`
|
|
2551
2590
|
# @return [String]
|
|
2552
2591
|
attr_accessor :name
|
|
@@ -2566,7 +2605,7 @@ module Google
|
|
|
2566
2605
|
|
|
2567
2606
|
# The value entered by a user, returned as part of a form input event. For
|
|
2568
2607
|
# details about working with form inputs, see [Receive form data](https://
|
|
2569
|
-
# developers.google.com/chat/
|
|
2608
|
+
# developers.google.com/chat/ui/read-form-data).
|
|
2570
2609
|
# Corresponds to the JSON property `value`
|
|
2571
2610
|
# @return [String]
|
|
2572
2611
|
attr_accessor :value
|
|
@@ -2588,11 +2627,13 @@ module Google
|
|
|
2588
2627
|
end
|
|
2589
2628
|
end
|
|
2590
2629
|
|
|
2591
|
-
# A paragraph of text that supports formatting. For
|
|
2592
|
-
#
|
|
2593
|
-
#
|
|
2594
|
-
#
|
|
2595
|
-
#
|
|
2630
|
+
# A paragraph of text that supports formatting. For an example in Google Chat
|
|
2631
|
+
# apps, see [Text paragraph](https://developers.google.com/chat/ui/widgets/text-
|
|
2632
|
+
# paragraph). For more information about formatting text, see [Formatting text
|
|
2633
|
+
# in Google Chat apps](https://developers.google.com/chat/api/guides/message-
|
|
2634
|
+
# formats/cards##card-formatting) and [Formatting text in Google Workspace Add-
|
|
2635
|
+
# ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#
|
|
2636
|
+
# text_formatting).
|
|
2596
2637
|
class GoogleAppsCardV1TextParagraph
|
|
2597
2638
|
include Google::Apis::Core::Hashable
|
|
2598
2639
|
|
|
@@ -2616,62 +2657,70 @@ module Google
|
|
|
2616
2657
|
class GoogleAppsCardV1Widget
|
|
2617
2658
|
include Google::Apis::Core::Hashable
|
|
2618
2659
|
|
|
2619
|
-
# A list of buttons layed out horizontally.
|
|
2660
|
+
# A list of buttons layed out horizontally. For an example in Google Chat apps,
|
|
2661
|
+
# see [Button list](https://developers.google.com/chat/ui/widgets/button-list).
|
|
2620
2662
|
# Corresponds to the JSON property `buttonList`
|
|
2621
2663
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1ButtonList]
|
|
2622
2664
|
attr_accessor :button_list
|
|
2623
2665
|
|
|
2624
2666
|
# The `Columns` widget displays up to 2 columns in a card message or dialog. You
|
|
2625
2667
|
# can add widgets to each column; the widgets appear in the order that they are
|
|
2626
|
-
# specified.
|
|
2627
|
-
#
|
|
2628
|
-
#
|
|
2629
|
-
#
|
|
2630
|
-
#
|
|
2631
|
-
#
|
|
2632
|
-
#
|
|
2633
|
-
#
|
|
2634
|
-
# On
|
|
2635
|
-
# equal to
|
|
2636
|
-
# width is less than or equal to
|
|
2637
|
-
#
|
|
2638
|
-
#
|
|
2668
|
+
# specified. For an example in Google Chat apps, see [Columns](https://
|
|
2669
|
+
# developers.google.com/chat/ui/widgets/columns). The height of each column is
|
|
2670
|
+
# determined by the taller column. For example, if the first column is taller
|
|
2671
|
+
# than the second column, both columns have the height of the first column.
|
|
2672
|
+
# Because each column can contain a different number of widgets, you can't
|
|
2673
|
+
# define rows or align widgets between the columns. Columns are displayed side-
|
|
2674
|
+
# by-side. You can customize the width of each column using the `
|
|
2675
|
+
# HorizontalSizeStyle` field. If the user's screen width is too narrow, the
|
|
2676
|
+
# second column wraps below the first: * On web, the second column wraps if the
|
|
2677
|
+
# screen width is less than or equal to 480 pixels. * On iOS devices, the second
|
|
2678
|
+
# column wraps if the screen width is less than or equal to 300 pt. * On Android
|
|
2679
|
+
# devices, the second column wraps if the screen width is less than or equal to
|
|
2680
|
+
# 320 dp. To include more than 2 columns, or to use rows, use the `Grid` widget.
|
|
2681
|
+
# Supported by Chat apps, but not Google Workspace Add-ons.
|
|
2639
2682
|
# Corresponds to the JSON property `columns`
|
|
2640
2683
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Columns]
|
|
2641
2684
|
attr_accessor :columns
|
|
2642
2685
|
|
|
2643
|
-
# Lets users input a date, a time, or both a date and a time.
|
|
2644
|
-
#
|
|
2645
|
-
# date
|
|
2646
|
-
#
|
|
2686
|
+
# Lets users input a date, a time, or both a date and a time. For an example in
|
|
2687
|
+
# Google Chat apps, see [Date time picker](https://developers.google.com/chat/ui/
|
|
2688
|
+
# widgets/date-time-picker). Users can input text or use the picker to select
|
|
2689
|
+
# dates and times. If users input an invalid date or time, the picker shows an
|
|
2690
|
+
# error that prompts users to input the information correctly.
|
|
2647
2691
|
# Corresponds to the JSON property `dateTimePicker`
|
|
2648
2692
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1DateTimePicker]
|
|
2649
2693
|
attr_accessor :date_time_picker
|
|
2650
2694
|
|
|
2651
2695
|
# A widget that displays text with optional decorations such as a label above or
|
|
2652
2696
|
# below the text, an icon in front of the text, a selection widget, or a button
|
|
2653
|
-
# after the text.
|
|
2697
|
+
# after the text. For an example in Google Chat apps, see [Decorated text](https:
|
|
2698
|
+
# //developers.google.com/chat/ui/widgets/decorated-text).
|
|
2654
2699
|
# Corresponds to the JSON property `decoratedText`
|
|
2655
2700
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1DecoratedText]
|
|
2656
2701
|
attr_accessor :decorated_text
|
|
2657
2702
|
|
|
2658
|
-
# Displays a divider between widgets as a horizontal line. For example
|
|
2659
|
-
#
|
|
2703
|
+
# Displays a divider between widgets as a horizontal line. For an example in
|
|
2704
|
+
# Google Chat apps, see [Divider](https://developers.google.com/chat/ui/widgets/
|
|
2705
|
+
# divider). For example, the following JSON creates a divider: ``` "divider": ``
|
|
2706
|
+
# ```
|
|
2660
2707
|
# Corresponds to the JSON property `divider`
|
|
2661
2708
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Divider]
|
|
2662
2709
|
attr_accessor :divider
|
|
2663
2710
|
|
|
2664
2711
|
# Displays a grid with a collection of items. Items can only include text or
|
|
2665
|
-
# images.
|
|
2666
|
-
#
|
|
2667
|
-
#
|
|
2668
|
-
#
|
|
2669
|
-
#
|
|
2670
|
-
#
|
|
2671
|
-
# :
|
|
2672
|
-
#
|
|
2673
|
-
# "
|
|
2674
|
-
#
|
|
2712
|
+
# images. For responsive columns, or to include more than text or images, use `
|
|
2713
|
+
# Columns`. For an example in Google Chat apps, see [Grid](https://developers.
|
|
2714
|
+
# google.com/chat/ui/widgets/grid). A grid supports any number of columns and
|
|
2715
|
+
# items. The number of rows is determined by items divided by columns. A grid
|
|
2716
|
+
# with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has
|
|
2717
|
+
# 6 rows. For example, the following JSON creates a 2 column grid with a single
|
|
2718
|
+
# item: ``` "grid": ` "title": "A fine collection of items", "columnCount": 2, "
|
|
2719
|
+
# borderStyle": ` "type": "STROKE", "cornerRadius": 4 `, "items": [ ` "image": `
|
|
2720
|
+
# "imageUri": "https://www.example.com/image.png", "cropStyle": ` "type": "
|
|
2721
|
+
# SQUARE" `, "borderStyle": ` "type": "STROKE" ` `, "title": "An item", "
|
|
2722
|
+
# textAlignment": "CENTER" ` ], "onClick": ` "openLink": ` "url": "https://www.
|
|
2723
|
+
# example.com" ` ` ` ```
|
|
2675
2724
|
# Corresponds to the JSON property `grid`
|
|
2676
2725
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Grid]
|
|
2677
2726
|
attr_accessor :grid
|
|
@@ -2681,38 +2730,43 @@ module Google
|
|
|
2681
2730
|
# @return [String]
|
|
2682
2731
|
attr_accessor :horizontal_alignment
|
|
2683
2732
|
|
|
2684
|
-
# An image that is specified by a URL and can have an `onClick` action.
|
|
2733
|
+
# An image that is specified by a URL and can have an `onClick` action. For an
|
|
2734
|
+
# example, see [Image](https://developers.google.com/chat/ui/widgets/image).
|
|
2685
2735
|
# Corresponds to the JSON property `image`
|
|
2686
2736
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Image]
|
|
2687
2737
|
attr_accessor :image
|
|
2688
2738
|
|
|
2689
2739
|
# A widget that creates one or more UI items that users can select. For example,
|
|
2690
2740
|
# a dropdown menu or checkboxes. You can use this widget to collect data that
|
|
2691
|
-
# can be predicted or enumerated.
|
|
2692
|
-
#
|
|
2693
|
-
#
|
|
2694
|
-
#
|
|
2695
|
-
#
|
|
2741
|
+
# can be predicted or enumerated. For an example in Google Chat apps, see [
|
|
2742
|
+
# Selection input](https://developers.google.com/chat/ui/widgets/selection-input)
|
|
2743
|
+
# . Chat apps can process the value of items that users select or input. For
|
|
2744
|
+
# details about working with form inputs, see [Receive form data](https://
|
|
2745
|
+
# developers.google.com/chat/ui/read-form-data). To collect undefined or
|
|
2746
|
+
# abstract data from users, use the TextInput widget.
|
|
2696
2747
|
# Corresponds to the JSON property `selectionInput`
|
|
2697
2748
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1SelectionInput]
|
|
2698
2749
|
attr_accessor :selection_input
|
|
2699
2750
|
|
|
2700
2751
|
# A field in which users can enter text. Supports suggestions and on-change
|
|
2701
|
-
# actions.
|
|
2702
|
-
#
|
|
2703
|
-
# form
|
|
2704
|
-
#
|
|
2705
|
-
#
|
|
2706
|
-
# data from users, use
|
|
2752
|
+
# actions. For an example in Google Chat apps, see [Text input](https://
|
|
2753
|
+
# developers.google.com/chat/ui/widgets/text-input). Chat apps receive and can
|
|
2754
|
+
# process the value of entered text during form input events. For details about
|
|
2755
|
+
# working with form inputs, see [Receive form data](https://developers.google.
|
|
2756
|
+
# com/chat/ui/read-form-data). When you need to collect undefined or abstract
|
|
2757
|
+
# data from users, use a text input. To collect defined or enumerated data from
|
|
2758
|
+
# users, use the SelectionInput widget.
|
|
2707
2759
|
# Corresponds to the JSON property `textInput`
|
|
2708
2760
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1TextInput]
|
|
2709
2761
|
attr_accessor :text_input
|
|
2710
2762
|
|
|
2711
|
-
# A paragraph of text that supports formatting. For
|
|
2712
|
-
#
|
|
2713
|
-
#
|
|
2714
|
-
#
|
|
2715
|
-
#
|
|
2763
|
+
# A paragraph of text that supports formatting. For an example in Google Chat
|
|
2764
|
+
# apps, see [Text paragraph](https://developers.google.com/chat/ui/widgets/text-
|
|
2765
|
+
# paragraph). For more information about formatting text, see [Formatting text
|
|
2766
|
+
# in Google Chat apps](https://developers.google.com/chat/api/guides/message-
|
|
2767
|
+
# formats/cards##card-formatting) and [Formatting text in Google Workspace Add-
|
|
2768
|
+
# ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#
|
|
2769
|
+
# text_formatting).
|
|
2716
2770
|
# Corresponds to the JSON property `textParagraph`
|
|
2717
2771
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1TextParagraph]
|
|
2718
2772
|
attr_accessor :text_paragraph
|
|
@@ -2741,58 +2795,66 @@ module Google
|
|
|
2741
2795
|
class GoogleAppsCardV1Widgets
|
|
2742
2796
|
include Google::Apis::Core::Hashable
|
|
2743
2797
|
|
|
2744
|
-
# A list of buttons layed out horizontally.
|
|
2798
|
+
# A list of buttons layed out horizontally. For an example in Google Chat apps,
|
|
2799
|
+
# see [Button list](https://developers.google.com/chat/ui/widgets/button-list).
|
|
2745
2800
|
# Corresponds to the JSON property `buttonList`
|
|
2746
2801
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1ButtonList]
|
|
2747
2802
|
attr_accessor :button_list
|
|
2748
2803
|
|
|
2749
|
-
# Lets users input a date, a time, or both a date and a time.
|
|
2750
|
-
#
|
|
2751
|
-
# date
|
|
2752
|
-
#
|
|
2804
|
+
# Lets users input a date, a time, or both a date and a time. For an example in
|
|
2805
|
+
# Google Chat apps, see [Date time picker](https://developers.google.com/chat/ui/
|
|
2806
|
+
# widgets/date-time-picker). Users can input text or use the picker to select
|
|
2807
|
+
# dates and times. If users input an invalid date or time, the picker shows an
|
|
2808
|
+
# error that prompts users to input the information correctly.
|
|
2753
2809
|
# Corresponds to the JSON property `dateTimePicker`
|
|
2754
2810
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1DateTimePicker]
|
|
2755
2811
|
attr_accessor :date_time_picker
|
|
2756
2812
|
|
|
2757
2813
|
# A widget that displays text with optional decorations such as a label above or
|
|
2758
2814
|
# below the text, an icon in front of the text, a selection widget, or a button
|
|
2759
|
-
# after the text.
|
|
2815
|
+
# after the text. For an example in Google Chat apps, see [Decorated text](https:
|
|
2816
|
+
# //developers.google.com/chat/ui/widgets/decorated-text).
|
|
2760
2817
|
# Corresponds to the JSON property `decoratedText`
|
|
2761
2818
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1DecoratedText]
|
|
2762
2819
|
attr_accessor :decorated_text
|
|
2763
2820
|
|
|
2764
|
-
# An image that is specified by a URL and can have an `onClick` action.
|
|
2821
|
+
# An image that is specified by a URL and can have an `onClick` action. For an
|
|
2822
|
+
# example, see [Image](https://developers.google.com/chat/ui/widgets/image).
|
|
2765
2823
|
# Corresponds to the JSON property `image`
|
|
2766
2824
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Image]
|
|
2767
2825
|
attr_accessor :image
|
|
2768
2826
|
|
|
2769
2827
|
# A widget that creates one or more UI items that users can select. For example,
|
|
2770
2828
|
# a dropdown menu or checkboxes. You can use this widget to collect data that
|
|
2771
|
-
# can be predicted or enumerated.
|
|
2772
|
-
#
|
|
2773
|
-
#
|
|
2774
|
-
#
|
|
2775
|
-
#
|
|
2829
|
+
# can be predicted or enumerated. For an example in Google Chat apps, see [
|
|
2830
|
+
# Selection input](https://developers.google.com/chat/ui/widgets/selection-input)
|
|
2831
|
+
# . Chat apps can process the value of items that users select or input. For
|
|
2832
|
+
# details about working with form inputs, see [Receive form data](https://
|
|
2833
|
+
# developers.google.com/chat/ui/read-form-data). To collect undefined or
|
|
2834
|
+
# abstract data from users, use the TextInput widget.
|
|
2776
2835
|
# Corresponds to the JSON property `selectionInput`
|
|
2777
2836
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1SelectionInput]
|
|
2778
2837
|
attr_accessor :selection_input
|
|
2779
2838
|
|
|
2780
2839
|
# A field in which users can enter text. Supports suggestions and on-change
|
|
2781
|
-
# actions.
|
|
2782
|
-
#
|
|
2783
|
-
# form
|
|
2784
|
-
#
|
|
2785
|
-
#
|
|
2786
|
-
# data from users, use
|
|
2840
|
+
# actions. For an example in Google Chat apps, see [Text input](https://
|
|
2841
|
+
# developers.google.com/chat/ui/widgets/text-input). Chat apps receive and can
|
|
2842
|
+
# process the value of entered text during form input events. For details about
|
|
2843
|
+
# working with form inputs, see [Receive form data](https://developers.google.
|
|
2844
|
+
# com/chat/ui/read-form-data). When you need to collect undefined or abstract
|
|
2845
|
+
# data from users, use a text input. To collect defined or enumerated data from
|
|
2846
|
+
# users, use the SelectionInput widget.
|
|
2787
2847
|
# Corresponds to the JSON property `textInput`
|
|
2788
2848
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1TextInput]
|
|
2789
2849
|
attr_accessor :text_input
|
|
2790
2850
|
|
|
2791
|
-
# A paragraph of text that supports formatting. For
|
|
2792
|
-
#
|
|
2793
|
-
#
|
|
2794
|
-
#
|
|
2795
|
-
#
|
|
2851
|
+
# A paragraph of text that supports formatting. For an example in Google Chat
|
|
2852
|
+
# apps, see [Text paragraph](https://developers.google.com/chat/ui/widgets/text-
|
|
2853
|
+
# paragraph). For more information about formatting text, see [Formatting text
|
|
2854
|
+
# in Google Chat apps](https://developers.google.com/chat/api/guides/message-
|
|
2855
|
+
# formats/cards##card-formatting) and [Formatting text in Google Workspace Add-
|
|
2856
|
+
# ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#
|
|
2857
|
+
# text_formatting).
|
|
2796
2858
|
# Corresponds to the JSON property `textParagraph`
|
|
2797
2859
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1TextParagraph]
|
|
2798
2860
|
attr_accessor :text_paragraph
|
|
@@ -3179,7 +3241,10 @@ module Google
|
|
|
3179
3241
|
# @return [String]
|
|
3180
3242
|
attr_accessor :create_time
|
|
3181
3243
|
|
|
3182
|
-
# A user in Google Chat.
|
|
3244
|
+
# A user in Google Chat. When returned as an output from a request, if your Chat
|
|
3245
|
+
# app [authenticates as a user](https://developers.google.com/chat/api/guides/
|
|
3246
|
+
# auth/users), the output for a `User` resource only populates the user's `name`
|
|
3247
|
+
# and `type`.
|
|
3183
3248
|
# Corresponds to the JSON property `member`
|
|
3184
3249
|
# @return [Google::Apis::ChatV1::User]
|
|
3185
3250
|
attr_accessor :member
|
|
@@ -3338,7 +3403,10 @@ module Google
|
|
|
3338
3403
|
# @return [Google::Apis::ChatV1::QuotedMessageMetadata]
|
|
3339
3404
|
attr_accessor :quoted_message_metadata
|
|
3340
3405
|
|
|
3341
|
-
# A user in Google Chat.
|
|
3406
|
+
# A user in Google Chat. When returned as an output from a request, if your Chat
|
|
3407
|
+
# app [authenticates as a user](https://developers.google.com/chat/api/guides/
|
|
3408
|
+
# auth/users), the output for a `User` resource only populates the user's `name`
|
|
3409
|
+
# and `type`.
|
|
3342
3410
|
# Corresponds to the JSON property `sender`
|
|
3343
3411
|
# @return [Google::Apis::ChatV1::User]
|
|
3344
3412
|
attr_accessor :sender
|
|
@@ -3494,7 +3562,10 @@ module Google
|
|
|
3494
3562
|
# @return [String]
|
|
3495
3563
|
attr_accessor :name
|
|
3496
3564
|
|
|
3497
|
-
# A user in Google Chat.
|
|
3565
|
+
# A user in Google Chat. When returned as an output from a request, if your Chat
|
|
3566
|
+
# app [authenticates as a user](https://developers.google.com/chat/api/guides/
|
|
3567
|
+
# auth/users), the output for a `User` resource only populates the user's `name`
|
|
3568
|
+
# and `type`.
|
|
3498
3569
|
# Corresponds to the JSON property `user`
|
|
3499
3570
|
# @return [Google::Apis::ChatV1::User]
|
|
3500
3571
|
attr_accessor :user
|
|
@@ -3547,18 +3618,22 @@ module Google
|
|
|
3547
3618
|
class SetUpSpaceRequest
|
|
3548
3619
|
include Google::Apis::Core::Hashable
|
|
3549
3620
|
|
|
3550
|
-
# Optional. The
|
|
3551
|
-
#
|
|
3552
|
-
#
|
|
3553
|
-
#
|
|
3554
|
-
#
|
|
3555
|
-
#
|
|
3556
|
-
#
|
|
3557
|
-
#
|
|
3558
|
-
#
|
|
3559
|
-
#
|
|
3560
|
-
# Space.
|
|
3561
|
-
#
|
|
3621
|
+
# Optional. The Google Chat users to invite to join the space. Omit the calling
|
|
3622
|
+
# user, as they are added automatically. The set currently allows up to 20
|
|
3623
|
+
# memberships (in addition to the caller). The `Membership.member` field must
|
|
3624
|
+
# contain a `user` with `name` populated (format: `users/`user``) and `type` set
|
|
3625
|
+
# to `User.Type.HUMAN`. You can only add human users when setting up a space (
|
|
3626
|
+
# adding Chat apps is only supported for direct message setup with the calling
|
|
3627
|
+
# app). You can also add members using the user's email as an alias for `user`.
|
|
3628
|
+
# For example, the `user.name` can be `users/example@gmail.com`." To invite
|
|
3629
|
+
# Gmail users or users from external Google Workspace domains, user's email must
|
|
3630
|
+
# be used for ``user``. Optional when setting `Space.spaceType` to `SPACE`.
|
|
3631
|
+
# Required when setting `Space.spaceType` to `GROUP_CHAT`, along with at least
|
|
3632
|
+
# two memberships. Required when setting `Space.spaceType` to `DIRECT_MESSAGE`
|
|
3633
|
+
# with a human user, along with exactly one membership. Must be empty when
|
|
3634
|
+
# creating a 1:1 conversation between a human and the calling Chat app (when
|
|
3635
|
+
# setting `Space.spaceType` to `DIRECT_MESSAGE` and `Space.singleUserBotDm` to `
|
|
3636
|
+
# true`).
|
|
3562
3637
|
# Corresponds to the JSON property `memberships`
|
|
3563
3638
|
# @return [Array<Google::Apis::ChatV1::Membership>]
|
|
3564
3639
|
attr_accessor :memberships
|
|
@@ -3613,7 +3688,10 @@ module Google
|
|
|
3613
3688
|
class SlashCommandMetadata
|
|
3614
3689
|
include Google::Apis::Core::Hashable
|
|
3615
3690
|
|
|
3616
|
-
# A user in Google Chat.
|
|
3691
|
+
# A user in Google Chat. When returned as an output from a request, if your Chat
|
|
3692
|
+
# app [authenticates as a user](https://developers.google.com/chat/api/guides/
|
|
3693
|
+
# auth/users), the output for a `User` resource only populates the user's `name`
|
|
3694
|
+
# and `type`.
|
|
3617
3695
|
# Corresponds to the JSON property `bot`
|
|
3618
3696
|
# @return [Google::Apis::ChatV1::User]
|
|
3619
3697
|
attr_accessor :bot
|
|
@@ -3675,6 +3753,16 @@ module Google
|
|
|
3675
3753
|
# @return [String]
|
|
3676
3754
|
attr_accessor :display_name
|
|
3677
3755
|
|
|
3756
|
+
# Immutable. Whether this space permits any Google Chat user as a member. Input
|
|
3757
|
+
# when creating a space in a Google Workspace organization. For Google Chat
|
|
3758
|
+
# users that use a Google Account, omit this field when creating a space (By
|
|
3759
|
+
# default, the space permits any Google Chat user). For existing spaces, this
|
|
3760
|
+
# field is output only.
|
|
3761
|
+
# Corresponds to the JSON property `externalUserAllowed`
|
|
3762
|
+
# @return [Boolean]
|
|
3763
|
+
attr_accessor :external_user_allowed
|
|
3764
|
+
alias_method :external_user_allowed?, :external_user_allowed
|
|
3765
|
+
|
|
3678
3766
|
# Resource name of the space. Format: `spaces/`space``
|
|
3679
3767
|
# Corresponds to the JSON property `name`
|
|
3680
3768
|
# @return [String]
|
|
@@ -3727,6 +3815,7 @@ module Google
|
|
|
3727
3815
|
def update!(**args)
|
|
3728
3816
|
@admin_installed = args[:admin_installed] if args.key?(:admin_installed)
|
|
3729
3817
|
@display_name = args[:display_name] if args.key?(:display_name)
|
|
3818
|
+
@external_user_allowed = args[:external_user_allowed] if args.key?(:external_user_allowed)
|
|
3730
3819
|
@name = args[:name] if args.key?(:name)
|
|
3731
3820
|
@single_user_bot_dm = args[:single_user_bot_dm] if args.key?(:single_user_bot_dm)
|
|
3732
3821
|
@space_details = args[:space_details] if args.key?(:space_details)
|
|
@@ -4020,7 +4109,10 @@ module Google
|
|
|
4020
4109
|
end
|
|
4021
4110
|
end
|
|
4022
4111
|
|
|
4023
|
-
# A user in Google Chat.
|
|
4112
|
+
# A user in Google Chat. When returned as an output from a request, if your Chat
|
|
4113
|
+
# app [authenticates as a user](https://developers.google.com/chat/api/guides/
|
|
4114
|
+
# auth/users), the output for a `User` resource only populates the user's `name`
|
|
4115
|
+
# and `type`.
|
|
4024
4116
|
class User
|
|
4025
4117
|
include Google::Apis::Core::Hashable
|
|
4026
4118
|
|
|
@@ -4080,7 +4172,10 @@ module Google
|
|
|
4080
4172
|
# @return [String]
|
|
4081
4173
|
attr_accessor :type
|
|
4082
4174
|
|
|
4083
|
-
# A user in Google Chat.
|
|
4175
|
+
# A user in Google Chat. When returned as an output from a request, if your Chat
|
|
4176
|
+
# app [authenticates as a user](https://developers.google.com/chat/api/guides/
|
|
4177
|
+
# auth/users), the output for a `User` resource only populates the user's `name`
|
|
4178
|
+
# and `type`.
|
|
4084
4179
|
# Corresponds to the JSON property `user`
|
|
4085
4180
|
# @return [Google::Apis::ChatV1::User]
|
|
4086
4181
|
attr_accessor :user
|