context_v2_automationState Script API

Ben Tiedt — Fri, 08 Mar 2024 17:15:07 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:15:07

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

Get
Update

Methods

Get

Retrieves the contextual state data for this instance of this automation.

Velocity

#set($queryStringResponse = $context_v2_automationState.Get())

JavaScript

var queryStringResponse = context_v2_automationState.Get();

Returns

[[QueryString Script API Type|QueryString]]

Update

Update Overload 1

Updates the contextual state data for this instance of this automation. Up to 4kB of data can be saved for an automation.

Velocity

#set($additionalInfoResponse = $context_v2_automationState.Update())

JavaScript

var additionalInfoResponse = context_v2_automationState.Update();

Parameters

Name	Type	Description	Required	Default	Options
state	Options	Set of optional parameters including:	Required

Update Overload 2

Updates the contextual state data for this instance of this automation. Up to 4kB of data can be saved for an automation.

Velocity

#set($additionalInfoResponse = $context_v2_automationState.Update($state))

JavaScript

var additionalInfoResponse = context_v2_automationState.Update(state);

Parameters

Name	Type	Description	Required	Default	Options
state	`[[QueryString Script API Type\|QueryString]]`	State	Required

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]