Class ActionResponse

  • ActionResponse enables callback functions to trigger actions like opening links, displaying notifications, and navigating between cards within Google Workspace add-ons.

  • Developers can use ActionResponseBuilder methods to define these actions and control client-side behavior based on user interactions.

  • The printJson() method helps with debugging by providing the JSON representation of the ActionResponse object.

ActionResponse

The response object that may be returned from a callback function (e.g., a form response handler) to perform one or more actions on the client. Some combinations of actions are not supported.

// An action that opens a link const actionResponse =  CardService.newActionResponseBuilder()  .setOpenLink(CardService.newOpenLink().setUrl('https://www.google.com'))  .build(); // An action that shows a notification. const notificationActionResponse = CardService.newActionResponseBuilder()  .setNotification(  CardService.newNotification().setText(  'Some info to display to user'),  )  .build(); // An action that shows an additional card. It also sets a flag to indicate that // the original state data has changed. const cardBuilder = CardService.newCardBuilder(); // Build card ... const navigationActionResponse = CardService.newActionResponseBuilder()  .setNavigation(CardService.newNavigation().pushCard(  cardBuilder.build()))  .setStateChanged(true)  .build();

Methods

MethodReturn typeBrief description
printJson()StringPrints the JSON representation of this object.

Detailed documentation

printJson()

Prints the JSON representation of this object. This is for debugging only.

Return

String