@maxim_mazurok/gapi.client.chat-v1 0.3.20261025 → 0.3.20261027
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/index.d.ts +7 -7
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://chat.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20261027
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -261,7 +261,7 @@ declare namespace gapi.client {
|
|
|
261
261
|
red?: number;
|
|
262
262
|
}
|
|
263
263
|
interface CommonEventObject {
|
|
264
|
-
/** A map containing the current values of the widgets in the displayed card. The map keys are the string
|
|
264
|
+
/** A map containing the current values of the widgets in the displayed card. The map keys are the string `name` values assigned to each input widget (such as `TextInput.name`, `SelectionInput.name`, `DateTimePicker.name`, or `DecoratedText.SwitchControl.name`). The structure of the map value object is dependent on the widget type: **Note**: The following examples are formatted for Apps Script's V8 runtime. If you're using Rhino runtime, you must add `[""]` after the value. For example, instead of `e.commonEventObject.formInputs.employeeName.stringInputs.value[0]`, format the event object as `e.commonEventObject.formInputs.employeeName[""].stringInputs.value[0]`. To learn more about runtimes in Apps Script, see the [V8 Runtime Overview](https://developers.google.com/apps-script/guides/v8-runtime). * Single-valued widgets (for example, a `TextInput` widget, or a `SelectionInput` widget of type `DROPDOWN` or `RADIO_BUTTON`): a `StringInputs` object containing a single-element list (or an empty list if no selection is made). **Example**: for a text input widget with `employeeName` as its `name`, access the text input value with: `e.commonEventObject.formInputs.employeeName.stringInputs.value[0]`. * Multi-valued widgets (for example, a `SelectionInput` widget of type `CHECK_BOX`, `SWITCH`, or `MULTI_SELECT`): a `StringInputs` object containing the list of selected item `value` strings. **Example**: for a multi-value widget with `participants` as its `name`, access the value array with: `e.commonEventObject.formInputs.participants.stringInputs.value`. * **A `DecoratedText.SwitchControl` widget**: a `StringInputs` object. When `selected` is `true`, `stringInputs.value` contains the switch's `value` field (or `""` if `value` was not specified; if multiple switches share the same `name`, each selected switch's `value` is included in the list). When `selected` is `false`, the switch's `value` is omitted from `stringInputs.value`. * **A date-time picker (`DateTimePickerType.DATE_AND_TIME`)**: a [`DateTimeInput object`](https://developers.google.com/workspace/add-ons/concepts/event-objects#date-time-input). **Example**: For a picker with a `name` of `myDTPicker`, access the [`DateTimeInput`](https://developers.google.com/workspace/add-ons/concepts/event-objects#date-time-input) object using `e.commonEventObject.formInputs.myDTPicker.dateTimeInput`. * **A date-only picker (`DateTimePickerType.DATE_ONLY`)**: a [`DateInput object`](https://developers.google.com/workspace/add-ons/concepts/event-objects#date-input). **Example**: For a picker with a `name` of `myDatePicker`, access the [`DateInput`](https://developers.google.com/workspace/add-ons/concepts/event-objects#date-input) object using `e.commonEventObject.formInputs.myDatePicker.dateInput`. * **A time-only picker (`DateTimePickerType.TIME_ONLY`)**: a [`TimeInput object`](https://developers.google.com/workspace/add-ons/concepts/event-objects#time-input). **Example**: For a picker with a `name` of `myTimePicker`, access the [`TimeInput`](https://developers.google.com/workspace/add-ons/concepts/event-objects#time-input) object using `e.commonEventObject.formInputs.myTimePicker.timeInput`. */
|
|
265
265
|
formInputs?: {[P in string]: Inputs};
|
|
266
266
|
/** Indicates the host app the add-on is active in when the event object is generated. Possible values include the following: * `GMAIL` * `CALENDAR` * `DRIVE` * `DOCS` * `SHEETS` * `SLIDES` * `CHAT` */
|
|
267
267
|
hostApp?:
|
|
@@ -514,7 +514,7 @@ declare namespace gapi.client {
|
|
|
514
514
|
buttons?: GoogleAppsCardV1Button[];
|
|
515
515
|
}
|
|
516
516
|
interface GoogleAppsCardV1Card {
|
|
517
|
-
/** The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` */
|
|
517
|
+
/** The card's actions. Actions are added to the card's toolbar menu. Supports up to 10 `CardAction` items. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` */
|
|
518
518
|
cardActions?: GoogleAppsCardV1CardAction[];
|
|
519
519
|
/** In Google Workspace add-ons, sets the display properties of the `peekCardHeader`. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): */
|
|
520
520
|
displayStyle?: 'DISPLAY_STYLE_UNSPECIFIED' | 'PEEK' | 'REPLACE';
|
|
@@ -841,7 +841,7 @@ declare namespace gapi.client {
|
|
|
841
841
|
id?: string;
|
|
842
842
|
/** The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. */
|
|
843
843
|
uncollapsibleWidgetsCount?: number;
|
|
844
|
-
/** All the widgets in the section. Must contain at least one widget. */
|
|
844
|
+
/** All the widgets in the section. Must contain at least one widget. A card supports up to 100 widgets across all sections. */
|
|
845
845
|
widgets?: GoogleAppsCardV1Widget[];
|
|
846
846
|
}
|
|
847
847
|
interface GoogleAppsCardV1SelectionInput {
|
|
@@ -891,13 +891,13 @@ declare namespace gapi.client {
|
|
|
891
891
|
interface GoogleAppsCardV1SwitchControl {
|
|
892
892
|
/** How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): */
|
|
893
893
|
controlType?: 'SWITCH' | 'CHECKBOX' | 'CHECK_BOX';
|
|
894
|
-
/** The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). */
|
|
894
|
+
/** The name by which the switch widget is identified in a form input event (as the key in `CommonEventObject.form_inputs`). For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). */
|
|
895
895
|
name?: string;
|
|
896
896
|
/** The action to perform when the switch state is changed, such as what function to run. */
|
|
897
897
|
onChangeAction?: GoogleAppsCardV1Action;
|
|
898
|
-
/** When `true`, the switch is selected. */
|
|
898
|
+
/** When `true`, the switch is selected, and its `value` is included in `CommonEventObject.form_inputs[name].string_inputs.value`. */
|
|
899
899
|
selected?: boolean;
|
|
900
|
-
/** The value
|
|
900
|
+
/** The value returned in `CommonEventObject.form_inputs[name].string_inputs` when the switch is selected (`selected` is `true`). If `selected` is `true` and `value` is unset, an empty string (`""`) is returned in `string_inputs.value`. When `selected` is `false`, this value is omitted from `string_inputs.value`. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). */
|
|
901
901
|
value?: string;
|
|
902
902
|
}
|
|
903
903
|
interface GoogleAppsCardV1TextInput {
|