Package com.google.apps.script.type

Interface CommonAddOnManifestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    CommonAddOnManifest, CommonAddOnManifest.Builder
    public interface CommonAddOnManifestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         Required. The display name of the add-on.
        string name = 1;
        Returns:
        The name.

      • getNameBytes

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

      • getLogoUrl

        String getLogoUrl()
         Required. The URL for the logo image shown in the add-on toolbar.
        string logo_url = 2;
        Returns:
        The logoUrl.

      • getLogoUrlBytes

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

      • hasLayoutProperties

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

      • getLayoutProperties

        LayoutProperties getLayoutProperties()
         Common layout properties for the add-on cards.
        .google.apps.script.type.LayoutProperties layout_properties = 3;
        Returns:
        The layoutProperties.

      • getLayoutPropertiesOrBuilder

        LayoutPropertiesOrBuilder getLayoutPropertiesOrBuilder()
         Common layout properties for the add-on cards.
        .google.apps.script.type.LayoutProperties layout_properties = 3;

      • hasAddOnWidgetSet

        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:
        Whether the addOnWidgetSet field is set.

      • getAddOnWidgetSet

        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:
        The addOnWidgetSet.

      • getAddOnWidgetSetOrBuilder

        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;

      • getUseLocaleFromApp

        boolean getUseLocaleFromApp()
         Whether to pass locale information from host app.
        bool use_locale_from_app = 5;
        Returns:
        The useLocaleFromApp.

      • hasHomepageTrigger

        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:
        Whether the homepageTrigger field is set.

      • getHomepageTrigger

        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:
        The homepageTrigger.

      • getHomepageTriggerOrBuilder

        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;

      • getUniversalActionsList

        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;

      • getUniversalActions

        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;

      • getUniversalActionsCount

        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;

      • getUniversalActionsOrBuilderList

        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;

      • getUniversalActionsOrBuilder

        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;

      • hasOpenLinkUrlPrefixes

        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;
        Returns:
        Whether the openLinkUrlPrefixes field is set.

      • getOpenLinkUrlPrefixes

        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;
        Returns:
        The openLinkUrlPrefixes.

      • getOpenLinkUrlPrefixesOrBuilder

        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;