Class DocsAddOnManifest.Builder (2.83.0)

public static final class DocsAddOnManifest.Builder extends GeneratedMessage.Builder<DocsAddOnManifest.Builder> implements DocsAddOnManifestOrBuilder

Docs add-on manifest.

Protobuf type google.apps.script.type.docs.DocsAddOnManifest

Static Methods

getDescriptor()

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

Methods

build()

public DocsAddOnManifest build()
Returns
Type Description
DocsAddOnManifest

buildPartial()

public DocsAddOnManifest buildPartial()
Returns
Type Description
DocsAddOnManifest

clear()

public DocsAddOnManifest.Builder clear()
Returns
Type Description
DocsAddOnManifest.Builder
Overrides

clearHomepageTrigger()

public DocsAddOnManifest.Builder clearHomepageTrigger()

If present, this overrides the configuration from addOns.common.homepageTrigger.

.google.apps.script.type.HomepageExtensionPoint homepage_trigger = 1;

Returns
Type Description
DocsAddOnManifest.Builder

clearOnFileScopeGrantedTrigger()

public DocsAddOnManifest.Builder clearOnFileScopeGrantedTrigger()

Endpoint to execute when file scope authorization is granted for this document/user pair.

.google.apps.script.type.docs.DocsExtensionPoint on_file_scope_granted_trigger = 2;

Returns
Type Description
DocsAddOnManifest.Builder

getDefaultInstanceForType()

public DocsAddOnManifest getDefaultInstanceForType()
Returns
Type Description
DocsAddOnManifest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getHomepageTrigger()

public HomepageExtensionPoint getHomepageTrigger()

If present, this overrides the configuration from addOns.common.homepageTrigger.

.google.apps.script.type.HomepageExtensionPoint homepage_trigger = 1;

Returns
Type Description
HomepageExtensionPoint

The homepageTrigger.

getHomepageTriggerBuilder()

public HomepageExtensionPoint.Builder getHomepageTriggerBuilder()

If present, this overrides the configuration from addOns.common.homepageTrigger.

.google.apps.script.type.HomepageExtensionPoint homepage_trigger = 1;

Returns
Type Description
HomepageExtensionPoint.Builder

getHomepageTriggerOrBuilder()

public HomepageExtensionPointOrBuilder getHomepageTriggerOrBuilder()

If present, this overrides the configuration from addOns.common.homepageTrigger.

.google.apps.script.type.HomepageExtensionPoint homepage_trigger = 1;

Returns
Type Description
HomepageExtensionPointOrBuilder

getOnFileScopeGrantedTrigger()

public DocsExtensionPoint getOnFileScopeGrantedTrigger()

Endpoint to execute when file scope authorization is granted for this document/user pair.

.google.apps.script.type.docs.DocsExtensionPoint on_file_scope_granted_trigger = 2;

Returns
Type Description
DocsExtensionPoint

The onFileScopeGrantedTrigger.

getOnFileScopeGrantedTriggerBuilder()

public DocsExtensionPoint.Builder getOnFileScopeGrantedTriggerBuilder()

Endpoint to execute when file scope authorization is granted for this document/user pair.

.google.apps.script.type.docs.DocsExtensionPoint on_file_scope_granted_trigger = 2;

Returns
Type Description
DocsExtensionPoint.Builder

getOnFileScopeGrantedTriggerOrBuilder()

public DocsExtensionPointOrBuilder getOnFileScopeGrantedTriggerOrBuilder()

Endpoint to execute when file scope authorization is granted for this document/user pair.

.google.apps.script.type.docs.DocsExtensionPoint on_file_scope_granted_trigger = 2;

Returns
Type Description
DocsExtensionPointOrBuilder

hasHomepageTrigger()

public boolean hasHomepageTrigger()

If present, this overrides the configuration from addOns.common.homepageTrigger.

.google.apps.script.type.HomepageExtensionPoint homepage_trigger = 1;

Returns
Type Description
boolean

Whether the homepageTrigger field is set.

hasOnFileScopeGrantedTrigger()

public boolean hasOnFileScopeGrantedTrigger()

Endpoint to execute when file scope authorization is granted for this document/user pair.

.google.apps.script.type.docs.DocsExtensionPoint on_file_scope_granted_trigger = 2;

Returns
Type Description
boolean

Whether the onFileScopeGrantedTrigger field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DocsAddOnManifest other)

public DocsAddOnManifest.Builder mergeFrom(DocsAddOnManifest other)
Parameter
Name Description
other DocsAddOnManifest
Returns
Type Description
DocsAddOnManifest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DocsAddOnManifest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocsAddOnManifest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DocsAddOnManifest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DocsAddOnManifest.Builder
Overrides

mergeHomepageTrigger(HomepageExtensionPoint value)

public DocsAddOnManifest.Builder mergeHomepageTrigger(HomepageExtensionPoint value)

If present, this overrides the configuration from addOns.common.homepageTrigger.

.google.apps.script.type.HomepageExtensionPoint homepage_trigger = 1;

Parameter
Name Description
value HomepageExtensionPoint
Returns
Type Description
DocsAddOnManifest.Builder

mergeOnFileScopeGrantedTrigger(DocsExtensionPoint value)

public DocsAddOnManifest.Builder mergeOnFileScopeGrantedTrigger(DocsExtensionPoint value)

Endpoint to execute when file scope authorization is granted for this document/user pair.

.google.apps.script.type.docs.DocsExtensionPoint on_file_scope_granted_trigger = 2;

Parameter
Name Description
value DocsExtensionPoint
Returns
Type Description
DocsAddOnManifest.Builder

setHomepageTrigger(HomepageExtensionPoint value)

public DocsAddOnManifest.Builder setHomepageTrigger(HomepageExtensionPoint value)

If present, this overrides the configuration from addOns.common.homepageTrigger.

.google.apps.script.type.HomepageExtensionPoint homepage_trigger = 1;

Parameter
Name Description
value HomepageExtensionPoint
Returns
Type Description
DocsAddOnManifest.Builder

setHomepageTrigger(HomepageExtensionPoint.Builder builderForValue)

public DocsAddOnManifest.Builder setHomepageTrigger(HomepageExtensionPoint.Builder builderForValue)

If present, this overrides the configuration from addOns.common.homepageTrigger.

.google.apps.script.type.HomepageExtensionPoint homepage_trigger = 1;

Parameter
Name Description
builderForValue HomepageExtensionPoint.Builder
Returns
Type Description
DocsAddOnManifest.Builder

setOnFileScopeGrantedTrigger(DocsExtensionPoint value)

public DocsAddOnManifest.Builder setOnFileScopeGrantedTrigger(DocsExtensionPoint value)

Endpoint to execute when file scope authorization is granted for this document/user pair.

.google.apps.script.type.docs.DocsExtensionPoint on_file_scope_granted_trigger = 2;

Parameter
Name Description
value DocsExtensionPoint
Returns
Type Description
DocsAddOnManifest.Builder

setOnFileScopeGrantedTrigger(DocsExtensionPoint.Builder builderForValue)

public DocsAddOnManifest.Builder setOnFileScopeGrantedTrigger(DocsExtensionPoint.Builder builderForValue)

Endpoint to execute when file scope authorization is granted for this document/user pair.

.google.apps.script.type.docs.DocsExtensionPoint on_file_scope_granted_trigger = 2;

Parameter
Name Description
builderForValue DocsExtensionPoint.Builder
Returns
Type Description
DocsAddOnManifest.Builder