Class ActionStatus

Spark icon

Page Summary

The ActionStatus class represents the status for a request to invoke or submit a dialog in Google Chat apps.
It is only available for Google Chat apps and not for Google Workspace add-ons.
Key methods include setStatusCode() to set the status code and setUserFacingMessage() to set a user-facing message about the request status.

ActionStatus

A class that represents the status for a request to either invoke or submit a dialog.

Only available for Google Chat apps. Not available for Google Workspace add-ons.

constactionStatus=CardService.newActionStatus()
.setStatusCode(CardService.Status.OK)
.setUserFacingMessage('Success');

Method	Return type	Brief description
`setStatusCode(statusCode)`	`ActionStatus`	Represents the status for a request to either open or submit a dialog.
`setUserFacingMessage(message)`	`ActionStatus`	The message to send users about the status of their request.

Represents the status for a request to either open or submit a dialog.

constactionStatus=CardService.newActionStatus().setStatusCode(
CardService.Status.OK,
);

Name	Type	Description
`statusCode`	`Status`	The status code.

ActionStatus — This object, for chaining.

The message to send users about the status of their request. If unset, a generic message based on the Status is sent.

constactionStatus=
CardService.newActionStatus().setUserFacingMessage('Success');

Name	Type	Description
`message`	`String`	The message to send.

ActionStatus — This object, for chaining.