context_v2_automationTrigger Script API

Ben Tiedt — Wed, 20 Nov 2019 14:51:31 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/20/2019 14:51:31

This extension is only available when rendering the implementation of an automation. It is not generally available for use by widgets or themes.

Properties
CancelEvent

Properties

Name	Access	Type	Description
Arguments	Read	`[[AutomationScheduledEventArgs Script API Type\|AutomationScheduledEventArgs]]`	when triggered by schedule
		`Object`	specific platform event arguments when triggered by platform event
		`[[AutomationManualEventArgs Script API Type\|AutomationManualEventArgs]]`	when triggered manually
		`[[AutomationHttpEventArgs Script API Type\|AutomationHttpEventArgs]]`	when triggered by HTTP
Entity	Read	`String`	The name of the entity that triggered the automation: Http, Job, Manual, or platform event's entity.
Event	Read	`String`	The name of the event that triggered the automation: HTTP method when triggered by HTTP, Trigger when manual, Executed when scheduled, or platform event name.
TriggeredBy	Read	`[[User Script API Type\|User]]`	User who triggered the event.

Methods

CancelEvent

Attempts to cancel the current event and return the provided message as the error/cause of the cancellation. Note that not all events are cancellable and when a non-cancellable event is attempted to be cancelled, the automation will log an exception and stop processing, but other event handlers will continue to process.

Velocity

$context_v2_automationTrigger.CancelEvent($message)

JavaScript

context_v2_automationTrigger.CancelEvent(message);

Parameters

Name	Type	Description	Required	Default	Options
message	`String`	Message	Required

Returns

Nothing