Class ContextualTrigger (2.54.0)

public final class ContextualTrigger extends GeneratedMessageV3 implements ContextualTriggerOrBuilder

Defines a trigger that fires when the open email meets a specific criteria. When the trigger fires, it executes a specific endpoint, usually in order to create new cards and update the UI.

Protobuf type google.apps.script.type.gmail.ContextualTrigger

Static Fields

ON_TRIGGER_FUNCTION_FIELD_NUMBER

public static final int ON_TRIGGER_FUNCTION_FIELD_NUMBER
Field Value
Type Description
int

UNCONDITIONAL_FIELD_NUMBER

public static final int UNCONDITIONAL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ContextualTrigger getDefaultInstance()
Returns
Type Description
ContextualTrigger

getDescriptor()

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

newBuilder()

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

newBuilder(ContextualTrigger prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ContextualTrigger getDefaultInstanceForType()
Returns
Type Description
ContextualTrigger

getOnTriggerFunction()

public String getOnTriggerFunction()

Required. The name of the endpoint to call when a message matches the trigger.

string on_trigger_function = 4;

Returns
Type Description
String

The onTriggerFunction.

getOnTriggerFunctionBytes()

public ByteString getOnTriggerFunctionBytes()

Required. The name of the endpoint to call when a message matches the trigger.

string on_trigger_function = 4;

Returns
Type Description
ByteString

The bytes for onTriggerFunction.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTriggerCase()

public ContextualTrigger.TriggerCase getTriggerCase()
Returns
Type Description
ContextualTrigger.TriggerCase

getUnconditional()

public UnconditionalTrigger getUnconditional()

UnconditionalTriggers are executed when any mail message is opened.

.google.apps.script.type.gmail.UnconditionalTrigger unconditional = 1;

Returns
Type Description
UnconditionalTrigger

The unconditional.

getUnconditionalOrBuilder()

public UnconditionalTriggerOrBuilder getUnconditionalOrBuilder()

UnconditionalTriggers are executed when any mail message is opened.

.google.apps.script.type.gmail.UnconditionalTrigger unconditional = 1;

Returns
Type Description
UnconditionalTriggerOrBuilder

hasUnconditional()

public boolean hasUnconditional()

UnconditionalTriggers are executed when any mail message is opened.

.google.apps.script.type.gmail.UnconditionalTrigger unconditional = 1;

Returns
Type Description
boolean

Whether the unconditional 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 ContextualTrigger.Builder newBuilderForType()
Returns
Type Description
ContextualTrigger.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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