Package com.google.apps.card.v1

Class Action

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.apps.card.v1.Action
All Implemented Interfaces:
ActionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Action extends com.google.protobuf.GeneratedMessage implements 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
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Action.ActionParameter
    List of string parameters to supply when the action method is invoked.
    static interface 
    Action.ActionParameterOrBuilder
     
    static final class 
    Action.Builder
    An action that describes the behavior when the form is submitted.
    static enum 
    Action.Interaction
    Optional.
    static enum 
    Action.LoadIndicator
    Specifies the loading indicator that the action displays while making the call to the action.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ALL_WIDGETS_ARE_REQUIRED_FIELD_NUMBER
     
    static final int
    FUNCTION_FIELD_NUMBER
     
    static final int
    INTERACTION_FIELD_NUMBER
     
    static final int
    LOAD_INDICATOR_FIELD_NUMBER
     
    static final int
    PARAMETERS_FIELD_NUMBER
     
    static final int
    PERSIST_VALUES_FIELD_NUMBER
     
    static final int
    REQUIRED_WIDGETS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    boolean
    getAllWidgetsAreRequired()
    Optional.
    static Action
    getDefaultInstance()
     
    Action
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getFunction()
    A custom function to invoke when the containing element is clicked or otherwise activated.
    com.google.protobuf.ByteString
    getFunctionBytes()
    A custom function to invoke when the containing element is clicked or otherwise activated.
    Action.Interaction
    getInteraction()
    Optional.
    int
    getInteractionValue()
    Optional.
    Action.LoadIndicator
    getLoadIndicator()
    Specifies the loading indicator that the action displays while making the call to the action.
    int
    getLoadIndicatorValue()
    Specifies the loading indicator that the action displays while making the call to the action.
    Action.ActionParameter
    getParameters(int index)
    List of action parameters.
    int
    getParametersCount()
    List of action parameters.
    List<Action.ActionParameter>
    getParametersList()
    List of action parameters.
    Action.ActionParameterOrBuilder
    getParametersOrBuilder(int index)
    List of action parameters.
    List<? extends Action.ActionParameterOrBuilder>
    getParametersOrBuilderList()
    List of action parameters.
    com.google.protobuf.Parser<Action>
    getParserForType()
     
    boolean
    getPersistValues()
    Indicates whether form values persist after the action.
    String
    getRequiredWidgets(int index)
    Optional.
    com.google.protobuf.ByteString
    getRequiredWidgetsBytes(int index)
    Optional.
    int
    getRequiredWidgetsCount()
    Optional.
    com.google.protobuf.ProtocolStringList
    getRequiredWidgetsList()
    Optional.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Action.Builder
    newBuilder()
     
    static Action.Builder
    newBuilder(Action prototype)
     
    Action.Builder
    newBuilderForType()
     
    protected Action.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Action
    parseDelimitedFrom(InputStream input)
     
    static Action
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Action
    parseFrom(byte[] data)
     
    static Action
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Action
    parseFrom(com.google.protobuf.ByteString data)
     
    static Action
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Action
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Action
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Action
    parseFrom(InputStream input)
     
    static Action
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Action
    parseFrom(ByteBuffer data)
     
    static Action
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Action>
    parser()
     
    Action.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • FUNCTION_FIELD_NUMBER

      public static final int FUNCTION_FIELD_NUMBER
      See Also:

    • PARAMETERS_FIELD_NUMBER

      public static final int PARAMETERS_FIELD_NUMBER
      See Also:

    • LOAD_INDICATOR_FIELD_NUMBER

      public static final int LOAD_INDICATOR_FIELD_NUMBER
      See Also:

    • PERSIST_VALUES_FIELD_NUMBER

      public static final int PERSIST_VALUES_FIELD_NUMBER
      See Also:

    • INTERACTION_FIELD_NUMBER

      public static final int INTERACTION_FIELD_NUMBER
      See Also:

    • REQUIRED_WIDGETS_FIELD_NUMBER

      public static final int REQUIRED_WIDGETS_FIELD_NUMBER
      See Also:

    • ALL_WIDGETS_ARE_REQUIRED_FIELD_NUMBER

      public static final int ALL_WIDGETS_ARE_REQUIRED_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getFunction

      public String getFunction()
       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;
      Specified by:
      getFunction in interface ActionOrBuilder
      Returns:
      The function.

    • getFunctionBytes

      public com.google.protobuf.ByteString getFunctionBytes()
       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;
      Specified by:
      getFunctionBytes in interface ActionOrBuilder
      Returns:
      The bytes for function.

    • getParametersList

      public List<Action.ActionParameter> getParametersList()
       List of action parameters.
      repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;
      Specified by:
      getParametersList in interface ActionOrBuilder

    • getParametersOrBuilderList

      public List<? extends Action.ActionParameterOrBuilder> getParametersOrBuilderList()
       List of action parameters.
      repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;
      Specified by:
      getParametersOrBuilderList in interface ActionOrBuilder

    • getParametersCount

      public int getParametersCount()
       List of action parameters.
      repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;
      Specified by:
      getParametersCount in interface ActionOrBuilder

    • getParameters

      public Action.ActionParameter getParameters(int index)
       List of action parameters.
      repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;
      Specified by:
      getParameters in interface ActionOrBuilder

    • getParametersOrBuilder

      public Action.ActionParameterOrBuilder getParametersOrBuilder(int index)
       List of action parameters.
      repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;
      Specified by:
      getParametersOrBuilder in interface ActionOrBuilder

    • getLoadIndicatorValue

      public 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;
      Specified by:
      getLoadIndicatorValue in interface ActionOrBuilder
      Returns:
      The enum numeric value on the wire for loadIndicator.

    • getLoadIndicator

      public 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;
      Specified by:
      getLoadIndicator in interface ActionOrBuilder
      Returns:
      The loadIndicator.

    • getPersistValues

      public 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;
      Specified by:
      getPersistValues in interface ActionOrBuilder
      Returns:
      The persistValues.

    • getInteractionValue

      public 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;
      Specified by:
      getInteractionValue in interface ActionOrBuilder
      Returns:
      The enum numeric value on the wire for interaction.

    • getInteraction

      public 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;
      Specified by:
      getInteraction in interface ActionOrBuilder
      Returns:
      The interaction.

    • getRequiredWidgetsList

      public com.google.protobuf.ProtocolStringList getRequiredWidgetsList()
       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;
      Specified by:
      getRequiredWidgetsList in interface ActionOrBuilder
      Returns:
      A list containing the requiredWidgets.

    • getRequiredWidgetsCount

      public int getRequiredWidgetsCount()
       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;
      Specified by:
      getRequiredWidgetsCount in interface ActionOrBuilder
      Returns:
      The count of requiredWidgets.

    • getRequiredWidgets

      public String getRequiredWidgets(int index)
       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;
      Specified by:
      getRequiredWidgets in interface ActionOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The requiredWidgets at the given index.

    • getRequiredWidgetsBytes

      public com.google.protobuf.ByteString getRequiredWidgetsBytes(int index)
       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;
      Specified by:
      getRequiredWidgetsBytes in interface ActionOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the requiredWidgets at the given index.

    • getAllWidgetsAreRequired

      public boolean getAllWidgetsAreRequired()
       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;
      Specified by:
      getAllWidgetsAreRequired in interface ActionOrBuilder
      Returns:
      The allWidgetsAreRequired.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Action parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Action parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Action parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Action parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Action parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Action parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Action parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Action parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Action parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Action parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Action parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Action parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Action.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Action.Builder newBuilder()

    • newBuilder

      public static Action.Builder newBuilder(Action prototype)

    • toBuilder

      public Action.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Action.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Action getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Action> parser()

    • getParserForType

      public com.google.protobuf.Parser<Action> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Action getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder