Class CommonAddOnManifest (2.44.0)

public final class CommonAddOnManifest extends GeneratedMessageV3 implements CommonAddOnManifestOrBuilder

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

Protobuf type google.apps.script.type.CommonAddOnManifest

Static Fields

ADD_ON_WIDGET_SET_FIELD_NUMBER

public static final int ADD_ON_WIDGET_SET_FIELD_NUMBER
Field Value
Type Description
int

HOMEPAGE_TRIGGER_FIELD_NUMBER

public static final int HOMEPAGE_TRIGGER_FIELD_NUMBER
Field Value
Type Description
int

LAYOUT_PROPERTIES_FIELD_NUMBER

public static final int LAYOUT_PROPERTIES_FIELD_NUMBER
Field Value
Type Description
int

LOGO_URL_FIELD_NUMBER

public static final int LOGO_URL_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
public static final int OPEN_LINK_URL_PREFIXES_FIELD_NUMBER
Field Value
Type Description
int

UNIVERSAL_ACTIONS_FIELD_NUMBER

public static final int UNIVERSAL_ACTIONS_FIELD_NUMBER
Field Value
Type Description
int

USE_LOCALE_FROM_APP_FIELD_NUMBER

public static final int USE_LOCALE_FROM_APP_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CommonAddOnManifest getDefaultInstance()
Returns
Type Description
CommonAddOnManifest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CommonAddOnManifest.Builder newBuilder()
Returns
Type Description
CommonAddOnManifest.Builder

newBuilder(CommonAddOnManifest prototype)

public static CommonAddOnManifest.Builder newBuilder(CommonAddOnManifest prototype)
Parameter
Name Description
prototype CommonAddOnManifest
Returns
Type Description
CommonAddOnManifest.Builder

parseDelimitedFrom(InputStream input)

public static CommonAddOnManifest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CommonAddOnManifest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CommonAddOnManifest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CommonAddOnManifest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CommonAddOnManifest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CommonAddOnManifest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CommonAddOnManifest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CommonAddOnManifest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CommonAddOnManifest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CommonAddOnManifest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CommonAddOnManifest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CommonAddOnManifest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CommonAddOnManifest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CommonAddOnManifest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CommonAddOnManifest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CommonAddOnManifest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CommonAddOnManifest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CommonAddOnManifest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CommonAddOnManifest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CommonAddOnManifest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CommonAddOnManifest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CommonAddOnManifest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CommonAddOnManifest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CommonAddOnManifest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CommonAddOnManifest> parser()
Returns
Type Description
Parser<CommonAddOnManifest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAddOnWidgetSet()

public 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
Type Description
AddOnWidgetSet

The addOnWidgetSet.

getAddOnWidgetSetOrBuilder()

public 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
Type Description
AddOnWidgetSetOrBuilder

getDefaultInstanceForType()

public CommonAddOnManifest getDefaultInstanceForType()
Returns
Type Description
CommonAddOnManifest

getHomepageTrigger()

public 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
Type Description
HomepageExtensionPoint

The homepageTrigger.

getHomepageTriggerOrBuilder()

public 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
Type Description
HomepageExtensionPointOrBuilder

getLayoutProperties()

public LayoutProperties getLayoutProperties()

Common layout properties for the add-on cards.

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

Returns
Type Description
LayoutProperties

The layoutProperties.

getLayoutPropertiesOrBuilder()

public LayoutPropertiesOrBuilder getLayoutPropertiesOrBuilder()

Common layout properties for the add-on cards.

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

Returns
Type Description
LayoutPropertiesOrBuilder

getLogoUrl()

public String getLogoUrl()

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

string logo_url = 2;

Returns
Type Description
String

The logoUrl.

getLogoUrlBytes()

public ByteString getLogoUrlBytes()

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

string logo_url = 2;

Returns
Type Description
ByteString

The bytes for logoUrl.

getName()

public String getName()

Required. The display name of the add-on.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The display name of the add-on.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getOpenLinkUrlPrefixes()

public 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
Type Description
ListValue

The openLinkUrlPrefixes.

getOpenLinkUrlPrefixesOrBuilder()

public 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
Type Description
ListValueOrBuilder

getParserForType()

public Parser<CommonAddOnManifest> getParserForType()
Returns
Type Description
Parser<CommonAddOnManifest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUniversalActions(int index)

public 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
Name Description
index int
Returns
Type Description
UniversalActionExtensionPoint

getUniversalActionsCount()

public 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
Type Description
int

getUniversalActionsList()

public 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
Type Description
List<UniversalActionExtensionPoint>

getUniversalActionsOrBuilder(int index)

public 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
Name Description
index int
Returns
Type Description
UniversalActionExtensionPointOrBuilder

getUniversalActionsOrBuilderList()

public 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
Type Description
List<? extends com.google.apps.script.type.UniversalActionExtensionPointOrBuilder>

getUseLocaleFromApp()

public boolean getUseLocaleFromApp()

Whether to pass locale information from host app.

bool use_locale_from_app = 5;

Returns
Type Description
boolean

The useLocaleFromApp.

hasAddOnWidgetSet()

public 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
Type Description
boolean

Whether the addOnWidgetSet field is set.

hasHomepageTrigger()

public 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
Type Description
boolean

Whether the homepageTrigger field is set.

hasLayoutProperties()

public boolean hasLayoutProperties()

Common layout properties for the add-on cards.

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

Returns
Type Description
boolean

Whether the layoutProperties field is set.

hasOpenLinkUrlPrefixes()

public 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
Type Description
boolean

Whether the openLinkUrlPrefixes field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CommonAddOnManifest.Builder newBuilderForType()
Returns
Type Description
CommonAddOnManifest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CommonAddOnManifest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CommonAddOnManifest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CommonAddOnManifest.Builder toBuilder()
Returns
Type Description
CommonAddOnManifest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException