Class ApiAction

Hierarchy

ActionBase
- ApiAction

Index

Constructors

constructor

new ApiAction(action: ActionBase): ApiAction

Overrides ActionBase.constructor
- Defined in Action.ts:186
Parameters
- action: ActionBase
Returns ApiAction

Properties

actionId

actionId: string

actionType

actionType: ActionTypes

createdDateTime

createdDateTime: string

isTerminal

isTerminal: boolean

logicArguments

logicArguments: ActionArgument[]

name

name: string

negativeConditions

negativeConditions: Condition[] = []

negativeEntities

negativeEntities: string[] = []

packageCreationId

packageCreationId: number

packageDeletionId

packageDeletionId: number

payload

payload: string

renderArguments

renderArguments: ActionArgument[]

requiredConditions

requiredConditions: Condition[] = []

requiredEntities

requiredEntities: string[] = []

requiredEntitiesFromPayload

requiredEntitiesFromPayload: string[]

suggestedEntity

suggestedEntity: string | null = null

version

version: number

Methods

Private renderArgs

renderArgs(args: ActionArgument[], entityValues: Map<string, string>, serializerOptions?: Partial<IOptions>): RenderedActionArgument[]

- Defined in Action.ts:208
Parameters
- args: ActionArgument[]
- entityValues: Map<string, string>
- Default value serializerOptions: Partial<IOptions> = {}
Returns RenderedActionArgument[]

renderLogicArguments

renderLogicArguments(entityValues: Map<string, string>, serializerOptions?: Partial<IOptions>): RenderedActionArgument[]

- Defined in Action.ts:200
Parameters
- entityValues: Map<string, string>
- Default value serializerOptions: Partial<IOptions> = {}
Returns RenderedActionArgument[]

renderRenderArguments

renderRenderArguments(entityValues: Map<string, string>, serializerOptions?: Partial<IOptions>): RenderedActionArgument[]

- Defined in Action.ts:204
Parameters
- entityValues: Map<string, string>
- Default value serializerOptions: Partial<IOptions> = {}
Returns RenderedActionArgument[]

Static GetActionArguments

GetActionArguments(action: ActionBase | ScoredAction): ActionArgument[]

Inherited from ActionBase.GetActionArguments
- Defined in Action.ts:98
Return arguments for an action

Parameters
- action: ActionBase | ScoredAction
Returns ActionArgument[]

Static GetPayload

GetPayload(action: ActionBase | ScoredAction, entityValues: Map<string, string>): string

Inherited from ActionBase.GetPayload
- Defined in Action.ts:63
Parameters
- action: ActionBase | ScoredAction
- entityValues: Map<string, string>
Returns string

Generated using TypeDoc