Class WidgetMarkup.FormAction (0.13.0)

public static final class WidgetMarkup.FormAction extends GeneratedMessageV3 implements WidgetMarkup.FormActionOrBuilder

A form action describes the behavior when the form is submitted. For example, you can invoke Apps Script to handle the form.

Protobuf type google.chat.v1.WidgetMarkup.FormAction

Static Fields

ACTION_METHOD_NAME_FIELD_NUMBER

public static final int ACTION_METHOD_NAME_FIELD_NUMBER
Field Value
Type Description
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static WidgetMarkup.FormAction getDefaultInstance()
Returns
Type Description
WidgetMarkup.FormAction

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static WidgetMarkup.FormAction.Builder newBuilder()
Returns
Type Description
WidgetMarkup.FormAction.Builder

newBuilder(WidgetMarkup.FormAction prototype)

public static WidgetMarkup.FormAction.Builder newBuilder(WidgetMarkup.FormAction prototype)
Parameter
Name Description
prototype WidgetMarkup.FormAction
Returns
Type Description
WidgetMarkup.FormAction.Builder

parseDelimitedFrom(InputStream input)

public static WidgetMarkup.FormAction parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WidgetMarkup.FormAction
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WidgetMarkup.FormAction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WidgetMarkup.FormAction
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static WidgetMarkup.FormAction parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
WidgetMarkup.FormAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static WidgetMarkup.FormAction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WidgetMarkup.FormAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static WidgetMarkup.FormAction parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
WidgetMarkup.FormAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static WidgetMarkup.FormAction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WidgetMarkup.FormAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static WidgetMarkup.FormAction parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
WidgetMarkup.FormAction
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static WidgetMarkup.FormAction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WidgetMarkup.FormAction
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static WidgetMarkup.FormAction parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WidgetMarkup.FormAction
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WidgetMarkup.FormAction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WidgetMarkup.FormAction
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static WidgetMarkup.FormAction parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
WidgetMarkup.FormAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static WidgetMarkup.FormAction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WidgetMarkup.FormAction
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<WidgetMarkup.FormAction> parser()
Returns
Type Description
Parser<FormAction>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getActionMethodName()

public String getActionMethodName()

The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. You can use the same method name for several elements that trigger a common behavior.

string action_method_name = 1;

Returns
Type Description
String

The actionMethodName.

getActionMethodNameBytes()

public ByteString getActionMethodNameBytes()

The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. You can use the same method name for several elements that trigger a common behavior.

string action_method_name = 1;

Returns
Type Description
ByteString

The bytes for actionMethodName.

getDefaultInstanceForType()

public WidgetMarkup.FormAction getDefaultInstanceForType()
Returns
Type Description
WidgetMarkup.FormAction

getParameters(int index)

public WidgetMarkup.FormAction.ActionParameter getParameters(int index)

List of action parameters.

repeated .google.chat.v1.WidgetMarkup.FormAction.ActionParameter parameters = 2;

Parameter
Name Description
index int
Returns
Type Description
WidgetMarkup.FormAction.ActionParameter

getParametersCount()

public int getParametersCount()

List of action parameters.

repeated .google.chat.v1.WidgetMarkup.FormAction.ActionParameter parameters = 2;

Returns
Type Description
int

getParametersList()

public List<WidgetMarkup.FormAction.ActionParameter> getParametersList()

List of action parameters.

repeated .google.chat.v1.WidgetMarkup.FormAction.ActionParameter parameters = 2;

Returns
Type Description
List<ActionParameter>

getParametersOrBuilder(int index)

public WidgetMarkup.FormAction.ActionParameterOrBuilder getParametersOrBuilder(int index)

List of action parameters.

repeated .google.chat.v1.WidgetMarkup.FormAction.ActionParameter parameters = 2;

Parameter
Name Description
index int
Returns
Type Description
WidgetMarkup.FormAction.ActionParameterOrBuilder

getParametersOrBuilderList()

public List<? extends WidgetMarkup.FormAction.ActionParameterOrBuilder> getParametersOrBuilderList()

List of action parameters.

repeated .google.chat.v1.WidgetMarkup.FormAction.ActionParameter parameters = 2;

Returns
Type Description
List<? extends com.google.chat.v1.WidgetMarkup.FormAction.ActionParameterOrBuilder>

getParserForType()

public Parser<WidgetMarkup.FormAction> getParserForType()
Returns
Type Description
Parser<FormAction>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public WidgetMarkup.FormAction.Builder newBuilderForType()
Returns
Type Description
WidgetMarkup.FormAction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected WidgetMarkup.FormAction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
WidgetMarkup.FormAction.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public WidgetMarkup.FormAction.Builder toBuilder()
Returns
Type Description
WidgetMarkup.FormAction.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException