Class WidgetMarkup.FormAction.Builder (0.7.0)

public static final class WidgetMarkup.FormAction.Builder extends GeneratedMessageV3.Builder<WidgetMarkup.FormAction.Builder> 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 Methods

getDescriptor()

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

Methods

addAllParameters(Iterable<? extends WidgetMarkup.FormAction.ActionParameter> values)

public WidgetMarkup.FormAction.Builder addAllParameters(Iterable<? extends WidgetMarkup.FormAction.ActionParameter> values)

List of action parameters.

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

Parameter
Name Description
values Iterable<? extends com.google.chat.v1.WidgetMarkup.FormAction.ActionParameter>
Returns
Type Description
WidgetMarkup.FormAction.Builder

addParameters(WidgetMarkup.FormAction.ActionParameter value)

public WidgetMarkup.FormAction.Builder addParameters(WidgetMarkup.FormAction.ActionParameter value)

List of action parameters.

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

Parameter
Name Description
value WidgetMarkup.FormAction.ActionParameter
Returns
Type Description
WidgetMarkup.FormAction.Builder

addParameters(WidgetMarkup.FormAction.ActionParameter.Builder builderForValue)

public WidgetMarkup.FormAction.Builder addParameters(WidgetMarkup.FormAction.ActionParameter.Builder builderForValue)

List of action parameters.

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

Parameter
Name Description
builderForValue WidgetMarkup.FormAction.ActionParameter.Builder
Returns
Type Description
WidgetMarkup.FormAction.Builder

addParameters(int index, WidgetMarkup.FormAction.ActionParameter value)

public WidgetMarkup.FormAction.Builder addParameters(int index, WidgetMarkup.FormAction.ActionParameter value)

List of action parameters.

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

Parameters
Name Description
index int
value WidgetMarkup.FormAction.ActionParameter
Returns
Type Description
WidgetMarkup.FormAction.Builder

addParameters(int index, WidgetMarkup.FormAction.ActionParameter.Builder builderForValue)

public WidgetMarkup.FormAction.Builder addParameters(int index, WidgetMarkup.FormAction.ActionParameter.Builder builderForValue)

List of action parameters.

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

Parameters
Name Description
index int
builderForValue WidgetMarkup.FormAction.ActionParameter.Builder
Returns
Type Description
WidgetMarkup.FormAction.Builder

addParametersBuilder()

public WidgetMarkup.FormAction.ActionParameter.Builder addParametersBuilder()

List of action parameters.

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

Returns
Type Description
WidgetMarkup.FormAction.ActionParameter.Builder

addParametersBuilder(int index)

public WidgetMarkup.FormAction.ActionParameter.Builder addParametersBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public WidgetMarkup.FormAction.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
WidgetMarkup.FormAction.Builder
Overrides

build()

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

buildPartial()

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

clear()

public WidgetMarkup.FormAction.Builder clear()
Returns
Type Description
WidgetMarkup.FormAction.Builder
Overrides

clearActionMethodName()

public WidgetMarkup.FormAction.Builder clearActionMethodName()

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
WidgetMarkup.FormAction.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public WidgetMarkup.FormAction.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
WidgetMarkup.FormAction.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public WidgetMarkup.FormAction.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
WidgetMarkup.FormAction.Builder
Overrides

clearParameters()

public WidgetMarkup.FormAction.Builder clearParameters()

List of action parameters.

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

Returns
Type Description
WidgetMarkup.FormAction.Builder

clone()

public WidgetMarkup.FormAction.Builder clone()
Returns
Type Description
WidgetMarkup.FormAction.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

getParametersBuilder(int index)

public WidgetMarkup.FormAction.ActionParameter.Builder getParametersBuilder(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.Builder

getParametersBuilderList()

public List<WidgetMarkup.FormAction.ActionParameter.Builder> getParametersBuilderList()

List of action parameters.

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

Returns
Type Description
List<Builder>

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>

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(WidgetMarkup.FormAction other)

public WidgetMarkup.FormAction.Builder mergeFrom(WidgetMarkup.FormAction other)
Parameter
Name Description
other WidgetMarkup.FormAction
Returns
Type Description
WidgetMarkup.FormAction.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public WidgetMarkup.FormAction.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WidgetMarkup.FormAction.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public WidgetMarkup.FormAction.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
WidgetMarkup.FormAction.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final WidgetMarkup.FormAction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
WidgetMarkup.FormAction.Builder
Overrides

removeParameters(int index)

public WidgetMarkup.FormAction.Builder removeParameters(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.Builder

setActionMethodName(String value)

public WidgetMarkup.FormAction.Builder setActionMethodName(String value)

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;

Parameter
Name Description
value String

The actionMethodName to set.

Returns
Type Description
WidgetMarkup.FormAction.Builder

This builder for chaining.

setActionMethodNameBytes(ByteString value)

public WidgetMarkup.FormAction.Builder setActionMethodNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for actionMethodName to set.

Returns
Type Description
WidgetMarkup.FormAction.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public WidgetMarkup.FormAction.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
WidgetMarkup.FormAction.Builder
Overrides

setParameters(int index, WidgetMarkup.FormAction.ActionParameter value)

public WidgetMarkup.FormAction.Builder setParameters(int index, WidgetMarkup.FormAction.ActionParameter value)

List of action parameters.

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

Parameters
Name Description
index int
value WidgetMarkup.FormAction.ActionParameter
Returns
Type Description
WidgetMarkup.FormAction.Builder

setParameters(int index, WidgetMarkup.FormAction.ActionParameter.Builder builderForValue)

public WidgetMarkup.FormAction.Builder setParameters(int index, WidgetMarkup.FormAction.ActionParameter.Builder builderForValue)

List of action parameters.

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

Parameters
Name Description
index int
builderForValue WidgetMarkup.FormAction.ActionParameter.Builder
Returns
Type Description
WidgetMarkup.FormAction.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public WidgetMarkup.FormAction.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
WidgetMarkup.FormAction.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final WidgetMarkup.FormAction.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
WidgetMarkup.FormAction.Builder
Overrides