Class UniversalAction.Builder (2.20.0)

public static final class UniversalAction.Builder extends GeneratedMessageV3.Builder<UniversalAction.Builder> implements UniversalActionOrBuilder

An action that is always available in the add-on toolbar menu regardless of message context.

Protobuf type google.apps.script.type.gmail.UniversalAction

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UniversalAction.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
UniversalAction.Builder
Overrides

build()

public UniversalAction build()
Returns
TypeDescription
UniversalAction

buildPartial()

public UniversalAction buildPartial()
Returns
TypeDescription
UniversalAction

clear()

public UniversalAction.Builder clear()
Returns
TypeDescription
UniversalAction.Builder
Overrides

clearActionType()

public UniversalAction.Builder clearActionType()
Returns
TypeDescription
UniversalAction.Builder

clearField(Descriptors.FieldDescriptor field)

public UniversalAction.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
UniversalAction.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public UniversalAction.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
UniversalAction.Builder
Overrides
public UniversalAction.Builder clearOpenLink()

A link that is opened by Gmail when the user triggers the action.

string open_link = 2;

Returns
TypeDescription
UniversalAction.Builder

This builder for chaining.

clearRunFunction()

public UniversalAction.Builder clearRunFunction()

An endpoint that is called when the user triggers the action. See the universal actions guide for details.

string run_function = 3;

Returns
TypeDescription
UniversalAction.Builder

This builder for chaining.

clearText()

public UniversalAction.Builder clearText()

Required. User-visible text describing the action, for example, "Add a new contact."

string text = 1;

Returns
TypeDescription
UniversalAction.Builder

This builder for chaining.

clone()

public UniversalAction.Builder clone()
Returns
TypeDescription
UniversalAction.Builder
Overrides

getActionTypeCase()

public UniversalAction.ActionTypeCase getActionTypeCase()
Returns
TypeDescription
UniversalAction.ActionTypeCase

getDefaultInstanceForType()

public UniversalAction getDefaultInstanceForType()
Returns
TypeDescription
UniversalAction

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides
public String getOpenLink()

A link that is opened by Gmail when the user triggers the action.

string open_link = 2;

Returns
TypeDescription
String

The openLink.

getOpenLinkBytes()

public ByteString getOpenLinkBytes()

A link that is opened by Gmail when the user triggers the action.

string open_link = 2;

Returns
TypeDescription
ByteString

The bytes for openLink.

getRunFunction()

public String getRunFunction()

An endpoint that is called when the user triggers the action. See the universal actions guide for details.

string run_function = 3;

Returns
TypeDescription
String

The runFunction.

getRunFunctionBytes()

public ByteString getRunFunctionBytes()

An endpoint that is called when the user triggers the action. See the universal actions guide for details.

string run_function = 3;

Returns
TypeDescription
ByteString

The bytes for runFunction.

getText()

public String getText()

Required. User-visible text describing the action, for example, "Add a new contact."

string text = 1;

Returns
TypeDescription
String

The text.

getTextBytes()

public ByteString getTextBytes()

Required. User-visible text describing the action, for example, "Add a new contact."

string text = 1;

Returns
TypeDescription
ByteString

The bytes for text.

public boolean hasOpenLink()

A link that is opened by Gmail when the user triggers the action.

string open_link = 2;

Returns
TypeDescription
boolean

Whether the openLink field is set.

hasRunFunction()

public boolean hasRunFunction()

An endpoint that is called when the user triggers the action. See the universal actions guide for details.

string run_function = 3;

Returns
TypeDescription
boolean

Whether the runFunction field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(UniversalAction other)

public UniversalAction.Builder mergeFrom(UniversalAction other)
Parameter
NameDescription
otherUniversalAction
Returns
TypeDescription
UniversalAction.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UniversalAction.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UniversalAction.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public UniversalAction.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
UniversalAction.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UniversalAction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
UniversalAction.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public UniversalAction.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
UniversalAction.Builder
Overrides
public UniversalAction.Builder setOpenLink(String value)

A link that is opened by Gmail when the user triggers the action.

string open_link = 2;

Parameter
NameDescription
valueString

The openLink to set.

Returns
TypeDescription
UniversalAction.Builder

This builder for chaining.

setOpenLinkBytes(ByteString value)

public UniversalAction.Builder setOpenLinkBytes(ByteString value)

A link that is opened by Gmail when the user triggers the action.

string open_link = 2;

Parameter
NameDescription
valueByteString

The bytes for openLink to set.

Returns
TypeDescription
UniversalAction.Builder

This builder for chaining.

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

public UniversalAction.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
UniversalAction.Builder
Overrides

setRunFunction(String value)

public UniversalAction.Builder setRunFunction(String value)

An endpoint that is called when the user triggers the action. See the universal actions guide for details.

string run_function = 3;

Parameter
NameDescription
valueString

The runFunction to set.

Returns
TypeDescription
UniversalAction.Builder

This builder for chaining.

setRunFunctionBytes(ByteString value)

public UniversalAction.Builder setRunFunctionBytes(ByteString value)

An endpoint that is called when the user triggers the action. See the universal actions guide for details.

string run_function = 3;

Parameter
NameDescription
valueByteString

The bytes for runFunction to set.

Returns
TypeDescription
UniversalAction.Builder

This builder for chaining.

setText(String value)

public UniversalAction.Builder setText(String value)

Required. User-visible text describing the action, for example, "Add a new contact."

string text = 1;

Parameter
NameDescription
valueString

The text to set.

Returns
TypeDescription
UniversalAction.Builder

This builder for chaining.

setTextBytes(ByteString value)

public UniversalAction.Builder setTextBytes(ByteString value)

Required. User-visible text describing the action, for example, "Add a new contact."

string text = 1;

Parameter
NameDescription
valueByteString

The bytes for text to set.

Returns
TypeDescription
UniversalAction.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final UniversalAction.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
UniversalAction.Builder
Overrides