- 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 static final class GmailAddOnManifest.Builder extends GeneratedMessageV3.Builder<GmailAddOnManifest.Builder> implements GmailAddOnManifestOrBuilderProperties customizing the appearance and execution of a Gmail add-on.
Protobuf type google.apps.script.type.gmail.GmailAddOnManifest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GmailAddOnManifest.BuilderImplements
GmailAddOnManifestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAllContextualTriggers(Iterable<? extends ContextualTrigger> values)
public GmailAddOnManifest.Builder addAllContextualTriggers(Iterable<? extends ContextualTrigger> values)Defines the set of conditions that trigger the add-on.
repeated .google.apps.script.type.gmail.ContextualTrigger contextual_triggers = 3;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<? extends com.google.apps.script.type.gmail.ContextualTrigger> |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
addAllUniversalActions(Iterable<? extends UniversalAction> values)
public GmailAddOnManifest.Builder addAllUniversalActions(Iterable<? extends UniversalAction> values)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 |
values | Iterable<? extends com.google.apps.script.type.gmail.UniversalAction> |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
addContextualTriggers(ContextualTrigger value)
public GmailAddOnManifest.Builder addContextualTriggers(ContextualTrigger value)Defines the set of conditions that trigger the add-on.
repeated .google.apps.script.type.gmail.ContextualTrigger contextual_triggers = 3;
| Parameter | |
|---|---|
| Name | Description |
value | ContextualTrigger |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
addContextualTriggers(ContextualTrigger.Builder builderForValue)
public GmailAddOnManifest.Builder addContextualTriggers(ContextualTrigger.Builder builderForValue)Defines the set of conditions that trigger the add-on.
repeated .google.apps.script.type.gmail.ContextualTrigger contextual_triggers = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | ContextualTrigger.Builder |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
addContextualTriggers(int index, ContextualTrigger value)
public GmailAddOnManifest.Builder addContextualTriggers(int index, ContextualTrigger value)Defines the set of conditions that trigger the add-on.
repeated .google.apps.script.type.gmail.ContextualTrigger contextual_triggers = 3;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | ContextualTrigger |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
addContextualTriggers(int index, ContextualTrigger.Builder builderForValue)
public GmailAddOnManifest.Builder addContextualTriggers(int index, ContextualTrigger.Builder builderForValue)Defines the set of conditions that trigger the add-on.
repeated .google.apps.script.type.gmail.ContextualTrigger contextual_triggers = 3;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | ContextualTrigger.Builder |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
addContextualTriggersBuilder()
public ContextualTrigger.Builder addContextualTriggersBuilder()Defines the set of conditions that trigger the add-on.
repeated .google.apps.script.type.gmail.ContextualTrigger contextual_triggers = 3;
| Returns | |
|---|---|
| Type | Description |
ContextualTrigger.Builder | |
addContextualTriggersBuilder(int index)
public ContextualTrigger.Builder addContextualTriggersBuilder(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.Builder | |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public GmailAddOnManifest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
addUniversalActions(UniversalAction value)
public GmailAddOnManifest.Builder addUniversalActions(UniversalAction value)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 |
value | UniversalAction |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
addUniversalActions(UniversalAction.Builder builderForValue)
public GmailAddOnManifest.Builder addUniversalActions(UniversalAction.Builder builderForValue)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 |
builderForValue | UniversalAction.Builder |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
addUniversalActions(int index, UniversalAction value)
public GmailAddOnManifest.Builder addUniversalActions(int index, UniversalAction value)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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | UniversalAction |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
addUniversalActions(int index, UniversalAction.Builder builderForValue)
public GmailAddOnManifest.Builder addUniversalActions(int index, UniversalAction.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | UniversalAction.Builder |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
addUniversalActionsBuilder()
public UniversalAction.Builder addUniversalActionsBuilder()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 |
UniversalAction.Builder | |
addUniversalActionsBuilder(int index)
public UniversalAction.Builder addUniversalActionsBuilder(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.Builder | |
build()
public GmailAddOnManifest build()| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest | |
buildPartial()
public GmailAddOnManifest buildPartial()| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest | |
clear()
public GmailAddOnManifest.Builder clear()| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
clearAuthorizationCheckFunction()
public GmailAddOnManifest.Builder clearAuthorizationCheckFunction()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 |
GmailAddOnManifest.Builder | This builder for chaining. |
clearComposeTrigger()
public GmailAddOnManifest.Builder clearComposeTrigger()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 |
GmailAddOnManifest.Builder | |
clearContextualTriggers()
public GmailAddOnManifest.Builder clearContextualTriggers()Defines the set of conditions that trigger the add-on.
repeated .google.apps.script.type.gmail.ContextualTrigger contextual_triggers = 3;
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
clearField(Descriptors.FieldDescriptor field)
public GmailAddOnManifest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
clearHomepageTrigger()
public GmailAddOnManifest.Builder clearHomepageTrigger() 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 |
GmailAddOnManifest.Builder | |
clearOneof(Descriptors.OneofDescriptor oneof)
public GmailAddOnManifest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
clearUniversalActions()
public GmailAddOnManifest.Builder clearUniversalActions()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 |
GmailAddOnManifest.Builder | |
clone()
public GmailAddOnManifest.Builder clone()| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
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. |
getComposeTriggerBuilder()
public ComposeTrigger.Builder getComposeTriggerBuilder()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.Builder | |
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 | |
getContextualTriggersBuilder(int index)
public ContextualTrigger.Builder getContextualTriggersBuilder(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.Builder | |
getContextualTriggersBuilderList()
public List<ContextualTrigger.Builder> getContextualTriggersBuilderList()Defines the set of conditions that trigger the add-on.
repeated .google.apps.script.type.gmail.ContextualTrigger contextual_triggers = 3;
| Returns | |
|---|---|
| Type | Description |
List<Builder> | |
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 | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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. |
getHomepageTriggerBuilder()
public HomepageExtensionPoint.Builder getHomepageTriggerBuilder() 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.Builder | |
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 | |
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 | |
getUniversalActionsBuilder(int index)
public UniversalAction.Builder getUniversalActionsBuilder(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.Builder | |
getUniversalActionsBuilderList()
public List<UniversalAction.Builder> getUniversalActionsBuilderList()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<Builder> | |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeComposeTrigger(ComposeTrigger value)
public GmailAddOnManifest.Builder mergeComposeTrigger(ComposeTrigger value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ComposeTrigger |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
mergeFrom(GmailAddOnManifest other)
public GmailAddOnManifest.Builder mergeFrom(GmailAddOnManifest other)| Parameter | |
|---|---|
| Name | Description |
other | GmailAddOnManifest |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public GmailAddOnManifest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public GmailAddOnManifest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
mergeHomepageTrigger(HomepageExtensionPoint value)
public GmailAddOnManifest.Builder mergeHomepageTrigger(HomepageExtensionPoint value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | HomepageExtensionPoint |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final GmailAddOnManifest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
removeContextualTriggers(int index)
public GmailAddOnManifest.Builder removeContextualTriggers(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 |
GmailAddOnManifest.Builder | |
removeUniversalActions(int index)
public GmailAddOnManifest.Builder removeUniversalActions(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 |
GmailAddOnManifest.Builder | |
setAuthorizationCheckFunction(String value)
public GmailAddOnManifest.Builder setAuthorizationCheckFunction(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe authorizationCheckFunction to set. |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | This builder for chaining. |
setAuthorizationCheckFunctionBytes(ByteString value)
public GmailAddOnManifest.Builder setAuthorizationCheckFunctionBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for authorizationCheckFunction to set. |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | This builder for chaining. |
setComposeTrigger(ComposeTrigger value)
public GmailAddOnManifest.Builder setComposeTrigger(ComposeTrigger value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ComposeTrigger |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
setComposeTrigger(ComposeTrigger.Builder builderForValue)
public GmailAddOnManifest.Builder setComposeTrigger(ComposeTrigger.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | ComposeTrigger.Builder |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
setContextualTriggers(int index, ContextualTrigger value)
public GmailAddOnManifest.Builder setContextualTriggers(int index, ContextualTrigger value)Defines the set of conditions that trigger the add-on.
repeated .google.apps.script.type.gmail.ContextualTrigger contextual_triggers = 3;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | ContextualTrigger |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
setContextualTriggers(int index, ContextualTrigger.Builder builderForValue)
public GmailAddOnManifest.Builder setContextualTriggers(int index, ContextualTrigger.Builder builderForValue)Defines the set of conditions that trigger the add-on.
repeated .google.apps.script.type.gmail.ContextualTrigger contextual_triggers = 3;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | ContextualTrigger.Builder |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public GmailAddOnManifest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
setHomepageTrigger(HomepageExtensionPoint value)
public GmailAddOnManifest.Builder setHomepageTrigger(HomepageExtensionPoint value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | HomepageExtensionPoint |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
setHomepageTrigger(HomepageExtensionPoint.Builder builderForValue)
public GmailAddOnManifest.Builder setHomepageTrigger(HomepageExtensionPoint.Builder builderForValue) 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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | HomepageExtensionPoint.Builder |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public GmailAddOnManifest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
setUniversalActions(int index, UniversalAction value)
public GmailAddOnManifest.Builder setUniversalActions(int index, UniversalAction value)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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | UniversalAction |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
setUniversalActions(int index, UniversalAction.Builder builderForValue)
public GmailAddOnManifest.Builder setUniversalActions(int index, UniversalAction.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | UniversalAction.Builder |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final GmailAddOnManifest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
GmailAddOnManifest.Builder | |