@valon-technologies/gestalt
Preparing search index...
@valon-technologies/gestalt
WorkflowProviderOptions
Interface WorkflowProviderOptions
Shared runtime metadata and lifecycle hooks for authored providers.
interface
WorkflowProviderOptions
{
name
?:
string
;
displayName
?:
string
;
description
?:
string
;
version
?:
string
;
configure
?:
ConfigureHandler
;
healthCheck
?:
HealthCheckHandler
;
warnings
?:
string
[]
|
WarningsHandler
;
start
?:
StartHandler
;
close
?:
CloseHandler
;
startRun
:
(
request
:
StartWorkflowProviderRunRequest
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowRun
>
>
;
getRun
:
(
request
:
GetWorkflowProviderRunRequest
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowRun
>
>
;
listRuns
:
(
request
:
Message
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowRun
>
[]
>
;
cancelRun
:
(
request
:
CancelWorkflowProviderRunRequest
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowRun
>
>
;
upsertSchedule
:
(
request
:
UpsertWorkflowProviderScheduleRequest
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowSchedule
>
>
;
getSchedule
:
(
request
:
GetWorkflowProviderScheduleRequest
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowSchedule
>
>
;
listSchedules
:
(
request
:
Message
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowSchedule
>
[]
>
;
deleteSchedule
:
(
request
:
DeleteWorkflowProviderScheduleRequest
,
)
=>
MaybePromise
<
void
>
;
pauseSchedule
:
(
request
:
PauseWorkflowProviderScheduleRequest
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowSchedule
>
>
;
resumeSchedule
:
(
request
:
ResumeWorkflowProviderScheduleRequest
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowSchedule
>
>
;
upsertEventTrigger
:
(
request
:
UpsertWorkflowProviderEventTriggerRequest
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowEventTrigger
>
>
;
getEventTrigger
:
(
request
:
GetWorkflowProviderEventTriggerRequest
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowEventTrigger
>
>
;
listEventTriggers
:
(
request
:
Message
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowEventTrigger
>
[]
>
;
deleteEventTrigger
:
(
request
:
DeleteWorkflowProviderEventTriggerRequest
,
)
=>
MaybePromise
<
void
>
;
pauseEventTrigger
:
(
request
:
PauseWorkflowProviderEventTriggerRequest
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowEventTrigger
>
>
;
resumeEventTrigger
:
(
request
:
ResumeWorkflowProviderEventTriggerRequest
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowEventTrigger
>
>
;
publishEvent
:
(
request
:
PublishWorkflowProviderEventRequest
,
)
=>
MaybePromise
<
void
>
;
}
Hierarchy (
View Summary
)
RuntimeProviderOptions
WorkflowProviderOptions
Index
Properties
name?
display
Name?
description?
version?
configure?
health
Check?
warnings?
start?
close?
start
Run
get
Run
list
Runs
cancel
Run
upsert
Schedule
get
Schedule
list
Schedules
delete
Schedule
pause
Schedule
resume
Schedule
upsert
Event
Trigger
get
Event
Trigger
list
Event
Triggers
delete
Event
Trigger
pause
Event
Trigger
resume
Event
Trigger
publish
Event
Properties
Optional
name
name
?:
string
Optional
display
Name
displayName
?:
string
Optional
description
description
?:
string
Optional
version
version
?:
string
Optional
configure
configure
?:
ConfigureHandler
Optional
health
Check
healthCheck
?:
HealthCheckHandler
Optional
warnings
warnings
?:
string
[]
|
WarningsHandler
Optional
start
start
?:
StartHandler
Optional
close
close
?:
CloseHandler
start
Run
startRun
:
(
request
:
StartWorkflowProviderRunRequest
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowRun
>
>
get
Run
getRun
:
(
request
:
GetWorkflowProviderRunRequest
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowRun
>
>
list
Runs
listRuns
:
(
request
:
Message
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowRun
>
[]
>
cancel
Run
cancelRun
:
(
request
:
CancelWorkflowProviderRunRequest
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowRun
>
>
upsert
Schedule
upsertSchedule
:
(
request
:
UpsertWorkflowProviderScheduleRequest
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowSchedule
>
>
get
Schedule
getSchedule
:
(
request
:
GetWorkflowProviderScheduleRequest
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowSchedule
>
>
list
Schedules
listSchedules
:
(
request
:
Message
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowSchedule
>
[]
>
delete
Schedule
deleteSchedule
:
(
request
:
DeleteWorkflowProviderScheduleRequest
,
)
=>
MaybePromise
<
void
>
pause
Schedule
pauseSchedule
:
(
request
:
PauseWorkflowProviderScheduleRequest
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowSchedule
>
>
resume
Schedule
resumeSchedule
:
(
request
:
ResumeWorkflowProviderScheduleRequest
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowSchedule
>
>
upsert
Event
Trigger
upsertEventTrigger
:
(
request
:
UpsertWorkflowProviderEventTriggerRequest
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowEventTrigger
>
>
get
Event
Trigger
getEventTrigger
:
(
request
:
GetWorkflowProviderEventTriggerRequest
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowEventTrigger
>
>
list
Event
Triggers
listEventTriggers
:
(
request
:
Message
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowEventTrigger
>
[]
>
delete
Event
Trigger
deleteEventTrigger
:
(
request
:
DeleteWorkflowProviderEventTriggerRequest
,
)
=>
MaybePromise
<
void
>
pause
Event
Trigger
pauseEventTrigger
:
(
request
:
PauseWorkflowProviderEventTriggerRequest
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowEventTrigger
>
>
resume
Event
Trigger
resumeEventTrigger
:
(
request
:
ResumeWorkflowProviderEventTriggerRequest
,
)
=>
MaybePromise
<
MessageInit
<
BoundWorkflowEventTrigger
>
>
publish
Event
publishEvent
:
(
request
:
PublishWorkflowProviderEventRequest
,
)
=>
MaybePromise
<
void
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
name
display
Name
description
version
configure
health
Check
warnings
start
close
start
Run
get
Run
list
Runs
cancel
Run
upsert
Schedule
get
Schedule
list
Schedules
delete
Schedule
pause
Schedule
resume
Schedule
upsert
Event
Trigger
get
Event
Trigger
list
Event
Triggers
delete
Event
Trigger
pause
Event
Trigger
resume
Event
Trigger
publish
Event
@valon-technologies/gestalt
Loading...
Shared runtime metadata and lifecycle hooks for authored providers.