Workflow | @types/arcgis-js-api

Hierarchy

Accessor
- Workflow

Index

Properties

Methods

Properties

Readonly data

data: CreateWorkflowData | UpdateWorkflowData

Shared workflow data.

declaredClass

declaredClass: string

destroyed

destroyed: boolean

Readonly hasNextStep

hasNextStep: boolean

This property indicates whether there is a next step in the workflow.

Readonly hasPreviousStep

hasPreviousStep: boolean

This property indicates if there is a previous step in the workflow.

initialized

initialized: boolean

Readonly started

started: boolean

Indicates whether the workflow is considered active.

Readonly stepId

stepId: string

The name of the current step in the workflow.

Readonly type

type: "create" | "update"

Value indicating the workflow type.

Methods

Protected _get

_get(propertyName: string): any
_get<T>(propertyName: string): T

Inherited from Accessor._get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:35
Parameters
- propertyName: string
Returns any
Inherited from Accessor._get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:36
Type parameters
- T
Parameters
- propertyName: string
Returns T

Protected _set

_set<T>(propertyName: string, value: T): Workflow

Inherited from Accessor._set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:37
Type parameters
- T
Parameters
- propertyName: string
- value: T
Returns Workflow

cancel

cancel(): Promise<void>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:74466
Cancels the active workflow.

Read more...

Returns Promise<void>

commit

commit(): Promise<void>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:74472
Call this method when the workflow is considered finished.

Read more...

Returns Promise<void>

destroy

destroy(): void

Inherited from Accessor.destroy
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:26
Returns void

get

get<T>(propertyName: string): T
get(propertyName: string): any

Inherited from Accessor.get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:28
Type parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from Accessor.get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:29
Parameters
- propertyName: string
Returns any

next(): Promise<void>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:74478
Moves to the next step in the workflow.

Read more...

Returns Promise<void>

Protected notifyChange

notifyChange(propertyName: string): void

Inherited from Accessor.notifyChange
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:34
Parameters
- propertyName: string
Returns void

previous(): Promise<void>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:74484
Moves to the previous step in the workflow.

Read more...

Returns Promise<void>

reset

reset(): Promise<void>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:74490
Resets the workflow.

Read more...

Returns Promise<void>

set

set<T>(propertyName: string, value: T): Workflow
set(props: HashMap<any>): Workflow

Inherited from Accessor.set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:30
Type parameters
- T
Parameters
- propertyName: string
- value: T
Returns Workflow
Inherited from Accessor.set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:31
Parameters
- props: HashMap<any>
Returns Workflow

start

start(): Promise<void>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:74496
Starts the workflow.

Read more...

Returns Promise<void>

watch

watch(path: string | string[], callback: WatchCallback, sync?: boolean): WatchHandle

Inherited from Accessor.watch
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:32
Parameters
- path: string | string[]
- callback: WatchCallback
- Optional sync: boolean
Returns WatchHandle

Hierarchy

Index

Properties

Methods

Properties

Readonly data

declaredClass

destroyed

Readonly hasNextStep

Readonly hasPreviousStep

initialized

Readonly started

Readonly stepId

Readonly type

Methods

Protected _get

Parameters

propertyName: string

Returns any

Type parameters

T

Parameters

propertyName: string

Returns T

Protected _set

Type parameters

T

Parameters

propertyName: string

value: T

Returns Workflow

cancel

Returns Promise<void>

commit

Returns Promise<void>

destroy

Returns void

get

Type parameters

T

Parameters

propertyName: string

Returns T

Parameters

propertyName: string

Returns any

next

Returns Promise<void>

Protected notifyChange

Parameters

propertyName: string

Returns void

previous

Returns Promise<void>

reset

Returns Promise<void>

set

Type parameters

T

Parameters

propertyName: string

value: T

Returns Workflow

Parameters

props: HashMap<any>

Returns Workflow

start

Returns Promise<void>

watch

Parameters

path: string | string[]

callback: WatchCallback

Optional sync: boolean

Returns WatchHandle