Interface GmailAddOnManifestOrBuilder (2.33.0)

public interface GmailAddOnManifestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAuthorizationCheckFunction()

public abstract 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
TypeDescription
String

The authorizationCheckFunction.

getAuthorizationCheckFunctionBytes()

public abstract 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
TypeDescription
ByteString

The bytes for authorizationCheckFunction.

getComposeTrigger()

public abstract 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
TypeDescription
ComposeTrigger

The composeTrigger.

getComposeTriggerOrBuilder()

public abstract 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
TypeDescription
ComposeTriggerOrBuilder

getContextualTriggers(int index)

public abstract 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
NameDescription
indexint
Returns
TypeDescription
ContextualTrigger

getContextualTriggersCount()

public abstract int getContextualTriggersCount()

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

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

Returns
TypeDescription
int

getContextualTriggersList()

public abstract List<ContextualTrigger> getContextualTriggersList()

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

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

Returns
TypeDescription
List<ContextualTrigger>

getContextualTriggersOrBuilder(int index)

public abstract 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
NameDescription
indexint
Returns
TypeDescription
ContextualTriggerOrBuilder

getContextualTriggersOrBuilderList()

public abstract 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
TypeDescription
List<? extends com.google.apps.script.type.gmail.ContextualTriggerOrBuilder>

getHomepageTrigger()

public abstract 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
TypeDescription
HomepageExtensionPoint

The homepageTrigger.

getHomepageTriggerOrBuilder()

public abstract 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
TypeDescription
HomepageExtensionPointOrBuilder

getUniversalActions(int index)

public abstract 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
NameDescription
indexint
Returns
TypeDescription
UniversalAction

getUniversalActionsCount()

public abstract 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
TypeDescription
int

getUniversalActionsList()

public abstract 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
TypeDescription
List<UniversalAction>

getUniversalActionsOrBuilder(int index)

public abstract 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
NameDescription
indexint
Returns
TypeDescription
UniversalActionOrBuilder

getUniversalActionsOrBuilderList()

public abstract 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
TypeDescription
List<? extends com.google.apps.script.type.gmail.UniversalActionOrBuilder>

hasComposeTrigger()

public abstract 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
TypeDescription
boolean

Whether the composeTrigger field is set.

hasHomepageTrigger()

public abstract 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
TypeDescription
boolean

Whether the homepageTrigger field is set.