BX.UI.StepProcessing.Process

Constructor

Class constructor

constructor(options: ProcessOptions)

Structure fields for initializing the process ProcessOptions.

Start / stop

start(startStep?: number = 1) – Starts processing action queue. Optional tool is the item inside queue.

stop() – Cancels queue processing.

startRequest() – Requests current action

stopRequest() – Stops current action and sends action cancel to the default controller. It must implement action with the same name.

finalizeRequest() – sends action finalize to the default controller, intended for freeing up resources and temporary data cleanup. Controller must implement action with the same name.

Sets queue requests

Request queue fields – QueueAction.

setQueue(queue: Array) – Sets all action queue.

addQueueAction(action: QueueAction) – Adds a separate action.

getQueueLength(): number – Queue length.

Process ID

Unique process code within page context.

setId(id: string)

getId(): string

Process option

Options are described in structure for initializing the process – ProcessOptions.

setOption(name: $Keys, value: any)

getOption(name: $Keys, defaultValue?: any = null): any

Fields for input by user at the start page

Structure fields for initializing input fields – OptionsField.

setOptionsFields(optionsFields: {[id: string]: OptionsField}) – Sets all fields at once.

addOptionsField(id: string, field: OptionsField) – Adds a separate field.

storeOptionFieldValues(values: {[name: string]: any}) – Save start values in sessionStorage.

restoreOptionFieldValues() – Restore values from sessionStorage.

Request parameters

setParams(params: {[name: string]: any})

getParams(): {[string]:any}

setParam(key: string, value: any)

getParam(key: string): any | null

Process status

Status descriptions – ProcessState.

setState(state: $Values, result?: ProcessResult = {}) – Sets new process status.

getState(): $Values

Controller

Controller description.

setController(controller: string) – Sets controller to receive requests.

getController(): string

setComponent(component: string, componentMode: 'class'|'ajax' = 'class') – Sets component controller to send requests.

getComponent(): string

Action

Description of controller actions.

setAction(action: string)

getAction(): string callAction(action: string)

Callback functions

Call types – ProcessCallback.

setHandlers(handlers: {[$Keys]: any => {}})

setHandler(type: $Keys, handler: any => {})

hasHandler(type: $Keys)

callHandler(type: $Keys, args: any)

hasActionHandler(type: $Keys)

callActionHandler(type: $Keys, args: any)

Phrases, printed to dialog and buttons

Phrase types.

setMessages(messages: {[string]: string})

setMessage(id: string, text: string)

getMessage(id: string, placeholders?: {[string]: string} = null): strin

Dialog

getDialog(): Dialog – Get link to dialog object instance for current process Dialog.

showDialog () – Show dialog.

closeDialog () – Hide dialog.