Package com.google.apps.script.type

Class CommonAddOnManifest

  • All Implemented Interfaces:
    CommonAddOnManifestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class CommonAddOnManifest
extends com.google.protobuf.GeneratedMessageV3
implements CommonAddOnManifestOrBuilder
     Add-on configuration that is shared across all add-on host applications.
    Protobuf type google.apps.script.type.CommonAddOnManifest
    See Also:
    Serialized Form

    • Field Detail

      • LAYOUT_PROPERTIES_FIELD_NUMBER

        public static final int LAYOUT_PROPERTIES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ADD_ON_WIDGET_SET_FIELD_NUMBER

        public static final int ADD_ON_WIDGET_SET_FIELD_NUMBER
        See Also:
        Constant Field Values

      • USE_LOCALE_FROM_APP_FIELD_NUMBER

        public static final int USE_LOCALE_FROM_APP_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HOMEPAGE_TRIGGER_FIELD_NUMBER

        public static final int HOMEPAGE_TRIGGER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UNIVERSAL_ACTIONS_FIELD_NUMBER

        public static final int UNIVERSAL_ACTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OPEN_LINK_URL_PREFIXES_FIELD_NUMBER

        public static final int OPEN_LINK_URL_PREFIXES_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Required. The display name of the add-on.
        string name = 1;
        Specified by:
        getNameBytes in interface CommonAddOnManifestOrBuilder
        Returns:
        The bytes for name.

      • getLogoUrlBytes

        public com.google.protobuf.ByteString getLogoUrlBytes()
         Required. The URL for the logo image shown in the add-on toolbar.
        string logo_url = 2;
        Specified by:
        getLogoUrlBytes in interface CommonAddOnManifestOrBuilder
        Returns:
        The bytes for logoUrl.

      • hasLayoutProperties

        public boolean hasLayoutProperties()
         Common layout properties for the add-on cards.
        .google.apps.script.type.LayoutProperties layout_properties = 3;
        Specified by:
        hasLayoutProperties in interface CommonAddOnManifestOrBuilder
        Returns:
        Whether the layoutProperties field is set.

      • 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;
        Specified by:
        hasAddOnWidgetSet in interface CommonAddOnManifestOrBuilder
        Returns:
        Whether the addOnWidgetSet field is set.

      • 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;
        Specified by:
        getAddOnWidgetSet in interface CommonAddOnManifestOrBuilder
        Returns:
        The addOnWidgetSet.

      • getUseLocaleFromApp

        public boolean getUseLocaleFromApp()
         Whether to pass locale information from host app.
        bool use_locale_from_app = 5;
        Specified by:
        getUseLocaleFromApp in interface CommonAddOnManifestOrBuilder
        Returns:
        The useLocaleFromApp.

      • 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;
        Specified by:
        hasHomepageTrigger in interface CommonAddOnManifestOrBuilder
        Returns:
        Whether the homepageTrigger field is set.

      • 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;
        Specified by:
        getHomepageTrigger in interface CommonAddOnManifestOrBuilder
        Returns:
        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;
        Specified by:
        getHomepageTriggerOrBuilder in interface CommonAddOnManifestOrBuilder

      • 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;
        Specified by:
        getUniversalActionsList in interface CommonAddOnManifestOrBuilder

      • 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;
        Specified by:
        getUniversalActionsOrBuilderList in interface CommonAddOnManifestOrBuilder

      • 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;
        Specified by:
        getUniversalActionsCount in interface CommonAddOnManifestOrBuilder

      • getUniversalActions

        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;
        Specified by:
        getUniversalActions in interface CommonAddOnManifestOrBuilder

      • getUniversalActionsOrBuilder

        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;
        Specified by:
        getUniversalActionsOrBuilder in interface CommonAddOnManifestOrBuilder

      • 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](/gmail/add-ons/concepts/manifests#whitelisting_urls) 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;
        Specified by:
        hasOpenLinkUrlPrefixes in interface CommonAddOnManifestOrBuilder
        Returns:
        Whether the openLinkUrlPrefixes field is set.

      • getOpenLinkUrlPrefixes

        public com.google.protobuf.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](/gmail/add-ons/concepts/manifests#whitelisting_urls) 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;
        Specified by:
        getOpenLinkUrlPrefixes in interface CommonAddOnManifestOrBuilder
        Returns:
        The openLinkUrlPrefixes.

      • getOpenLinkUrlPrefixesOrBuilder

        public com.google.protobuf.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](/gmail/add-ons/concepts/manifests#whitelisting_urls) 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;
        Specified by:
        getOpenLinkUrlPrefixesOrBuilder in interface CommonAddOnManifestOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static CommonAddOnManifest parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CommonAddOnManifest parseFrom​(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CommonAddOnManifest parseFrom​(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CommonAddOnManifest parseFrom​(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CommonAddOnManifest parseFrom​(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CommonAddOnManifest parseFrom​(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CommonAddOnManifest parseFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException
        Throws:
        IOException

      • newBuilderForType

        public CommonAddOnManifest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public CommonAddOnManifest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected CommonAddOnManifest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<CommonAddOnManifest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public CommonAddOnManifest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder