final class Action extends GeneratedMessageV3 with ActionOrBuilder

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](https://developers.google.com/workspace/extend):

Protobuf type google.apps.card.v1.Action

Source
Action.java
Linear Supertypes
ActionOrBuilder, GeneratedMessageV3, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Action
  2. ActionOrBuilder
  3. GeneratedMessageV3
  4. Serializable
  5. AbstractMessage
  6. Message
  7. MessageOrBuilder
  8. AbstractMessageLite
  9. MessageLite
  10. MessageLiteOrBuilder
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(obj: AnyRef): Boolean
    Definition Classes
    Action → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  10. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  11. def getAllWidgetsAreRequired(): Boolean

    Optional. If this is true, then all widgets are considered required by
this action.

[Google Workspace add-ons and Chat
apps](https://developers.google.com/workspace/extend):


    Optional. If this is true, then all widgets are considered required by
this action.

[Google Workspace add-ons and Chat
apps](https://developers.google.com/workspace/extend):

    bool all_widgets_are_required = 7;

    returns

    The allWidgetsAreRequired.

    Definition Classes
    Action → ActionOrBuilder
    Annotations
    @Override()
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def getDefaultInstanceForType(): Action
    Definition Classes
    Action → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  14. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  15. def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  16. def getFunction(): String

    A custom function to invoke when the containing element is
clicked or otherwise activated.

For example usage, see [Read form
data](https://developers.google.com/workspace/chat/read-form-data).


    A custom function to invoke when the containing element is
clicked or otherwise activated.

For example usage, see [Read form
data](https://developers.google.com/workspace/chat/read-form-data).

    string function = 1;

    returns

    The function.

    Definition Classes
    Action → ActionOrBuilder
    Annotations
    @Override()
  17. def getFunctionBytes(): ByteString

    A custom function to invoke when the containing element is
clicked or otherwise activated.

For example usage, see [Read form
data](https://developers.google.com/workspace/chat/read-form-data).


    A custom function to invoke when the containing element is
clicked or otherwise 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.

    Definition Classes
    Action → ActionOrBuilder
    Annotations
    @Override()
  18. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  19. def getInteraction(): Interaction

    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):


    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.

    Definition Classes
    Action → ActionOrBuilder
    Annotations
    @Override()
  20. def getInteractionValue(): Int

    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):


    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.

    Definition Classes
    Action → ActionOrBuilder
    Annotations
    @Override()
  21. def getLoadIndicator(): LoadIndicator

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


    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.

    Definition Classes
    Action → ActionOrBuilder
    Annotations
    @Override()
  22. def getLoadIndicatorValue(): Int

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


    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.

    Definition Classes
    Action → ActionOrBuilder
    Annotations
    @Override()
  23. def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  24. def getParameters(index: Int): ActionParameter

    List of action parameters.


    List of action parameters.

    repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;

    Definition Classes
    Action → ActionOrBuilder
    Annotations
    @Override()
  25. def getParametersCount(): Int

    List of action parameters.


    List of action parameters.

    repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;

    Definition Classes
    Action → ActionOrBuilder
    Annotations
    @Override()
  26. def getParametersList(): List[ActionParameter]

    List of action parameters.


    List of action parameters.

    repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;

    Definition Classes
    Action → ActionOrBuilder
    Annotations
    @Override()
  27. def getParametersOrBuilder(index: Int): ActionParameterOrBuilder

    List of action parameters.


    List of action parameters.

    repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;

    Definition Classes
    Action → ActionOrBuilder
    Annotations
    @Override()
  28. def getParametersOrBuilderList(): List[_ <: ActionParameterOrBuilder]

    List of action parameters.


    List of action parameters.

    repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;

    Definition Classes
    Action → ActionOrBuilder
    Annotations
    @Override()
  29. def getParserForType(): Parser[Action]
    Definition Classes
    Action → GeneratedMessageV3 → Message → MessageLite
    Annotations
    @Override()
  30. def getPersistValues(): Boolean

    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`.


    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.

    Definition Classes
    Action → ActionOrBuilder
    Annotations
    @Override()
  31. def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  32. def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  33. def getRequiredWidgets(index: Int): String

    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](https://developers.google.com/workspace/extend):


    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](https://developers.google.com/workspace/extend):

    repeated string required_widgets = 6;

    index

    The index of the element to return.

    returns

    The requiredWidgets at the given index.

    Definition Classes
    Action → ActionOrBuilder
  34. def getRequiredWidgetsBytes(index: Int): ByteString

    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](https://developers.google.com/workspace/extend):


    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](https://developers.google.com/workspace/extend):

    repeated string required_widgets = 6;

    index

    The index of the value to return.

    returns

    The bytes of the requiredWidgets at the given index.

    Definition Classes
    Action → ActionOrBuilder
  35. def getRequiredWidgetsCount(): Int

    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](https://developers.google.com/workspace/extend):


    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](https://developers.google.com/workspace/extend):

    repeated string required_widgets = 6;

    returns

    The count of requiredWidgets.

    Definition Classes
    Action → ActionOrBuilder
  36. def getRequiredWidgetsList(): ProtocolStringList

    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](https://developers.google.com/workspace/extend):


    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](https://developers.google.com/workspace/extend):

    repeated string required_widgets = 6;

    returns

    A list containing the requiredWidgets.

    Definition Classes
    Action → ActionOrBuilder
  37. def getSerializedSize(): Int
    Definition Classes
    Action → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  38. def getUnknownFields(): UnknownFieldSet
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  39. def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  40. def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  41. def hashCode(): Int
    Definition Classes
    Action → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  42. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[v1]
    Definition Classes
    Action → GeneratedMessageV3
    Annotations
    @Override()
  43. def internalGetMapField(arg0: Int): MapField[_ <: AnyRef, _ <: AnyRef]
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  44. final def isInitialized(): Boolean
    Definition Classes
    Action → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
    Annotations
    @Override()
  45. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  46. def makeExtensionsImmutable(): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  47. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  48. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[v1]
    Definition Classes
    Action → GeneratedMessageV3
    Annotations
    @Override()
  49. def newBuilderForType(): Builder
    Definition Classes
    Action → Message → MessageLite
    Annotations
    @Override()
  50. def newBuilderForType(arg0: BuilderParent): Builder
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3 → AbstractMessage
  51. def newInstance(unused: UnusedPrivateParameter): AnyRef
    Attributes
    protected[v1]
    Definition Classes
    Action → GeneratedMessageV3
    Annotations
    @Override() @SuppressWarnings()
  52. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  53. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  54. def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  55. def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  56. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  57. def toBuilder(): Builder
    Definition Classes
    Action → Message → MessageLite
    Annotations
    @Override()
  58. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  59. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  60. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  61. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  62. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  63. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  64. def writeDelimitedTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])
  65. def writeReplace(): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.ObjectStreamException])
  66. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    Action → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  67. def writeTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])

Deprecated Value Members

  1. def mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[com.google.protobuf.InvalidProtocolBufferException]) @Deprecated
    Deprecated

Inherited from ActionOrBuilder

Inherited from GeneratedMessageV3

Inherited from Serializable

Inherited from AbstractMessage

Inherited from Message

Inherited from MessageOrBuilder

Inherited from AbstractMessageLite[MessageType, BuilderType]

Inherited from MessageLite

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped