Integration App React - v2.21.0
Console
SDK
REST API
Preparing search index...
useFlowInstance
Function useFlowInstance
useFlowInstance
(
selector
:
undefined
|
string
|
FlowInstanceSelector
,
)
:
{
flowInstance
:
undefined
|
FlowInstance
;
accessor
:
undefined
|
FlowInstanceAccessor
;
refresh
:
()
=>
Promise
<
FlowInstance
>
;
enable
:
()
=>
Promise
<
void
>
;
disable
:
()
=>
Promise
<
void
>
;
reset
:
(
options
?:
ResetFlowInstanceOptions
)
=>
Promise
<
void
>
;
setup
:
()
=>
Promise
<
void
>
;
openConfiguration
:
(
options
:
OpenFlowInstanceConfigurationOptions
,
)
=>
Promise
<
undefined
|
void
>
;
openEditor
:
(
options
?:
OpenFlowInstanceEditorOptions
,
)
=>
Promise
<
undefined
|
void
>
;
run
:
(
options
?:
RunFlowOptions
)
=>
Promise
<
undefined
|
FlowRun
>
;
startRun
:
(
options
?:
RunFlowOptions
)
=>
Promise
<
undefined
|
FlowRun
>
;
loading
:
boolean
;
saving
:
boolean
;
error
:
any
;
refreshing
:
boolean
;
create
:
(
data
:
{
name
?:
string
;
userId
?:
string
;
integrationId
?:
string
;
connectionId
?:
string
;
parameters
?:
any
;
flowId
?:
string
;
instanceKey
?:
string
;
nodes
?:
Record
<
string
,
{
concurrency
?:
number
;
type
?:
string
;
name
?:
string
;
userConfig
?:
any
;
config
?:
any
;
onError
?:
"stop"
|
"continue"
;
ui
?:
any
;
links
?:
{
key
?:
string
;
name
?:
string
;
filter
?:
any
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
enabled
?:
boolean
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
}
,
)
=>
Promise
<
undefined
|
FlowInstance
>
;
patch
:
(
data
:
Partial
<
UpdateRequest
>
)
=>
Promise
<
void
>
;
put
:
(
data
:
{
name
?:
string
;
parameters
?:
any
;
nodes
?:
Record
<
string
,
{
concurrency
?:
number
;
type
?:
string
;
name
?:
string
;
userConfig
?:
any
;
config
?:
any
;
onError
?:
"stop"
|
"continue"
;
links
?:
{
key
?:
string
;
name
?:
string
;
filter
?:
any
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
enabled
?:
boolean
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
archivedAt
?:
string
;
}
,
)
=>
Promise
<
void
>
;
archive
:
()
=>
Promise
<
void
>
;
}
Parameters
selector
:
undefined
|
string
|
FlowInstanceSelector
Returns
{
flowInstance
:
undefined
|
FlowInstance
;
accessor
:
undefined
|
FlowInstanceAccessor
;
refresh
:
()
=>
Promise
<
FlowInstance
>
;
enable
:
()
=>
Promise
<
void
>
;
disable
:
()
=>
Promise
<
void
>
;
reset
:
(
options
?:
ResetFlowInstanceOptions
)
=>
Promise
<
void
>
;
setup
:
()
=>
Promise
<
void
>
;
openConfiguration
:
(
options
:
OpenFlowInstanceConfigurationOptions
,
)
=>
Promise
<
undefined
|
void
>
;
openEditor
:
(
options
?:
OpenFlowInstanceEditorOptions
,
)
=>
Promise
<
undefined
|
void
>
;
run
:
(
options
?:
RunFlowOptions
)
=>
Promise
<
undefined
|
FlowRun
>
;
startRun
:
(
options
?:
RunFlowOptions
)
=>
Promise
<
undefined
|
FlowRun
>
;
loading
:
boolean
;
saving
:
boolean
;
error
:
any
;
refreshing
:
boolean
;
create
:
(
data
:
{
name
?:
string
;
userId
?:
string
;
integrationId
?:
string
;
connectionId
?:
string
;
parameters
?:
any
;
flowId
?:
string
;
instanceKey
?:
string
;
nodes
?:
Record
<
string
,
{
concurrency
?:
number
;
type
?:
string
;
name
?:
string
;
userConfig
?:
any
;
config
?:
any
;
onError
?:
"stop"
|
"continue"
;
ui
?:
any
;
links
?:
{
key
?:
string
;
name
?:
string
;
filter
?:
any
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
enabled
?:
boolean
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
}
,
)
=>
Promise
<
undefined
|
FlowInstance
>
;
patch
:
(
data
:
Partial
<
UpdateRequest
>
)
=>
Promise
<
void
>
;
put
:
(
data
:
{
name
?:
string
;
parameters
?:
any
;
nodes
?:
Record
<
string
,
{
concurrency
?:
number
;
type
?:
string
;
name
?:
string
;
userConfig
?:
any
;
config
?:
any
;
onError
?:
"stop"
|
"continue"
;
links
?:
{
key
?:
string
;
name
?:
string
;
filter
?:
any
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
enabled
?:
boolean
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
archivedAt
?:
string
;
}
,
)
=>
Promise
<
void
>
;
archive
:
()
=>
Promise
<
void
>
;
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Console
SDK
REST API
Integration App React - v2.21.0
Loading...