Class UniversalAction (2.43.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
Type Description
int

RUN_FUNCTION_FIELD_NUMBER

public static final int RUN_FUNCTION_FIELD_NUMBER
Field Value
Type Description
int

TEXT_FIELD_NUMBER

public static final int TEXT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static UniversalAction getDefaultInstance()
Returns
Type Description
UniversalAction

getDescriptor()

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

newBuilder()

public static UniversalAction.Builder newBuilder()
Returns
Type Description
UniversalAction.Builder

newBuilder(UniversalAction prototype)

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

parseDelimitedFrom(InputStream input)

public static UniversalAction parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UniversalAction
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static UniversalAction parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
UniversalAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static UniversalAction parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
UniversalAction
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static UniversalAction parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UniversalAction
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static UniversalAction parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
UniversalAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<UniversalAction> parser()
Returns
Type Description
Parser<UniversalAction>

Methods

equals(Object obj)

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

getActionTypeCase()

public UniversalAction.ActionTypeCase getActionTypeCase()
Returns
Type Description
UniversalAction.ActionTypeCase

getDefaultInstanceForType()

public UniversalAction getDefaultInstanceForType()
Returns
Type Description
UniversalAction
public String getOpenLink()

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

string open_link = 2;

Returns
Type Description
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
Type Description
ByteString

The bytes for openLink.

getParserForType()

public Parser<UniversalAction> getParserForType()
Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for runFunction.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getText()

public String getText()

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

string text = 1;

Returns
Type Description
String

The text.

getTextBytes()

public ByteString getTextBytes()

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

string text = 1;

Returns
Type Description
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
Type Description
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
Type Description
boolean

Whether the runFunction field is set.

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 UniversalAction.Builder newBuilderForType()
Returns
Type Description
UniversalAction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public UniversalAction.Builder toBuilder()
Returns
Type Description
UniversalAction.Builder

writeTo(CodedOutputStream output)

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