Class CommonAddOnManifest (2.0.0)

public sealed class CommonAddOnManifest : IMessage<CommonAddOnManifest>, IEquatable<CommonAddOnManifest>, IDeepCloneable<CommonAddOnManifest>, IBufferMessage, IMessage

Add-on configuration that is shared across all add-on host applications.

Inheritance

Object > CommonAddOnManifest

Namespace

Google.Apps.Script.Type

Assembly

Google.Apps.Script.Type.dll

Constructors

CommonAddOnManifest()

public CommonAddOnManifest()

CommonAddOnManifest(CommonAddOnManifest)

public CommonAddOnManifest(CommonAddOnManifest other)
Parameter
NameDescription
otherCommonAddOnManifest

Properties

AddOnWidgetSet

public AddOnWidgetSet AddOnWidgetSet { get; set; }

The widgets used in the add-on. If this field is not specified, it indicates that default set is used.

Property Value
TypeDescription
AddOnWidgetSet

HomepageTrigger

public HomepageExtensionPoint HomepageTrigger { get; set; }

Defines an endpoint that will be executed in any context, in any host. 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.

Property Value
TypeDescription
HomepageExtensionPoint

LayoutProperties

public LayoutProperties LayoutProperties { get; set; }

Common layout properties for the add-on cards.

Property Value
TypeDescription
LayoutProperties

LogoUrl

public string LogoUrl { get; set; }

Required. The URL for the logo image shown in the add-on toolbar.

Property Value
TypeDescription
String

Name

public string Name { get; set; }

Required. The display name of the add-on.

Property Value
TypeDescription
String

OpenLinkUrlPrefixes

public ListValue OpenLinkUrlPrefixes { get; set; }

An OpenLink action can only use a URL with an HTTPS, MAILTO or TEL scheme. For HTTPS links, the URL must also match one of the prefixes specified in this whitelist. If the prefix omits the scheme, HTTPS is assumed. Notice that HTTP links are automatically rewritten to HTTPS links.

Property Value
TypeDescription
ListValue

UniversalActions

public RepeatedField<UniversalActionExtensionPoint> UniversalActions { get; }

Defines a list of extension points in the universal action menu which serves as a setting menu for the add-on. The extension point can be link URL to open or an endpoint to execute as a form submission.

Property Value
TypeDescription
RepeatedField<UniversalActionExtensionPoint>

UseLocaleFromApp

public bool UseLocaleFromApp { get; set; }

Whether to pass locale information from host app.

Property Value
TypeDescription
Boolean