Interface CommonAddOnManifestOrBuilder (2.28.0)

public interface CommonAddOnManifestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAddOnWidgetSet()

public abstract AddOnWidgetSet getAddOnWidgetSet()

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

.google.apps.script.type.AddOnWidgetSet add_on_widget_set = 4;

Returns
TypeDescription
AddOnWidgetSet

The addOnWidgetSet.

getAddOnWidgetSetOrBuilder()

public abstract AddOnWidgetSetOrBuilder getAddOnWidgetSetOrBuilder()

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

.google.apps.script.type.AddOnWidgetSet add_on_widget_set = 4;

Returns
TypeDescription
AddOnWidgetSetOrBuilder

getHomepageTrigger()

public abstract HomepageExtensionPoint getHomepageTrigger()

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.

.google.apps.script.type.HomepageExtensionPoint homepage_trigger = 6;

Returns
TypeDescription
HomepageExtensionPoint

The homepageTrigger.

getHomepageTriggerOrBuilder()

public abstract HomepageExtensionPointOrBuilder getHomepageTriggerOrBuilder()

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.

.google.apps.script.type.HomepageExtensionPoint homepage_trigger = 6;

Returns
TypeDescription
HomepageExtensionPointOrBuilder

getLayoutProperties()

public abstract LayoutProperties getLayoutProperties()

Common layout properties for the add-on cards.

.google.apps.script.type.LayoutProperties layout_properties = 3;

Returns
TypeDescription
LayoutProperties

The layoutProperties.

getLayoutPropertiesOrBuilder()

public abstract LayoutPropertiesOrBuilder getLayoutPropertiesOrBuilder()

Common layout properties for the add-on cards.

.google.apps.script.type.LayoutProperties layout_properties = 3;

Returns
TypeDescription
LayoutPropertiesOrBuilder

getLogoUrl()

public abstract String getLogoUrl()

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

string logo_url = 2;

Returns
TypeDescription
String

The logoUrl.

getLogoUrlBytes()

public abstract ByteString getLogoUrlBytes()

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

string logo_url = 2;

Returns
TypeDescription
ByteString

The bytes for logoUrl.

getName()

public abstract String getName()

Required. The display name of the add-on.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Required. The display name of the add-on.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getOpenLinkUrlPrefixes()

public abstract ListValue getOpenLinkUrlPrefixes()

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.

.google.protobuf.ListValue open_link_url_prefixes = 8;

Returns
TypeDescription
ListValue

The openLinkUrlPrefixes.

getOpenLinkUrlPrefixesOrBuilder()

public abstract ListValueOrBuilder getOpenLinkUrlPrefixesOrBuilder()

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.

.google.protobuf.ListValue open_link_url_prefixes = 8;

Returns
TypeDescription
ListValueOrBuilder

getUniversalActions(int index)

public abstract UniversalActionExtensionPoint getUniversalActions(int index)

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.

repeated .google.apps.script.type.UniversalActionExtensionPoint universal_actions = 7;

Parameter
NameDescription
indexint
Returns
TypeDescription
UniversalActionExtensionPoint

getUniversalActionsCount()

public abstract int getUniversalActionsCount()

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.

repeated .google.apps.script.type.UniversalActionExtensionPoint universal_actions = 7;

Returns
TypeDescription
int

getUniversalActionsList()

public abstract List<UniversalActionExtensionPoint> getUniversalActionsList()

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.

repeated .google.apps.script.type.UniversalActionExtensionPoint universal_actions = 7;

Returns
TypeDescription
List<UniversalActionExtensionPoint>

getUniversalActionsOrBuilder(int index)

public abstract UniversalActionExtensionPointOrBuilder getUniversalActionsOrBuilder(int index)

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.

repeated .google.apps.script.type.UniversalActionExtensionPoint universal_actions = 7;

Parameter
NameDescription
indexint
Returns
TypeDescription
UniversalActionExtensionPointOrBuilder

getUniversalActionsOrBuilderList()

public abstract List<? extends UniversalActionExtensionPointOrBuilder> getUniversalActionsOrBuilderList()

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.

repeated .google.apps.script.type.UniversalActionExtensionPoint universal_actions = 7;

Returns
TypeDescription
List<? extends com.google.apps.script.type.UniversalActionExtensionPointOrBuilder>

getUseLocaleFromApp()

public abstract boolean getUseLocaleFromApp()

Whether to pass locale information from host app.

bool use_locale_from_app = 5;

Returns
TypeDescription
boolean

The useLocaleFromApp.

hasAddOnWidgetSet()

public abstract boolean hasAddOnWidgetSet()

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

.google.apps.script.type.AddOnWidgetSet add_on_widget_set = 4;

Returns
TypeDescription
boolean

Whether the addOnWidgetSet field is set.

hasHomepageTrigger()

public abstract boolean hasHomepageTrigger()

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.

.google.apps.script.type.HomepageExtensionPoint homepage_trigger = 6;

Returns
TypeDescription
boolean

Whether the homepageTrigger field is set.

hasLayoutProperties()

public abstract boolean hasLayoutProperties()

Common layout properties for the add-on cards.

.google.apps.script.type.LayoutProperties layout_properties = 3;

Returns
TypeDescription
boolean

Whether the layoutProperties field is set.

hasOpenLinkUrlPrefixes()

public abstract boolean hasOpenLinkUrlPrefixes()

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.

.google.protobuf.ListValue open_link_url_prefixes = 8;

Returns
TypeDescription
boolean

Whether the openLinkUrlPrefixes field is set.