Class GmailAddOnManifest (2.0.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class GmailAddOnManifest : IMessage<GmailAddOnManifest>, IEquatable<GmailAddOnManifest>, IDeepCloneable<GmailAddOnManifest>, IBufferMessage, IMessage

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

Inheritance

Object > GmailAddOnManifest

Namespace

Google.Apps.Script.Type.Gmail

Assembly

Google.Apps.Script.Type.dll

Constructors

GmailAddOnManifest()

public GmailAddOnManifest()

GmailAddOnManifest(GmailAddOnManifest)

public GmailAddOnManifest(GmailAddOnManifest other)
Parameter
NameDescription
otherGmailAddOnManifest

Properties

AuthorizationCheckFunction

public string AuthorizationCheckFunction { get; set; }

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.

Property Value
TypeDescription
String

ComposeTrigger

public ComposeTrigger ComposeTrigger { get; set; }

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.

Property Value
TypeDescription
ComposeTrigger

ContextualTriggers

public RepeatedField<ContextualTrigger> ContextualTriggers { get; }

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

Property Value
TypeDescription
RepeatedField<ContextualTrigger>

HomepageTrigger

public HomepageExtensionPoint HomepageTrigger { get; set; }

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.

Property Value
TypeDescription
HomepageExtensionPoint

UniversalActions

public RepeatedField<UniversalAction> UniversalActions { get; }

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

Property Value
TypeDescription
RepeatedField<UniversalAction>