Interface ActionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Action, Action.Builder
public interface ActionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getFunction

      String getFunction()
      A custom function to invoke when the containing element is
clicked or othrwise activated.

For example usage, see [Read form
data](https://developers.google.com/workspace/chat/read-form-data).
      string function = 1;
      Returns:
      The function.

    • getFunctionBytes

      com.google.protobuf.ByteString getFunctionBytes()
      A custom function to invoke when the containing element is
clicked or othrwise activated.

For example usage, see [Read form
data](https://developers.google.com/workspace/chat/read-form-data).
      string function = 1;
      Returns:
      The bytes for function.

    • getParametersList

      List<Action.ActionParameter> getParametersList()
      List of action parameters.
      repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;

    • getParameters

      Action.ActionParameter getParameters(int index)
      List of action parameters.
      repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;

    • getParametersCount

      int getParametersCount()
      List of action parameters.
      repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;

    • getParametersOrBuilderList

      List<? extends Action.ActionParameterOrBuilder> getParametersOrBuilderList()
      List of action parameters.
      repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;

    • getParametersOrBuilder

      Action.ActionParameterOrBuilder getParametersOrBuilder(int index)
      List of action parameters.
      repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;

    • getLoadIndicatorValue

      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:
      The enum numeric value on the wire for loadIndicator.

    • getLoadIndicator

      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:
      The loadIndicator.

    • getPersistValues

      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`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator)
to `NONE`. For [card
messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create)
in Chat apps, you must also set the action's
[`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype)
to `UPDATE_MESSAGE` and use the same
[`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId)
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`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator)
to `SPINNER`.
      bool persist_values = 4;
      Returns:
      The persistValues.

    • getInteractionValue

      int getInteractionValue()
      Optional. Required when opening a
[dialog](https://developers.google.com/workspace/chat/dialogs).

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](https://developers.google.com/workspace/chat/dialogs). 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](https://developers.google.com/workspace/chat):
      .google.apps.card.v1.Action.Interaction interaction = 5;
      Returns:
      The enum numeric value on the wire for interaction.

    • getInteraction

      Action.Interaction getInteraction()
      Optional. Required when opening a
[dialog](https://developers.google.com/workspace/chat/dialogs).

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](https://developers.google.com/workspace/chat/dialogs). 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](https://developers.google.com/workspace/chat):
      .google.apps.card.v1.Action.Interaction interaction = 5;
      Returns:
      The interaction.