Class HomepageExtensionPoint (2.39.0)

public final class HomepageExtensionPoint extends GeneratedMessageV3 implements HomepageExtensionPointOrBuilder

Common format for declaring an add-on's home-page view.

Protobuf type google.apps.script.type.HomepageExtensionPoint

Static Fields

ENABLED_FIELD_NUMBER

public static final int ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

RUN_FUNCTION_FIELD_NUMBER

public static final int RUN_FUNCTION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static HomepageExtensionPoint getDefaultInstance()
Returns
TypeDescription
HomepageExtensionPoint

getDescriptor()

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

newBuilder()

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

newBuilder(HomepageExtensionPoint prototype)

public static HomepageExtensionPoint.Builder newBuilder(HomepageExtensionPoint prototype)
Parameter
NameDescription
prototypeHomepageExtensionPoint
Returns
TypeDescription
HomepageExtensionPoint.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public HomepageExtensionPoint getDefaultInstanceForType()
Returns
TypeDescription
HomepageExtensionPoint

getEnabled()

public BoolValue getEnabled()

Optional. If set to false, disable the home-page view in this context.

Defaults to true if unset.

If an add-ons custom home-page view is disabled, an autogenerated overview card will be provided for users instead.

.google.protobuf.BoolValue enabled = 2;

Returns
TypeDescription
BoolValue

The enabled.

getEnabledOrBuilder()

public BoolValueOrBuilder getEnabledOrBuilder()

Optional. If set to false, disable the home-page view in this context.

Defaults to true if unset.

If an add-ons custom home-page view is disabled, an autogenerated overview card will be provided for users instead.

.google.protobuf.BoolValue enabled = 2;

Returns
TypeDescription
BoolValueOrBuilder

getParserForType()

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

getRunFunction()

public String getRunFunction()

Required. The endpoint to execute when this extension point is activated.

string run_function = 1;

Returns
TypeDescription
String

The runFunction.

getRunFunctionBytes()

public ByteString getRunFunctionBytes()

Required. The endpoint to execute when this extension point is activated.

string run_function = 1;

Returns
TypeDescription
ByteString

The bytes for runFunction.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasEnabled()

public boolean hasEnabled()

Optional. If set to false, disable the home-page view in this context.

Defaults to true if unset.

If an add-ons custom home-page view is disabled, an autogenerated overview card will be provided for users instead.

.google.protobuf.BoolValue enabled = 2;

Returns
TypeDescription
boolean

Whether the enabled 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 HomepageExtensionPoint.Builder newBuilderForType()
Returns
TypeDescription
HomepageExtensionPoint.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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