Class UniversalAction.Builder (2.83.0)

public static final class UniversalAction.Builder extends GeneratedMessage.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
Type Description
Descriptor

Methods

build()

public UniversalAction build()
Returns
Type Description
UniversalAction

buildPartial()

public UniversalAction buildPartial()
Returns
Type Description
UniversalAction

clear()

public UniversalAction.Builder clear()
Returns
Type Description
UniversalAction.Builder
Overrides

clearActionType()

public UniversalAction.Builder clearActionType()
Returns
Type Description
UniversalAction.Builder
public UniversalAction.Builder clearOpenLink()

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

string open_link = 2;

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

This builder for chaining.

getActionTypeCase()

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

getDefaultInstanceForType()

public UniversalAction getDefaultInstanceForType()
Returns
Type Description
UniversalAction

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides
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.

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(UniversalAction other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public UniversalAction.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
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
Name Description
value String

The openLink to set.

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

The bytes for openLink to set.

Returns
Type Description
UniversalAction.Builder

This builder for chaining.

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
Name Description
value String

The runFunction to set.

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

The bytes for runFunction to set.

Returns
Type Description
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
Name Description
value String

The text to set.

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

The bytes for text to set.

Returns
Type Description
UniversalAction.Builder

This builder for chaining.