Class CardService

CardService

CardService provides the ability to create generic cards used across different Google extensibility products, such as Gmail add-ons.

Currently you can only use this service to construct Gmail add-ons.

 return CardService.newCardBuilder()
          .setHeader(CardService.newCardHeader().setTitle("CardTitle"))
          .build();
 

Or you can return multiple Cards like so:

 return [
   CardService.newCardBuilder().build(),
   CardService.newCardBuilder().build(),
   CardService.newCardBuilder().build()
 ]
 

The following shows how you could define a card with a header, text, an image and a menu item:

 function createWidgetDemoCard() {
   return CardService
      .newCardBuilder()
      .setHeader(
          CardService.newCardHeader()
              .setTitle('Widget demonstration')
              .setSubtitle('Check out these widgets')
              .setImageStyle(CardService.ImageStyle.SQUARE)
              .setImageUrl(
                  'https://www.example.com/images/headerImage.png'))
      .addSection(
           CardService.newCardSection()
               .setHeader('Simple widgets')  // optional
               .addWidget(CardService.newTextParagraph().setText(
                   'These widgets are display-only. ' +
                   'A text paragraph can have multiple lines and ' +
                   'formatting.'))
               .addWidget(CardService.newImage().setImageUrl(
                   'https://www.example.com/images/mapsImage.png')))
      .addCardAction(CardService.newCardAction().setText('Gmail').setOpenLink(
          CardService.newOpenLink().setUrl('https://mail.google.com/mail')))
      .build();
 }
 

Properties

Property	Type	Description
ComposedEmailType	ComposedEmailType	The ComposedEmailType enumeration.
Icon	Icon	The Icon enumeration.
ImageStyle	ImageStyle	The ImageStyle enumeration.
LoadIndicator	LoadIndicator	The LoadIndicator enumeration.
NotificationType	NotificationType	The NotificationType enumeration.
OnClose	OnClose	The OnClose enumeration.
OpenAs	OpenAs	The OpenAs enumeration.
SelectionInputType	SelectionInputType	The SelectionInputType enumeration.

Methods

Method	Return type	Brief description
newAction()	Action	Creates a new Action.
newActionResponseBuilder()	ActionResponseBuilder	Creates a new ActionResponseBuilder.
newAuthorizationAction()	AuthorizationAction	Creates a new AuthorizationAction.
newAuthorizationException()	AuthorizationException	Creates a new AuthorizationException.
newButtonSet()	ButtonSet	Creates a new ButtonSet.
newCardAction()	CardAction	Creates a new CardAction.
newCardBuilder()	CardBuilder	Creates a new CardBuilder.
newCardHeader()	CardHeader	Creates a new CardHeader.
newCardSection()	CardSection	Creates a new CardSection.
newComposeActionResponseBuilder()	ComposeActionResponseBuilder	Creates a new ComposeActionResponseBuilder.
newImage()	Image	Creates a new Image.
newImageButton()	ImageButton	Creates a new ImageButton.
newKeyValue()	KeyValue	Creates a new KeyValue.
newNavigation()	Navigation	Creates a new Navigation.
newNotification()	Notification	Creates a new Notification.
newOpenLink()	OpenLink	Creates a new OpenLink.
newSelectionInput()	SelectionInput	Creates a new SelectionInput.
newSuggestions()	Suggestions	Creates a new Suggestions.
newSuggestionsResponseBuilder()	SuggestionsResponseBuilder	Creates a new SuggestionsResponseBuilder.
newSwitch()	Switch	Creates a new Switch.
newTextButton()	TextButton	Creates a new TextButton.
newTextInput()	TextInput	Creates a new TextInput.
newTextParagraph()	TextParagraph	Creates a new TextParagraph.
newUniversalActionResponseBuilder()	UniversalActionResponseBuilder	Creates a new UniversalActionResponseBuilder.

Detailed documentation

newAction()

Creates a new Action.

Return

Action — an empty Action.

---

newActionResponseBuilder()

Creates a new ActionResponseBuilder.

Return

ActionResponseBuilder — an empty ActionResponse builder

---

newAuthorizationAction()

Creates a new AuthorizationAction.

Return

AuthorizationAction — an empty AuthorizationAction();

---

newAuthorizationException()

Creates a new AuthorizationException.

Return

AuthorizationException — an empty AuthorizationException.

---

newButtonSet()

Creates a new ButtonSet.

Return

ButtonSet — an empty ButtonSet.

---

newCardAction()

Creates a new CardAction.

Return

CardAction — an empty CardAction.

---

newCardBuilder()

Creates a new CardBuilder.

Return

CardBuilder — an empty Card builder.

---

newCardHeader()

Creates a new CardHeader.

Return

CardHeader — an empty CardHeader.

---

newCardSection()

Creates a new CardSection.

Return

CardSection — an empty CardSection.

---

newComposeActionResponseBuilder()

Creates a new ComposeActionResponseBuilder.

Return

ComposeActionResponseBuilder — an empty ComposeActionResponse builder

---

newImage()

Creates a new Image.

Return

Image — an empty Image.

---

newImageButton()

Creates a new ImageButton.

Return

ImageButton — an empty ImageButton.

---

newKeyValue()

Creates a new KeyValue.

Return

KeyValue — an empty KeyValue.

---

newNavigation()

Creates a new Navigation.

Return

Navigation — an empty Navigation.

---

newNotification()

Creates a new Notification.

Return

Notification — an empty Notification.

---

newOpenLink()

Creates a new OpenLink.

Return

OpenLink — an empty OpenLink.

---

newSelectionInput()

Creates a new SelectionInput.

Return

SelectionInput — an empty SelectionInput.

---

newSuggestions()

Creates a new Suggestions.

Return

Suggestions — an empty Suggestions.

---

newSuggestionsResponseBuilder()

Creates a new SuggestionsResponseBuilder.

Return

SuggestionsResponseBuilder — an empty SuggestionsResponse builder

---

newSwitch()

Creates a new Switch.

Return

Switch — an empty Switch.

---

newTextButton()

Creates a new TextButton.

Return

TextButton — an empty TextButton.

---

newTextInput()

Creates a new TextInput.

Return

TextInput — an empty TextInput.

---

newTextParagraph()

Creates a new TextParagraph.

Return

TextParagraph — an empty TextParagraph.

---

newUniversalActionResponseBuilder()

Creates a new UniversalActionResponseBuilder.

Return

UniversalActionResponseBuilder — an empty UniversalActionResponse builder