Membrane SDK - v0.2.1
Console
React Lib
REST API
Preparing search index...
ConnectionLevelFlowAccessor
Class ConnectionLevelFlowAccessor
Hierarchy (
View Summary
)
ConnectionLevelElementAccessor
<
FlowInstance
,
UpdateFlowInstanceRequest
>
ConnectionLevelFlowAccessor
Index
Constructors
constructor
Properties
client
connection
Selector
flow
Selector
query
endpoint
selector
element
Key
Methods
enable
disable
run
open
Configuration
open
Editor
uri
get
Unique
Identifier
get
create
patch
put
archive
reset
setup
Constructors
constructor
new
ConnectionLevelFlowAccessor
(
client
:
IntegrationAppApiClient
,
connectionSelector
:
string
,
flowSelector
:
string
,
query
:
InstanceKeyQuery
,
)
:
ConnectionLevelFlowAccessor
Parameters
client
:
IntegrationAppApiClient
connectionSelector
:
string
flowSelector
:
string
query
:
InstanceKeyQuery
Returns
ConnectionLevelFlowAccessor
Properties
client
client
:
IntegrationAppApiClient
connection
Selector
connectionSelector
:
string
flow
Selector
flowSelector
:
string
query
query
:
InstanceKeyQuery
Protected
endpoint
endpoint
:
string
Protected
selector
selector
:
string
Protected
element
Key
elementKey
:
string
Methods
enable
enable
()
:
Promise
<
FlowInstance
>
Returns
Promise
<
FlowInstance
>
disable
disable
()
:
Promise
<
FlowInstance
>
Returns
Promise
<
FlowInstance
>
run
run
(
options
:
{
nodeKey
?:
string
;
input
?:
any
}
)
:
Promise
<
FlowRun
>
Parameters
options
:
{
nodeKey
?:
string
;
input
?:
any
}
Returns
Promise
<
FlowRun
>
open
Configuration
openConfiguration
(
options
?:
OpenFlowInstanceConfigurationOptions
)
:
Promise
<
void
>
Parameters
Optional
options
:
OpenFlowInstanceConfigurationOptions
Returns
Promise
<
void
>
open
Editor
openEditor
(
options
?:
OpenFlowInstanceEditorOptions
)
:
Promise
<
void
>
Parameters
Optional
options
:
OpenFlowInstanceEditorOptions
Returns
Promise
<
void
>
Protected
uri
uri
(
path
?:
string
,
query
?:
{}
)
:
string
Parameters
path
:
string
= ''
query
:
{}
= {}
Returns
string
get
Unique
Identifier
getUniqueIdentifier
()
:
string
Returns
string
get
get
(
query
?:
{
autoCreate
?:
boolean
}
)
:
Promise
<
FlowInstance
>
Parameters
query
:
{
autoCreate
?:
boolean
}
= {}
Returns
Promise
<
FlowInstance
>
create
create
()
:
Promise
<
FlowInstance
>
Returns
Promise
<
FlowInstance
>
patch
patch
(
data
:
Partial
<
UpdateElement
>
)
:
Promise
<
FlowInstance
>
Parameters
data
:
Partial
<
UpdateElement
>
Returns
Promise
<
FlowInstance
>
put
put
(
data
:
{
name
?:
string
;
enabled
?:
boolean
;
parameters
?:
any
;
nodes
?:
Record
<
string
,
{
name
?:
string
;
type
?:
string
;
userConfig
?:
any
;
config
?:
any
;
onError
?:
"stop"
|
"continue"
;
links
?:
{
key
?:
string
;
filter
?:
any
;
name
?:
string
}
[]
;
concurrency
?:
number
;
isCustomized
?:
boolean
;
}
,
>
;
archivedAt
?:
string
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
}
,
)
:
Promise
<
FlowInstance
>
Parameters
data
:
{
name
?:
string
;
enabled
?:
boolean
;
parameters
?:
any
;
nodes
?:
Record
<
string
,
{
name
?:
string
;
type
?:
string
;
userConfig
?:
any
;
config
?:
any
;
onError
?:
"stop"
|
"continue"
;
links
?:
{
key
?:
string
;
filter
?:
any
;
name
?:
string
}
[]
;
concurrency
?:
number
;
isCustomized
?:
boolean
;
}
,
>
;
archivedAt
?:
string
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
}
Returns
Promise
<
FlowInstance
>
archive
archive
()
:
Promise
<
void
>
Returns
Promise
<
void
>
reset
reset
()
:
Promise
<
FlowInstance
>
Returns
Promise
<
FlowInstance
>
setup
setup
()
:
Promise
<
FlowInstance
>
Returns
Promise
<
FlowInstance
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
client
connection
Selector
flow
Selector
query
endpoint
selector
element
Key
Methods
enable
disable
run
open
Configuration
open
Editor
uri
get
Unique
Identifier
get
create
patch
put
archive
reset
setup
Console
React Lib
REST API
Membrane SDK - v0.2.1
Loading...