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.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.apps.card.v1.Action
-
- All Implemented Interfaces:
ActionOrBuilder
,com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
,com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,java.io.Serializable
public final class Action extends com.google.protobuf.GeneratedMessageV3 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 typegoogle.apps.card.v1.Action
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Action.ActionParameter
List of string parameters to supply when the action method is invoked.static interface
Action.ActionParameterOrBuilder
static class
Action.Builder
An action that describes the behavior when the form is submitted.static class
Action.Interaction
Optional.static class
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.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage
com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionSerializer, com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionWriter
-
-
Field Summary
Fields Modifier and Type Field Description static int
FUNCTION_FIELD_NUMBER
static int
INTERACTION_FIELD_NUMBER
static int
LOAD_INDICATOR_FIELD_NUMBER
static int
PARAMETERS_FIELD_NUMBER
static int
PERSIST_VALUES_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
static Action
getDefaultInstance()
Action
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
java.lang.String
getFunction()
A custom function to invoke when the containing element is clicked or othrwise activated.com.google.protobuf.ByteString
getFunctionBytes()
A custom function to invoke when the containing element is clicked or othrwise 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.java.util.List<Action.ActionParameter>
getParametersList()
List of action parameters.Action.ActionParameterOrBuilder
getParametersOrBuilder(int index)
List of action parameters.java.util.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.int
getSerializedSize()
int
hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static Action.Builder
newBuilder()
static Action.Builder
newBuilder(Action prototype)
Action.Builder
newBuilderForType()
protected Action.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected java.lang.Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Action
parseDelimitedFrom(java.io.InputStream input)
static Action
parseDelimitedFrom(java.io.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(java.io.InputStream input)
static Action
parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Action
parseFrom(java.nio.ByteBuffer data)
static Action
parseFrom(java.nio.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.GeneratedMessageV3
mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType
-
Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage
extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, newExtensionSerializer, newExtensionWriter, newMessageSetExtensionSerializer, newMessageSetExtensionWriter
-
Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, getUnknownFields, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, 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
-
-
-
-
Field Detail
-
FUNCTION_FIELD_NUMBER
public static final int FUNCTION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PARAMETERS_FIELD_NUMBER
public static final int PARAMETERS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
LOAD_INDICATOR_FIELD_NUMBER
public static final int LOAD_INDICATOR_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PERSIST_VALUES_FIELD_NUMBER
public static final int PERSIST_VALUES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
INTERACTION_FIELD_NUMBER
public static final int INTERACTION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Overrides:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
getFunction
public java.lang.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;
- Specified by:
getFunction
in interfaceActionOrBuilder
- Returns:
- The function.
-
getFunctionBytes
public 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;
- Specified by:
getFunctionBytes
in interfaceActionOrBuilder
- Returns:
- The bytes for function.
-
getParametersList
public java.util.List<Action.ActionParameter> getParametersList()
List of action parameters.
repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;
- Specified by:
getParametersList
in interfaceActionOrBuilder
-
getParametersOrBuilderList
public java.util.List<? extends Action.ActionParameterOrBuilder> getParametersOrBuilderList()
List of action parameters.
repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;
- Specified by:
getParametersOrBuilderList
in interfaceActionOrBuilder
-
getParametersCount
public int getParametersCount()
List of action parameters.
repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;
- Specified by:
getParametersCount
in interfaceActionOrBuilder
-
getParameters
public Action.ActionParameter getParameters(int index)
List of action parameters.
repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;
- Specified by:
getParameters
in interfaceActionOrBuilder
-
getParametersOrBuilder
public Action.ActionParameterOrBuilder getParametersOrBuilder(int index)
List of action parameters.
repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;
- Specified by:
getParametersOrBuilder
in interfaceActionOrBuilder
-
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 interfaceActionOrBuilder
- 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 interfaceActionOrBuilder
- 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 interfaceActionOrBuilder
- 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 interfaceActionOrBuilder
- 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 interfaceActionOrBuilder
- Returns:
- The interaction.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Action parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Action parseFrom(java.nio.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(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Action parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static Action parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static Action parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Action parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Action parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public Action.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.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 interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Action.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
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 interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
public Action getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-