Google Apps Chat V1 Client - Class FormAction (0.12.0)

Reference documentation and code samples for the Google Apps Chat V1 Client class FormAction.

A form action describes the behavior when the form is submitted.

For example, you can invoke Apps Script to handle the form.

Generated from protobuf message google.chat.v1.WidgetMarkup.FormAction

Namespace

Google \ Apps \ Chat \ V1 \ WidgetMarkup

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ action_method_name string

The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. You can use the same method name for several elements that trigger a common behavior.
↳ parameters array<FormAction\ActionParameter>

List of action parameters.

getActionMethodName

The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. You can use the same method name for several elements that trigger a common behavior.

Returns
Type Description
string

setActionMethodName

The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. You can use the same method name for several elements that trigger a common behavior.

Parameter
Name Description
var string
Returns
Type Description
$this

getParameters

List of action parameters.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setParameters

List of action parameters.

Parameter
Name Description
var array<FormAction\ActionParameter>
Returns
Type Description
$this