Class HomepageExtensionPoint (2.47.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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > HomepageExtensionPoint

Static Fields

ENABLED_FIELD_NUMBER

public static final int ENABLED_FIELD_NUMBER
Field Value
Type Description
int

RUN_FUNCTION_FIELD_NUMBER

public static final int RUN_FUNCTION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static HomepageExtensionPoint getDefaultInstance()
Returns
Type Description
HomepageExtensionPoint

getDescriptor()

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

newBuilder()

public static HomepageExtensionPoint.Builder newBuilder()
Returns
Type Description
HomepageExtensionPoint.Builder

newBuilder(HomepageExtensionPoint prototype)

public static HomepageExtensionPoint.Builder newBuilder(HomepageExtensionPoint prototype)
Parameter
Name Description
prototype HomepageExtensionPoint
Returns
Type Description
HomepageExtensionPoint.Builder

parseDelimitedFrom(InputStream input)

public static HomepageExtensionPoint parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HomepageExtensionPoint
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HomepageExtensionPoint parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HomepageExtensionPoint
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static HomepageExtensionPoint parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
HomepageExtensionPoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static HomepageExtensionPoint parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HomepageExtensionPoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static HomepageExtensionPoint parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
HomepageExtensionPoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static HomepageExtensionPoint parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HomepageExtensionPoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static HomepageExtensionPoint parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
HomepageExtensionPoint
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static HomepageExtensionPoint parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HomepageExtensionPoint
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static HomepageExtensionPoint parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HomepageExtensionPoint
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HomepageExtensionPoint parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HomepageExtensionPoint
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static HomepageExtensionPoint parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
HomepageExtensionPoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static HomepageExtensionPoint parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HomepageExtensionPoint
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<HomepageExtensionPoint> parser()
Returns
Type Description
Parser<HomepageExtensionPoint>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public HomepageExtensionPoint getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
Type Description
BoolValueOrBuilder

getParserForType()

public Parser<HomepageExtensionPoint> getParserForType()
Returns
Type Description
Parser<HomepageExtensionPoint>
Overrides

getRunFunction()

public String getRunFunction()

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

string run_function = 1;

Returns
Type Description
String

The runFunction.

getRunFunctionBytes()

public ByteString getRunFunctionBytes()

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

string run_function = 1;

Returns
Type Description
ByteString

The bytes for runFunction.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
boolean

Whether the enabled field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public HomepageExtensionPoint.Builder newBuilderForType()
Returns
Type Description
HomepageExtensionPoint.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected HomepageExtensionPoint.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
HomepageExtensionPoint.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public HomepageExtensionPoint.Builder toBuilder()
Returns
Type Description
HomepageExtensionPoint.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException