logo
logo

Interface IActionScriptContext

Defines an action script context.

Namespace: Stylelabs.M.Scripting.Types.V1_0.Action
Assembly: Stylelabs.M.Scripting.Types.dll
Syntax
public interface IActionScriptContext

Properties

ChangeTracker

Gets used in combination with entity targets.

Declaration
IChangeTracker ChangeTracker { get; }
Property Value
Type Description
IChangeTracker

Data

Gets arguments passed through the script. Should never be null.

Declaration
JToken Data { get; }
Property Value
Type Description
JToken

ExecutionEvent

Gets the execution event.

Declaration
ExecutionEvent? ExecutionEvent { get; }
Property Value
Type Description
System.Nullable<ExecutionEvent>

ExecutionPhase

Gets the execution phase.

Declaration
ExecutionPhase? ExecutionPhase { get; }
Property Value
Type Description
System.Nullable<ExecutionPhase>

ExecutionSource

Gets the execution source.

Declaration
ExecutionSource ExecutionSource { get; }
Property Value
Type Description
ExecutionSource

ExecutionType

Gets the type of execution.

Declaration
ExecutionType ExecutionType { get; }
Property Value
Type Description
ExecutionType

PropertyBag

Gets useful collection of string keyed string properties for case when ExecutionSource is Trigger. Use to store and retrieve information between trigger phases and in or out-of-process actions. Should never be null.

Declaration
IPropertyBag PropertyBag { get; }
Property Value
Type Description
IPropertyBag
Remarks

Note that for ExecutionType equals to ExecutionType.OutOfProcess the bag is read only.

Result

Gets or sets output of the script, possibly null.

Declaration
JToken Result { get; set; }
Property Value
Type Description
JToken

StatusCode

Gets or sets status code to return when executed through REST.

Declaration
HttpStatusCode? StatusCode { get; set; }
Property Value
Type Description
System.Nullable<HttpStatusCode>

Target

Gets the target.

Declaration
object Target { get; }
Property Value
Type Description
System.Object

TargetId

Gets the target id.

Declaration
long? TargetId { get; }
Property Value
Type Description
System.Nullable<System.Int64>

TargetType

Gets the target type.

Declaration
TargetType? TargetType { get; }
Property Value
Type Description
System.Nullable<TargetType>

TriggeringUserId

Gets if applicable and available an id of the user who caused event leading to this action or id of the user explicitly requesting the action.

Declaration
long? TriggeringUserId { get; }
Property Value
Type Description
System.Nullable<System.Int64>

Methods

ToString()

Converts to string.

Declaration
string ToString()
Returns
Type Description
System.String

An string.

Can we improve this article ? Provide feedback