Package com.google.apps.card.v1 (0.1.0)
Classes
| Class | Description |
|---|---|
| com.google.apps.card.v1.Action | An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. |
| com.google.apps.card.v1.Action.ActionParameter | List of string parameters to supply when the action method is invoked.
For example, consider three snooze buttons: snooze now, snooze one day,
or snooze next week. You might use action method = snooze()
, passing the |
| com.google.apps.card.v1.Action.ActionParameter.Builder | List of string parameters to supply when the action method is invoked.
For example, consider three snooze buttons: snooze now, snooze one day,
or snooze next week. You might use action method = snooze()
, passing the |
| com.google.apps.card.v1.Action.Builder | An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. |
| com.google.apps.card.v1.BorderStyle | The style options for the border of a card or widget, including the border type and color. |
| com.google.apps.card.v1.BorderStyle.Builder | The style options for the border of a card or widget, including the border type and color. |
| com.google.apps.card.v1.Button | A text, icon, or text and icon button that users can click. For an example in Google Chat apps, see Button list . |
| com.google.apps.card.v1.Button.Builder | A text, icon, or text and icon button that users can click. For an example in Google Chat apps, see Button list . |
| com.google.apps.card.v1.ButtonList | A list of buttons layed out horizontally. For an example in Google Chat apps, see Button list . |
| com.google.apps.card.v1.ButtonList.Builder | A list of buttons layed out horizontally. For an example in Google Chat apps, see Button list . |
| com.google.apps.card.v1.Card | A card interface displayed in a Google Chat message or Google Workspace Add-on. |
| com.google.apps.card.v1.Card.Builder | A card interface displayed in a Google Chat message or Google Workspace Add-on. |
| com.google.apps.card.v1.Card.CardAction | A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. |
| com.google.apps.card.v1.Card.CardAction.Builder | A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. |
| com.google.apps.card.v1.Card.CardFixedFooter | A persistent (sticky) footer that that appears at the bottom of the card.
Setting fixedFooter
without specifying a primaryButton
or a |
| com.google.apps.card.v1.Card.CardFixedFooter.Builder | A persistent (sticky) footer that that appears at the bottom of the card.
Setting fixedFooter
without specifying a primaryButton
or a |
| com.google.apps.card.v1.Card.CardHeader | Represents a card header. For an example in Google Chat apps, see Card header . |
| com.google.apps.card.v1.Card.CardHeader.Builder | Represents a card header. For an example in Google Chat apps, see Card header . |
| com.google.apps.card.v1.Card.Section | A section contains a collection of widgets that are rendered vertically in the order that they're specified. |
| com.google.apps.card.v1.Card.Section.Builder | A section contains a collection of widgets that are rendered vertically in the order that they're specified. |
| com.google.apps.card.v1.CardProto | |
| com.google.apps.card.v1.Columns | The Columns
widget displays up to 2 columns in a card or dialog. You can
add widgets to each column; the widgets appear in the order that they are
specified. For an example in Google Chat apps, see |
| com.google.apps.card.v1.Columns.Builder | The Columns
widget displays up to 2 columns in a card or dialog. You can
add widgets to each column; the widgets appear in the order that they are
specified. For an example in Google Chat apps, see |
| com.google.apps.card.v1.Columns.Column | A column. Google Chat apps : |
| com.google.apps.card.v1.Columns.Column.Builder | A column. Google Chat apps : |
| com.google.apps.card.v1.Columns.Column.Widgets | The supported widgets that you can include in a column. Google Chat apps : |
| com.google.apps.card.v1.Columns.Column.Widgets.Builder | The supported widgets that you can include in a column. Google Chat apps : |
| com.google.apps.card.v1.DateTimePicker | Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see Date time picker . |
| com.google.apps.card.v1.DateTimePicker.Builder | Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see Date time picker . |
| com.google.apps.card.v1.DecoratedText | A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in |
| com.google.apps.card.v1.DecoratedText.Builder | A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in |
| com.google.apps.card.v1.DecoratedText.SwitchControl | Either a toggle-style switch or a checkbox inside a decoratedText
widget. Google Workspace Add-ons and Chat
|
| com.google.apps.card.v1.DecoratedText.SwitchControl.Builder | Either a toggle-style switch or a checkbox inside a decoratedText
widget. Google Workspace Add-ons and Chat
|
| com.google.apps.card.v1.Divider | Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see Divider . |
| com.google.apps.card.v1.Divider.Builder | Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see Divider . |
| com.google.apps.card.v1.Grid | Displays a grid with a collection of items. Items can only include text or
images. For responsive columns, or to include more than text or images, use Columns
. For an example in Google Chat apps, |
| com.google.apps.card.v1.Grid.Builder | Displays a grid with a collection of items. Items can only include text or
images. For responsive columns, or to include more than text or images, use Columns
. For an example in Google Chat apps, |
| com.google.apps.card.v1.Grid.GridItem | Represents an item in a grid layout. Items can contain text, an image, or both text and an image. |
| com.google.apps.card.v1.Grid.GridItem.Builder | Represents an item in a grid layout. Items can contain text, an image, or both text and an image. |
| com.google.apps.card.v1.Icon | An icon displayed in a widget on a card. For an example in Google Chat apps, see Icon . |
| com.google.apps.card.v1.Icon.Builder | An icon displayed in a widget on a card. For an example in Google Chat apps, see Icon . |
| com.google.apps.card.v1.Image | An image that is specified by a URL and can have an onClick
action. For an
example, see Image
. |
| com.google.apps.card.v1.Image.Builder | An image that is specified by a URL and can have an onClick
action. For an
example, see Image
. |
| com.google.apps.card.v1.ImageComponent | Represents an image. Google Workspace Add-ons and Chat |
| com.google.apps.card.v1.ImageComponent.Builder | Represents an image. Google Workspace Add-ons and Chat |
| com.google.apps.card.v1.ImageCropStyle | Represents the crop style applied to an image. Google Workspace Add-ons and |
| com.google.apps.card.v1.ImageCropStyle.Builder | Represents the crop style applied to an image. Google Workspace Add-ons and |
| com.google.apps.card.v1.OnClick | Represents how to respond when users click an interactive element on a card, such as a button. |
| com.google.apps.card.v1.OnClick.Builder | Represents how to respond when users click an interactive element on a card, such as a button. |
| com.google.apps.card.v1.OpenLink | Represents an onClick
event that opens a hyperlink. Google Workspace Add-ons and Chat
|
| com.google.apps.card.v1.OpenLink.Builder | Represents an onClick
event that opens a hyperlink. Google Workspace Add-ons and Chat
|
| com.google.apps.card.v1.SelectionInput | A widget that creates one or more UI items that users can select. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google |
| com.google.apps.card.v1.SelectionInput.Builder | A widget that creates one or more UI items that users can select. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google |
| com.google.apps.card.v1.SelectionInput.PlatformDataSource | For a SelectionInput
widget that uses a
multiselect menu, a data source from Google Workspace. Used to populate |
| com.google.apps.card.v1.SelectionInput.PlatformDataSource.Builder | For a SelectionInput
widget that uses a
multiselect menu, a data source from Google Workspace. Used to populate |
| com.google.apps.card.v1.SelectionInput.SelectionItem | An item that users can select in a selection input, such as a checkbox or switch. |
| com.google.apps.card.v1.SelectionInput.SelectionItem.Builder | An item that users can select in a selection input, such as a checkbox or switch. |
| com.google.apps.card.v1.Suggestions | Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed. |
| com.google.apps.card.v1.Suggestions.Builder | Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed. |
| com.google.apps.card.v1.Suggestions.SuggestionItem | One suggested value that users can enter in a text input field. Google Workspace Add-ons and Chat |
| com.google.apps.card.v1.Suggestions.SuggestionItem.Builder | One suggested value that users can enter in a text input field. Google Workspace Add-ons and Chat |
| com.google.apps.card.v1.TextInput | A field in which users can enter text. Supports suggestions and on-change actions. For an example in Google Chat apps, see Text input . |
| com.google.apps.card.v1.TextInput.Builder | A field in which users can enter text. Supports suggestions and on-change actions. For an example in Google Chat apps, see Text input . |
| com.google.apps.card.v1.TextParagraph | A paragraph of text that supports formatting. For an example in Google Chat apps, see Text paragraph . |
| com.google.apps.card.v1.TextParagraph.Builder | A paragraph of text that supports formatting. For an example in Google Chat apps, see Text paragraph . |
| com.google.apps.card.v1.Widget | Each card is made up of widgets. A widget is a composite object that can represent one of text, images, |
| com.google.apps.card.v1.Widget.Builder | Each card is made up of widgets. A widget is a composite object that can represent one of text, images, |
Interfaces
Enums
| Enum | Description |
|---|---|
| com.google.apps.card.v1.Action.Interaction | Optional. Required when opening a dialog . |
| com.google.apps.card.v1.Action.LoadIndicator | Specifies the loading indicator that the action displays while making the call to the action. |
| com.google.apps.card.v1.BorderStyle.BorderType | Represents the border types applied to widgets. Google Workspace Add-ons |
| com.google.apps.card.v1.Card.DisplayStyle | In Google Workspace Add-ons, determines how a card is displayed. |
| com.google.apps.card.v1.Card.DividerStyle | The divider style of a card. Currently only used for dividers betweens card sections. |
| com.google.apps.card.v1.Columns.Column.HorizontalSizeStyle | Specifies how a column fills the width of the card. The width of each
column depends on both the HorizontalSizeStyle
and the width of the
widgets within the column. |
| com.google.apps.card.v1.Columns.Column.VerticalAlignment | Specifies whether widgets align to the top, bottom, or center of a column. |
| com.google.apps.card.v1.Columns.Column.Widgets.DataCase | |
| com.google.apps.card.v1.DateTimePicker.DateTimePickerType | The format for the date and time in the DateTimePicker
widget.
Determines whether users can input a date, a time, or both a date and time. |
| com.google.apps.card.v1.DecoratedText.ControlCase | |
| com.google.apps.card.v1.DecoratedText.SwitchControl.ControlType | How the switch appears in the user interface. Google Workspace Add-ons |
| com.google.apps.card.v1.Grid.GridItem.GridItemLayout | Represents the various layout options available for a grid item. Google Workspace Add-ons and Chat |
| com.google.apps.card.v1.Icon.IconsCase | |
| com.google.apps.card.v1.ImageCropStyle.ImageCropType | Represents the crop style applied to an image. Google Workspace Add-ons |
| com.google.apps.card.v1.OnClick.DataCase | |
| com.google.apps.card.v1.OpenLink.OnClose | What the client does when a link opened by an OnClick
action is closed.
Implementation depends on client platform capabilities. For example, a web |
| com.google.apps.card.v1.OpenLink.OpenAs | When an OnClick
action opens a link, then the client can either open it
as a full-size window (if that's the frame used by the client), or an
overlay (such as a pop-up). The implementation depends on the client |
| com.google.apps.card.v1.SelectionInput.MultiSelectDataSourceCase | |
| com.google.apps.card.v1.SelectionInput.PlatformDataSource.CommonDataSource | A data source shared by all Google Workspace applications . |
| com.google.apps.card.v1.SelectionInput.PlatformDataSource.DataSourceCase | |
| com.google.apps.card.v1.SelectionInput.SelectionType | The format for the items that users can select. Different options support different types of interactions. For example, users can select multiple checkboxes, but can only select one item from a dropdown menu. |
| com.google.apps.card.v1.Suggestions.SuggestionItem.ContentCase | |
| com.google.apps.card.v1.TextInput.Type | How a text input field appears in the user interface. For example,
whether it's a single line input field, or a multi-line input. If initialSuggestions
is specified, type
is always SINGLE_LINE
, |
| com.google.apps.card.v1.Widget.DataCase | |
| com.google.apps.card.v1.Widget.HorizontalAlignment | Specifies whether widgets align to the left, right, or center of a column. Google Chat apps : |
| com.google.apps.card.v1.Widget.ImageType | The shape used to crop the image. Google Workspace Add-ons and Chat |
