public interface ActionOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getFunction()
public abstract String getFunction()
A custom function to invoke when the containing element is clicked or othrwise activated.
For example usage, see Create interactive cards.
string function = 1;
Returns | |
---|---|
Type | Description |
String | The function. |
getFunctionBytes()
public abstract ByteString getFunctionBytes()
A custom function to invoke when the containing element is clicked or othrwise activated.
For example usage, see Create interactive cards.
string function = 1;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for function. |
getInteraction()
public abstract Action.Interaction getInteraction()
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.apps.card.v1.Action.Interaction interaction = 5;
Returns | |
---|---|
Type | Description |
Action.Interaction | The interaction. |
getInteractionValue()
public abstract int getInteractionValue()
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.apps.card.v1.Action.Interaction interaction = 5;
Returns | |
---|---|
Type | Description |
int | The enum numeric value on the wire for interaction. |
getLoadIndicator()
public abstract Action.LoadIndicator getLoadIndicator()
Specifies the loading indicator that the action displays while making the call to the action.
.google.apps.card.v1.Action.LoadIndicator load_indicator = 3;
Returns | |
---|---|
Type | Description |
Action.LoadIndicator | The loadIndicator. |
getLoadIndicatorValue()
public abstract int getLoadIndicatorValue()
Specifies the loading indicator that the action displays while making the call to the action.
.google.apps.card.v1.Action.LoadIndicator load_indicator = 3;
Returns | |
---|---|
Type | Description |
int | The enum numeric value on the wire for loadIndicator. |
getParameters(int index)
public abstract Action.ActionParameter getParameters(int index)
List of action parameters.
repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
Action.ActionParameter |
getParametersCount()
public abstract int getParametersCount()
List of action parameters.
repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;
Returns | |
---|---|
Type | Description |
int |
getParametersList()
public abstract List<Action.ActionParameter> getParametersList()
List of action parameters.
repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;
Returns | |
---|---|
Type | Description |
List<ActionParameter> |
getParametersOrBuilder(int index)
public abstract Action.ActionParameterOrBuilder getParametersOrBuilder(int index)
List of action parameters.
repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
Action.ActionParameterOrBuilder |
getParametersOrBuilderList()
public abstract List<? extends Action.ActionParameterOrBuilder> getParametersOrBuilderList()
List of action parameters.
repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;
Returns | |
---|---|
Type | Description |
List<? extends com.google.apps.card.v1.Action.ActionParameterOrBuilder> |
getPersistValues()
public abstract boolean getPersistValues()
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
.
bool persist_values = 4;
Returns | |
---|---|
Type | Description |
boolean | The persistValues. |