Class GoogleAppsCardV1Action

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. Google Workspace add-ons and Chat apps:

Inheritance

object

GoogleAppsCardV1Action

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.HangoutsChat.v1.Data

Assembly: Google.Apis.HangoutsChat.v1.dll

Syntax

public class GoogleAppsCardV1Action : IDirectResponseSchema

Properties

AllWidgetsAreRequired

Optional. If this is true, then all widgets are considered required by this action. Google Workspace add-ons and Chat apps:

Declaration

[JsonProperty("allWidgetsAreRequired")]
public virtual bool? AllWidgetsAreRequired { get; set; }

Property Value

Type	Description
bool?

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

Function

A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see Read form data.

Declaration

[JsonProperty("function")]
public virtual string Function { get; set; }

Property Value

Type	Description
string

Interaction

Optional. Required when opening a dialog. What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an action—like opening a link or running a function—as normal. By specifying an interaction, the app can respond in special interactive ways. For example, by setting interaction to OPEN_DIALOG, the app can open a dialog. When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. Google Chat apps:

Declaration

[JsonProperty("interaction")]
public virtual string Interaction { get; set; }

Property Value

Type	Description
string

LoadIndicator

Specifies the loading indicator that the action displays while making the call to the action.

Declaration

[JsonProperty("loadIndicator")]
public virtual string LoadIndicator { get; set; }

Property Value

Type	Description
string

Parameters

List of action parameters.

Declaration

[JsonProperty("parameters")]
public virtual IList<GoogleAppsCardV1ActionParameter> Parameters { get; set; }

Property Value

Type	Description
IList<GoogleAppsCardV1ActionParameter>

PersistValues

Indicates whether form values persist after the action. The default value is false. If true, form values remain after the action is triggered. To let the user make changes while the action is being processed, set LoadIndicator to NONE. For card messages in Chat apps, you must also set the action's ResponseType to UPDATE_MESSAGE and use the same card_id from the card that contained the action. If false, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set LoadIndicator to SPINNER.

Declaration

[JsonProperty("persistValues")]
public virtual bool? PersistValues { get; set; }

Property Value

Type	Description
bool?

RequiredWidgets

Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. Google Workspace add-ons and Chat apps:

Declaration

[JsonProperty("requiredWidgets")]
public virtual IList<string> RequiredWidgets { get; set; }

Property Value

Type	Description
IList<string>

Implements

IDirectResponseSchema