- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.6
- 2.2.1
- 2.1.12
public interface GmailAddOnManifestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
boolean |
Whether the homepageTrigger field is set. |