Class ContextualTrigger (2.23.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
TypeDescription
int

UNCONDITIONAL_FIELD_NUMBER

public static final int UNCONDITIONAL_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ContextualTrigger getDefaultInstance()
Returns
TypeDescription
ContextualTrigger

getDescriptor()

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

newBuilder()

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

newBuilder(ContextualTrigger prototype)

public static ContextualTrigger.Builder newBuilder(ContextualTrigger prototype)
Parameter
NameDescription
prototypeContextualTrigger
Returns
TypeDescription
ContextualTrigger.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ContextualTrigger getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for onTriggerFunction.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTriggerCase()

public ContextualTrigger.TriggerCase getTriggerCase()
Returns
TypeDescription
ContextualTrigger.TriggerCase

getUnconditional()

public UnconditionalTrigger getUnconditional()

UnconditionalTriggers are executed when any mail message is opened.

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

Returns
TypeDescription
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
TypeDescription
UnconditionalTriggerOrBuilder

hasUnconditional()

public boolean hasUnconditional()

UnconditionalTriggers are executed when any mail message is opened.

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

Returns
TypeDescription
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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