Class UniversalAction (2.23.0)

public final class UniversalAction extends GeneratedMessageV3 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 Fields

public static final int OPEN_LINK_FIELD_NUMBER
Field Value
TypeDescription
int

RUN_FUNCTION_FIELD_NUMBER

public static final int RUN_FUNCTION_FIELD_NUMBER
Field Value
TypeDescription
int

TEXT_FIELD_NUMBER

public static final int TEXT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static UniversalAction getDefaultInstance()
Returns
TypeDescription
UniversalAction

getDescriptor()

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

newBuilder()

public static UniversalAction.Builder newBuilder()
Returns
TypeDescription
UniversalAction.Builder

newBuilder(UniversalAction prototype)

public static UniversalAction.Builder newBuilder(UniversalAction prototype)
Parameter
NameDescription
prototypeUniversalAction
Returns
TypeDescription
UniversalAction.Builder

parseDelimitedFrom(InputStream input)

public static UniversalAction parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UniversalAction
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UniversalAction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UniversalAction
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static UniversalAction parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
UniversalAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UniversalAction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UniversalAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UniversalAction parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
UniversalAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UniversalAction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UniversalAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UniversalAction parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
UniversalAction
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UniversalAction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UniversalAction
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static UniversalAction parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UniversalAction
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UniversalAction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UniversalAction
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static UniversalAction parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
UniversalAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UniversalAction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UniversalAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<UniversalAction> parser()
Returns
TypeDescription
Parser<UniversalAction>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getActionTypeCase()

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

getDefaultInstanceForType()

public UniversalAction getDefaultInstanceForType()
Returns
TypeDescription
UniversalAction
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.

getParserForType()

public Parser<UniversalAction> getParserForType()
Returns
TypeDescription
Parser<UniversalAction>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UniversalAction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
UniversalAction.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException