public final class GmailAddOnManifest extends GeneratedMessageV3 implements GmailAddOnManifestOrBuilder
Properties customizing the appearance and execution of a Gmail add-on.
Protobuf type google.apps.script.type.gmail.GmailAddOnManifest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
AUTHORIZATION_CHECK_FUNCTION_FIELD_NUMBER
public static final int AUTHORIZATION_CHECK_FUNCTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
COMPOSE_TRIGGER_FIELD_NUMBER
public static final int COMPOSE_TRIGGER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CONTEXTUAL_TRIGGERS_FIELD_NUMBER
public static final int CONTEXTUAL_TRIGGERS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
HOMEPAGE_TRIGGER_FIELD_NUMBER
public static final int HOMEPAGE_TRIGGER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UNIVERSAL_ACTIONS_FIELD_NUMBER
public static final int UNIVERSAL_ACTIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static GmailAddOnManifest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static GmailAddOnManifest.Builder newBuilder()
newBuilder(GmailAddOnManifest prototype)
public static GmailAddOnManifest.Builder newBuilder(GmailAddOnManifest prototype)
public static GmailAddOnManifest parseDelimitedFrom(InputStream input)
public static GmailAddOnManifest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static GmailAddOnManifest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GmailAddOnManifest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static GmailAddOnManifest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GmailAddOnManifest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GmailAddOnManifest parseFrom(CodedInputStream input)
public static GmailAddOnManifest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static GmailAddOnManifest parseFrom(InputStream input)
public static GmailAddOnManifest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static GmailAddOnManifest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static GmailAddOnManifest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<GmailAddOnManifest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAuthorizationCheckFunction()
public String getAuthorizationCheckFunction()
The name of an endpoint that verifies that the add-on has
all the required third-party authorizations, by probing the third-party
APIs. If the probe fails, the function should throw an exception to
initiate the authorization flow. This function is called before each
invocation of the add-on, in order to ensure a smooth user experience.
string authorization_check_function = 7;
| Returns |
|---|
| Type | Description |
String | The authorizationCheckFunction.
|
getAuthorizationCheckFunctionBytes()
public ByteString getAuthorizationCheckFunctionBytes()
The name of an endpoint that verifies that the add-on has
all the required third-party authorizations, by probing the third-party
APIs. If the probe fails, the function should throw an exception to
initiate the authorization flow. This function is called before each
invocation of the add-on, in order to ensure a smooth user experience.
string authorization_check_function = 7;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for authorizationCheckFunction.
|
getComposeTrigger()
public ComposeTrigger getComposeTrigger()
Defines the compose time trigger for a compose time add-on. This is the
trigger that causes an add-on to take action when the user is composing an
email.
All compose time addons are required to have the
gmail.addons.current.action.compose scope even though it might not edit the
draft.
.google.apps.script.type.gmail.ComposeTrigger compose_trigger = 12;
getComposeTriggerOrBuilder()
public ComposeTriggerOrBuilder getComposeTriggerOrBuilder()
Defines the compose time trigger for a compose time add-on. This is the
trigger that causes an add-on to take action when the user is composing an
email.
All compose time addons are required to have the
gmail.addons.current.action.compose scope even though it might not edit the
draft.
.google.apps.script.type.gmail.ComposeTrigger compose_trigger = 12;
getContextualTriggers(int index)
public ContextualTrigger getContextualTriggers(int index)
Defines the set of conditions that trigger the add-on.
repeated .google.apps.script.type.gmail.ContextualTrigger contextual_triggers = 3;
| Parameter |
|---|
| Name | Description |
index | int
|
getContextualTriggersCount()
public int getContextualTriggersCount()
Defines the set of conditions that trigger the add-on.
repeated .google.apps.script.type.gmail.ContextualTrigger contextual_triggers = 3;
| Returns |
|---|
| Type | Description |
int | |
getContextualTriggersList()
public List<ContextualTrigger> getContextualTriggersList()
Defines the set of conditions that trigger the add-on.
repeated .google.apps.script.type.gmail.ContextualTrigger contextual_triggers = 3;
getContextualTriggersOrBuilder(int index)
public ContextualTriggerOrBuilder getContextualTriggersOrBuilder(int index)
Defines the set of conditions that trigger the add-on.
repeated .google.apps.script.type.gmail.ContextualTrigger contextual_triggers = 3;
| Parameter |
|---|
| Name | Description |
index | int
|
getContextualTriggersOrBuilderList()
public List<? extends ContextualTriggerOrBuilder> getContextualTriggersOrBuilderList()
Defines the set of conditions that trigger the add-on.
repeated .google.apps.script.type.gmail.ContextualTrigger contextual_triggers = 3;
| Returns |
|---|
| Type | Description |
List<? extends com.google.apps.script.type.gmail.ContextualTriggerOrBuilder> | |
getDefaultInstanceForType()
public GmailAddOnManifest getDefaultInstanceForType()
getHomepageTrigger()
public HomepageExtensionPoint getHomepageTrigger()
Defines an endpoint that will be executed in contexts that don't
match a declared contextual trigger. 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.
If present, this overrides the configuration from
addOns.common.homepageTrigger.
.google.apps.script.type.HomepageExtensionPoint homepage_trigger = 14;
getHomepageTriggerOrBuilder()
public HomepageExtensionPointOrBuilder getHomepageTriggerOrBuilder()
Defines an endpoint that will be executed in contexts that don't
match a declared contextual trigger. 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.
If present, this overrides the configuration from
addOns.common.homepageTrigger.
.google.apps.script.type.HomepageExtensionPoint homepage_trigger = 14;
getParserForType()
public Parser<GmailAddOnManifest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUniversalActions(int index)
public UniversalAction getUniversalActions(int index)
Defines set of universal
actions for the add-on. The user
triggers universal actions from the add-on toolbar menu.
repeated .google.apps.script.type.gmail.UniversalAction universal_actions = 4;
| Parameter |
|---|
| Name | Description |
index | int
|
getUniversalActionsCount()
public int getUniversalActionsCount()
Defines set of universal
actions for the add-on. The user
triggers universal actions from the add-on toolbar menu.
repeated .google.apps.script.type.gmail.UniversalAction universal_actions = 4;
| Returns |
|---|
| Type | Description |
int | |
getUniversalActionsList()
public List<UniversalAction> getUniversalActionsList()
Defines set of universal
actions for the add-on. The user
triggers universal actions from the add-on toolbar menu.
repeated .google.apps.script.type.gmail.UniversalAction universal_actions = 4;
getUniversalActionsOrBuilder(int index)
public UniversalActionOrBuilder getUniversalActionsOrBuilder(int index)
Defines set of universal
actions for the add-on. The user
triggers universal actions from the add-on toolbar menu.
repeated .google.apps.script.type.gmail.UniversalAction universal_actions = 4;
| Parameter |
|---|
| Name | Description |
index | int
|
getUniversalActionsOrBuilderList()
public List<? extends UniversalActionOrBuilder> getUniversalActionsOrBuilderList()
Defines set of universal
actions for the add-on. The user
triggers universal actions from the add-on toolbar menu.
repeated .google.apps.script.type.gmail.UniversalAction universal_actions = 4;
| Returns |
|---|
| Type | Description |
List<? extends com.google.apps.script.type.gmail.UniversalActionOrBuilder> | |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hasComposeTrigger()
public boolean hasComposeTrigger()
Defines the compose time trigger for a compose time add-on. This is the
trigger that causes an add-on to take action when the user is composing an
email.
All compose time addons are required to have the
gmail.addons.current.action.compose scope even though it might not edit the
draft.
.google.apps.script.type.gmail.ComposeTrigger compose_trigger = 12;
| Returns |
|---|
| Type | Description |
boolean | Whether the composeTrigger field is set.
|
hasHomepageTrigger()
public boolean hasHomepageTrigger()
Defines an endpoint that will be executed in contexts that don't
match a declared contextual trigger. 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.
If present, this overrides the configuration from
addOns.common.homepageTrigger.
.google.apps.script.type.HomepageExtensionPoint homepage_trigger = 14;
| Returns |
|---|
| Type | Description |
boolean | Whether the homepageTrigger field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public GmailAddOnManifest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected GmailAddOnManifest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public GmailAddOnManifest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
