Class GmailAddOnManifest (2.45.0)

public final class GmailAddOnManifest extends GeneratedMessageV3 implements GmailAddOnManifestOrBuilder

Properties customizing the appearance and execution of a Gmail add-on.

Protobuf type google.apps.script.type.gmail.GmailAddOnManifest

Static Fields

AUTHORIZATION_CHECK_FUNCTION_FIELD_NUMBER

public static final int AUTHORIZATION_CHECK_FUNCTION_FIELD_NUMBER
Field Value
Type Description
int

COMPOSE_TRIGGER_FIELD_NUMBER

public static final int COMPOSE_TRIGGER_FIELD_NUMBER
Field Value
Type Description
int

CONTEXTUAL_TRIGGERS_FIELD_NUMBER

public static final int CONTEXTUAL_TRIGGERS_FIELD_NUMBER
Field Value
Type Description
int

HOMEPAGE_TRIGGER_FIELD_NUMBER

public static final int HOMEPAGE_TRIGGER_FIELD_NUMBER
Field Value
Type Description
int

UNIVERSAL_ACTIONS_FIELD_NUMBER

public static final int UNIVERSAL_ACTIONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GmailAddOnManifest getDefaultInstance()
Returns
Type Description
GmailAddOnManifest

getDescriptor()

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

newBuilder()

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

newBuilder(GmailAddOnManifest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAuthorizationCheckFunction()

public String getAuthorizationCheckFunction()

The name of an endpoint that verifies that the add-on has all the required third-party authorizations, by probing the third-party APIs. If the probe fails, the function should throw an exception to initiate the authorization flow. This function is called before each invocation of the add-on, in order to ensure a smooth user experience.

string authorization_check_function = 7;

Returns
Type Description
String

The authorizationCheckFunction.

getAuthorizationCheckFunctionBytes()

public ByteString getAuthorizationCheckFunctionBytes()

The name of an endpoint that verifies that the add-on has all the required third-party authorizations, by probing the third-party APIs. If the probe fails, the function should throw an exception to initiate the authorization flow. This function is called before each invocation of the add-on, in order to ensure a smooth user experience.

string authorization_check_function = 7;

Returns
Type Description
ByteString

The bytes for authorizationCheckFunction.

getComposeTrigger()

public ComposeTrigger getComposeTrigger()

Defines the compose time trigger for a compose time add-on. This is the trigger that causes an add-on to take action when the user is composing an email. All compose time addons are required to have the gmail.addons.current.action.compose scope even though it might not edit the draft.

.google.apps.script.type.gmail.ComposeTrigger compose_trigger = 12;

Returns
Type Description
ComposeTrigger

The composeTrigger.

getComposeTriggerOrBuilder()

public ComposeTriggerOrBuilder getComposeTriggerOrBuilder()

Defines the compose time trigger for a compose time add-on. This is the trigger that causes an add-on to take action when the user is composing an email. All compose time addons are required to have the gmail.addons.current.action.compose scope even though it might not edit the draft.

.google.apps.script.type.gmail.ComposeTrigger compose_trigger = 12;

Returns
Type Description
ComposeTriggerOrBuilder

getContextualTriggers(int index)

public ContextualTrigger getContextualTriggers(int index)

Defines the set of conditions that trigger the add-on.

repeated .google.apps.script.type.gmail.ContextualTrigger contextual_triggers = 3;

Parameter
Name Description
index int
Returns
Type Description
ContextualTrigger

getContextualTriggersCount()

public int getContextualTriggersCount()

Defines the set of conditions that trigger the add-on.

repeated .google.apps.script.type.gmail.ContextualTrigger contextual_triggers = 3;

Returns
Type Description
int

getContextualTriggersList()

public List<ContextualTrigger> getContextualTriggersList()

Defines the set of conditions that trigger the add-on.

repeated .google.apps.script.type.gmail.ContextualTrigger contextual_triggers = 3;

Returns
Type Description
List<ContextualTrigger>

getContextualTriggersOrBuilder(int index)

public ContextualTriggerOrBuilder getContextualTriggersOrBuilder(int index)

Defines the set of conditions that trigger the add-on.

repeated .google.apps.script.type.gmail.ContextualTrigger contextual_triggers = 3;

Parameter
Name Description
index int
Returns
Type Description
ContextualTriggerOrBuilder

getContextualTriggersOrBuilderList()

public List<? extends ContextualTriggerOrBuilder> getContextualTriggersOrBuilderList()

Defines the set of conditions that trigger the add-on.

repeated .google.apps.script.type.gmail.ContextualTrigger contextual_triggers = 3;

Returns
Type Description
List<? extends com.google.apps.script.type.gmail.ContextualTriggerOrBuilder>

getDefaultInstanceForType()

public GmailAddOnManifest getDefaultInstanceForType()
Returns
Type Description
GmailAddOnManifest

getHomepageTrigger()

public HomepageExtensionPoint getHomepageTrigger()

Defines an endpoint that will be executed in contexts that don't match a declared contextual trigger. Any cards generated by this function will always be available to the user, but may be eclipsed by contextual content when this add-on declares more targeted triggers.

If present, this overrides the configuration from addOns.common.homepageTrigger.

.google.apps.script.type.HomepageExtensionPoint homepage_trigger = 14;

Returns
Type Description
HomepageExtensionPoint

The homepageTrigger.

getHomepageTriggerOrBuilder()

public HomepageExtensionPointOrBuilder getHomepageTriggerOrBuilder()

Defines an endpoint that will be executed in contexts that don't match a declared contextual trigger. Any cards generated by this function will always be available to the user, but may be eclipsed by contextual content when this add-on declares more targeted triggers.

If present, this overrides the configuration from addOns.common.homepageTrigger.

.google.apps.script.type.HomepageExtensionPoint homepage_trigger = 14;

Returns
Type Description
HomepageExtensionPointOrBuilder

getParserForType()

public Parser<GmailAddOnManifest> getParserForType()
Returns
Type Description
Parser<GmailAddOnManifest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUniversalActions(int index)

public UniversalAction getUniversalActions(int index)

Defines set of universal actions for the add-on. The user triggers universal actions from the add-on toolbar menu.

repeated .google.apps.script.type.gmail.UniversalAction universal_actions = 4;

Parameter
Name Description
index int
Returns
Type Description
UniversalAction

getUniversalActionsCount()

public int getUniversalActionsCount()

Defines set of universal actions for the add-on. The user triggers universal actions from the add-on toolbar menu.

repeated .google.apps.script.type.gmail.UniversalAction universal_actions = 4;

Returns
Type Description
int

getUniversalActionsList()

public List<UniversalAction> getUniversalActionsList()

Defines set of universal actions for the add-on. The user triggers universal actions from the add-on toolbar menu.

repeated .google.apps.script.type.gmail.UniversalAction universal_actions = 4;

Returns
Type Description
List<UniversalAction>

getUniversalActionsOrBuilder(int index)

public UniversalActionOrBuilder getUniversalActionsOrBuilder(int index)

Defines set of universal actions for the add-on. The user triggers universal actions from the add-on toolbar menu.

repeated .google.apps.script.type.gmail.UniversalAction universal_actions = 4;

Parameter
Name Description
index int
Returns
Type Description
UniversalActionOrBuilder

getUniversalActionsOrBuilderList()

public List<? extends UniversalActionOrBuilder> getUniversalActionsOrBuilderList()

Defines set of universal actions for the add-on. The user triggers universal actions from the add-on toolbar menu.

repeated .google.apps.script.type.gmail.UniversalAction universal_actions = 4;

Returns
Type Description
List<? extends com.google.apps.script.type.gmail.UniversalActionOrBuilder>

hasComposeTrigger()

public boolean hasComposeTrigger()

Defines the compose time trigger for a compose time add-on. This is the trigger that causes an add-on to take action when the user is composing an email. All compose time addons are required to have the gmail.addons.current.action.compose scope even though it might not edit the draft.

.google.apps.script.type.gmail.ComposeTrigger compose_trigger = 12;

Returns
Type Description
boolean

Whether the composeTrigger field is set.

hasHomepageTrigger()

public boolean hasHomepageTrigger()

Defines an endpoint that will be executed in contexts that don't match a declared contextual trigger. Any cards generated by this function will always be available to the user, but may be eclipsed by contextual content when this add-on declares more targeted triggers.

If present, this overrides the configuration from addOns.common.homepageTrigger.

.google.apps.script.type.HomepageExtensionPoint homepage_trigger = 14;

Returns
Type Description
boolean

Whether the homepageTrigger 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 GmailAddOnManifest.Builder newBuilderForType()
Returns
Type Description
GmailAddOnManifest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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