public static final class CommonAddOnManifest.Builder extends GeneratedMessageV3.Builder<CommonAddOnManifest.Builder> implements CommonAddOnManifestOrBuilderAdd-on configuration that is shared across all add-on host applications.
Protobuf type google.apps.script.type.CommonAddOnManifest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CommonAddOnManifest.BuilderImplements
CommonAddOnManifestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAllUniversalActions(Iterable<? extends UniversalActionExtensionPoint> values)
public CommonAddOnManifest.Builder addAllUniversalActions(Iterable<? extends UniversalActionExtensionPoint> values)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 |
values | Iterable<? extends com.google.apps.script.type.UniversalActionExtensionPoint> |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CommonAddOnManifest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
addUniversalActions(UniversalActionExtensionPoint value)
public CommonAddOnManifest.Builder addUniversalActions(UniversalActionExtensionPoint value)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 |
value | UniversalActionExtensionPoint |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
addUniversalActions(UniversalActionExtensionPoint.Builder builderForValue)
public CommonAddOnManifest.Builder addUniversalActions(UniversalActionExtensionPoint.Builder builderForValue)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 |
builderForValue | UniversalActionExtensionPoint.Builder |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
addUniversalActions(int index, UniversalActionExtensionPoint value)
public CommonAddOnManifest.Builder addUniversalActions(int index, UniversalActionExtensionPoint value)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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | UniversalActionExtensionPoint |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
addUniversalActions(int index, UniversalActionExtensionPoint.Builder builderForValue)
public CommonAddOnManifest.Builder addUniversalActions(int index, UniversalActionExtensionPoint.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | UniversalActionExtensionPoint.Builder |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
addUniversalActionsBuilder()
public UniversalActionExtensionPoint.Builder addUniversalActionsBuilder()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 |
UniversalActionExtensionPoint.Builder | |
addUniversalActionsBuilder(int index)
public UniversalActionExtensionPoint.Builder addUniversalActionsBuilder(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.Builder | |
build()
public CommonAddOnManifest build()| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest | |
buildPartial()
public CommonAddOnManifest buildPartial()| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest | |
clear()
public CommonAddOnManifest.Builder clear()| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
clearAddOnWidgetSet()
public CommonAddOnManifest.Builder clearAddOnWidgetSet()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 |
CommonAddOnManifest.Builder | |
clearField(Descriptors.FieldDescriptor field)
public CommonAddOnManifest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
clearHomepageTrigger()
public CommonAddOnManifest.Builder clearHomepageTrigger()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 |
CommonAddOnManifest.Builder | |
clearLayoutProperties()
public CommonAddOnManifest.Builder clearLayoutProperties()Common layout properties for the add-on cards.
.google.apps.script.type.LayoutProperties layout_properties = 3;
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
clearLogoUrl()
public CommonAddOnManifest.Builder clearLogoUrl()Required. The URL for the logo image shown in the add-on toolbar.
string logo_url = 2;
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | This builder for chaining. |
clearName()
public CommonAddOnManifest.Builder clearName()Required. The display name of the add-on.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public CommonAddOnManifest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
clearOpenLinkUrlPrefixes()
public CommonAddOnManifest.Builder clearOpenLinkUrlPrefixes()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 |
CommonAddOnManifest.Builder | |
clearUniversalActions()
public CommonAddOnManifest.Builder clearUniversalActions()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 |
CommonAddOnManifest.Builder | |
clearUseLocaleFromApp()
public CommonAddOnManifest.Builder clearUseLocaleFromApp()Whether to pass locale information from host app.
bool use_locale_from_app = 5;
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | This builder for chaining. |
clone()
public CommonAddOnManifest.Builder clone()| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
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. |
getAddOnWidgetSetBuilder()
public AddOnWidgetSet.Builder getAddOnWidgetSetBuilder()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.Builder | |
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 | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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. |
getHomepageTriggerBuilder()
public HomepageExtensionPoint.Builder getHomepageTriggerBuilder()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.Builder | |
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. |
getLayoutPropertiesBuilder()
public LayoutProperties.Builder getLayoutPropertiesBuilder()Common layout properties for the add-on cards.
.google.apps.script.type.LayoutProperties layout_properties = 3;
| Returns | |
|---|---|
| Type | Description |
LayoutProperties.Builder | |
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. |
getOpenLinkUrlPrefixesBuilder()
public ListValue.Builder getOpenLinkUrlPrefixesBuilder()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 |
Builder | |
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 | |
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 | |
getUniversalActionsBuilder(int index)
public UniversalActionExtensionPoint.Builder getUniversalActionsBuilder(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.Builder | |
getUniversalActionsBuilderList()
public List<UniversalActionExtensionPoint.Builder> getUniversalActionsBuilderList()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<Builder> | |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeAddOnWidgetSet(AddOnWidgetSet value)
public CommonAddOnManifest.Builder mergeAddOnWidgetSet(AddOnWidgetSet value)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;
| Parameter | |
|---|---|
| Name | Description |
value | AddOnWidgetSet |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
mergeFrom(CommonAddOnManifest other)
public CommonAddOnManifest.Builder mergeFrom(CommonAddOnManifest other)| Parameter | |
|---|---|
| Name | Description |
other | CommonAddOnManifest |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CommonAddOnManifest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public CommonAddOnManifest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
mergeHomepageTrigger(HomepageExtensionPoint value)
public CommonAddOnManifest.Builder mergeHomepageTrigger(HomepageExtensionPoint value)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;
| Parameter | |
|---|---|
| Name | Description |
value | HomepageExtensionPoint |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
mergeLayoutProperties(LayoutProperties value)
public CommonAddOnManifest.Builder mergeLayoutProperties(LayoutProperties value)Common layout properties for the add-on cards.
.google.apps.script.type.LayoutProperties layout_properties = 3;
| Parameter | |
|---|---|
| Name | Description |
value | LayoutProperties |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
mergeOpenLinkUrlPrefixes(ListValue value)
public CommonAddOnManifest.Builder mergeOpenLinkUrlPrefixes(ListValue value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ListValue |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CommonAddOnManifest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
removeUniversalActions(int index)
public CommonAddOnManifest.Builder removeUniversalActions(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 |
CommonAddOnManifest.Builder | |
setAddOnWidgetSet(AddOnWidgetSet value)
public CommonAddOnManifest.Builder setAddOnWidgetSet(AddOnWidgetSet value)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;
| Parameter | |
|---|---|
| Name | Description |
value | AddOnWidgetSet |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
setAddOnWidgetSet(AddOnWidgetSet.Builder builderForValue)
public CommonAddOnManifest.Builder setAddOnWidgetSet(AddOnWidgetSet.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | AddOnWidgetSet.Builder |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public CommonAddOnManifest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
setHomepageTrigger(HomepageExtensionPoint value)
public CommonAddOnManifest.Builder setHomepageTrigger(HomepageExtensionPoint value)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;
| Parameter | |
|---|---|
| Name | Description |
value | HomepageExtensionPoint |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
setHomepageTrigger(HomepageExtensionPoint.Builder builderForValue)
public CommonAddOnManifest.Builder setHomepageTrigger(HomepageExtensionPoint.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | HomepageExtensionPoint.Builder |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
setLayoutProperties(LayoutProperties value)
public CommonAddOnManifest.Builder setLayoutProperties(LayoutProperties value)Common layout properties for the add-on cards.
.google.apps.script.type.LayoutProperties layout_properties = 3;
| Parameter | |
|---|---|
| Name | Description |
value | LayoutProperties |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
setLayoutProperties(LayoutProperties.Builder builderForValue)
public CommonAddOnManifest.Builder setLayoutProperties(LayoutProperties.Builder builderForValue)Common layout properties for the add-on cards.
.google.apps.script.type.LayoutProperties layout_properties = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | LayoutProperties.Builder |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
setLogoUrl(String value)
public CommonAddOnManifest.Builder setLogoUrl(String value)Required. The URL for the logo image shown in the add-on toolbar.
string logo_url = 2;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe logoUrl to set. |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | This builder for chaining. |
setLogoUrlBytes(ByteString value)
public CommonAddOnManifest.Builder setLogoUrlBytes(ByteString value)Required. The URL for the logo image shown in the add-on toolbar.
string logo_url = 2;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for logoUrl to set. |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | This builder for chaining. |
setName(String value)
public CommonAddOnManifest.Builder setName(String value)Required. The display name of the add-on.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public CommonAddOnManifest.Builder setNameBytes(ByteString value)Required. The display name of the add-on.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | This builder for chaining. |
setOpenLinkUrlPrefixes(ListValue value)
public CommonAddOnManifest.Builder setOpenLinkUrlPrefixes(ListValue value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ListValue |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
setOpenLinkUrlPrefixes(ListValue.Builder builderForValue)
public CommonAddOnManifest.Builder setOpenLinkUrlPrefixes(ListValue.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CommonAddOnManifest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
setUniversalActions(int index, UniversalActionExtensionPoint value)
public CommonAddOnManifest.Builder setUniversalActions(int index, UniversalActionExtensionPoint value)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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | UniversalActionExtensionPoint |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
setUniversalActions(int index, UniversalActionExtensionPoint.Builder builderForValue)
public CommonAddOnManifest.Builder setUniversalActions(int index, UniversalActionExtensionPoint.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | UniversalActionExtensionPoint.Builder |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final CommonAddOnManifest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | |
setUseLocaleFromApp(boolean value)
public CommonAddOnManifest.Builder setUseLocaleFromApp(boolean value)Whether to pass locale information from host app.
bool use_locale_from_app = 5;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe useLocaleFromApp to set. |
| Returns | |
|---|---|
| Type | Description |
CommonAddOnManifest.Builder | This builder for chaining. |