Class CommonAddOnManifest (2.29.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
TypeDescription
int

HOMEPAGE_TRIGGER_FIELD_NUMBER

public static final int HOMEPAGE_TRIGGER_FIELD_NUMBER
Field Value
TypeDescription
int

LAYOUT_PROPERTIES_FIELD_NUMBER

public static final int LAYOUT_PROPERTIES_FIELD_NUMBER
Field Value
TypeDescription
int

LOGO_URL_FIELD_NUMBER

public static final int LOGO_URL_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int
public static final int OPEN_LINK_URL_PREFIXES_FIELD_NUMBER
Field Value
TypeDescription
int

UNIVERSAL_ACTIONS_FIELD_NUMBER

public static final int UNIVERSAL_ACTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

USE_LOCALE_FROM_APP_FIELD_NUMBER

public static final int USE_LOCALE_FROM_APP_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CommonAddOnManifest getDefaultInstance()
Returns
TypeDescription
CommonAddOnManifest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static CommonAddOnManifest.Builder newBuilder()
Returns
TypeDescription
CommonAddOnManifest.Builder

newBuilder(CommonAddOnManifest prototype)

public static CommonAddOnManifest.Builder newBuilder(CommonAddOnManifest prototype)
Parameter
NameDescription
prototypeCommonAddOnManifest
Returns
TypeDescription
CommonAddOnManifest.Builder

parseDelimitedFrom(InputStream input)

public static CommonAddOnManifest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CommonAddOnManifest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CommonAddOnManifest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CommonAddOnManifest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CommonAddOnManifest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CommonAddOnManifest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CommonAddOnManifest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CommonAddOnManifest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CommonAddOnManifest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CommonAddOnManifest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CommonAddOnManifest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CommonAddOnManifest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CommonAddOnManifest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CommonAddOnManifest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CommonAddOnManifest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CommonAddOnManifest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CommonAddOnManifest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CommonAddOnManifest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CommonAddOnManifest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CommonAddOnManifest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CommonAddOnManifest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CommonAddOnManifest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CommonAddOnManifest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CommonAddOnManifest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CommonAddOnManifest> parser()
Returns
TypeDescription
Parser<CommonAddOnManifest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
AddOnWidgetSetOrBuilder

getDefaultInstanceForType()

public CommonAddOnManifest getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
HomepageExtensionPointOrBuilder

getLayoutProperties()

public 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 LayoutPropertiesOrBuilder getLayoutPropertiesOrBuilder()

Common layout properties for the add-on cards.

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

Returns
TypeDescription
LayoutPropertiesOrBuilder

getLogoUrl()

public 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 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 String getName()

Required. The display name of the add-on.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The display name of the add-on.

string name = 1;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ListValueOrBuilder

getParserForType()

public Parser<CommonAddOnManifest> getParserForType()
Returns
TypeDescription
Parser<CommonAddOnManifest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the openLinkUrlPrefixes field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CommonAddOnManifest.Builder newBuilderForType()
Returns
TypeDescription
CommonAddOnManifest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CommonAddOnManifest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CommonAddOnManifest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CommonAddOnManifest.Builder toBuilder()
Returns
TypeDescription
CommonAddOnManifest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException