A11 TypeScript API - v0.7.26
A11 guides
Python API
C++ internals
Preparing search index...
GraphAction
Class GraphAction
One C++ Action with familiar input, output, wait, and cancellation methods.
Index
Constructors
constructor
Methods
call
cancel
contains
Port
expose
Stream
Sources
get
Dispatch
Status
get
Header
get
Headers
get
Id
get
Input
get
Log
Node
get
Name
get
Node
get
Output
get
Port
get
Schema
get
Session
Id
get
Settings
get
Status
get
Stream
Sources
Node
has
Been
Called
has
Been
Run
has
Header
is
Done
log
make
Nested
register
Stream
release
remove
Header
resolve
Node
run
set
Header
set
Settings
wait
wait
For
Dispatch
create
make
Node
Id
Constructors
constructor
new
GraphAction
(
binding
:
ActionBinding
)
:
GraphAction
Parameters
binding
:
ActionBinding
Returns
GraphAction
Methods
call
call
()
:
Promise
<
StatusOr
<
GraphAction
>
>
Returns
Promise
<
StatusOr
<
GraphAction
>
>
cancel
cancel
()
:
Promise
<
Status
>
Returns
Promise
<
Status
>
contains
Port
containsPort
(
name
:
string
)
:
Promise
<
StatusOr
<
boolean
>
>
Parameters
name
:
string
Returns
Promise
<
StatusOr
<
boolean
>
>
expose
Stream
Sources
exposeStreamSources
(
port
:
string
,
purpose
:
string
)
:
Promise
<
Status
>
Parameters
port
:
string
purpose
:
string
Returns
Promise
<
Status
>
get
Dispatch
Status
getDispatchStatus
()
:
Promise
<
Status
|
null
>
Returns
Promise
<
Status
|
null
>
get
Header
getHeader
(
name
:
string
)
:
Promise
<
StatusOr
<
Uint8Array
<
ArrayBufferLike
>
|
null
>
>
Parameters
name
:
string
Returns
Promise
<
StatusOr
<
Uint8Array
<
ArrayBufferLike
>
|
null
>
>
get
Headers
getHeaders
()
:
Promise
<
StatusOr
<
ByteMap
>
>
Returns
Promise
<
StatusOr
<
ByteMap
>
>
get
Id
getId
()
:
string
Returns
string
get
Input
getInput
(
name
:
string
,
bindStream
?:
boolean
)
:
Promise
<
StatusOr
<
GraphNode
>
>
Parameters
name
:
string
Optional
bindStream
:
boolean
Returns
Promise
<
StatusOr
<
GraphNode
>
>
get
Log
Node
getLogNode
()
:
Promise
<
StatusOr
<
GraphNode
>
>
Returns
Promise
<
StatusOr
<
GraphNode
>
>
get
Name
getName
()
:
string
Returns
string
get
Node
getNode
(
id
:
string
)
:
Promise
<
StatusOr
<
GraphNode
>
>
Parameters
id
:
string
Returns
Promise
<
StatusOr
<
GraphNode
>
>
get
Output
getOutput
(
name
:
string
,
bindStream
?:
boolean
)
:
Promise
<
StatusOr
<
GraphNode
>
>
Parameters
name
:
string
Optional
bindStream
:
boolean
Returns
Promise
<
StatusOr
<
GraphNode
>
>
get
Port
getPort
(
name
:
string
)
:
Promise
<
StatusOr
<
GraphNode
>
>
Parameters
name
:
string
Returns
Promise
<
StatusOr
<
GraphNode
>
>
get
Schema
getSchema
()
:
Promise
<
StatusOr
<
ActionSchema
>
>
Returns
Promise
<
StatusOr
<
ActionSchema
>
>
get
Session
Id
getSessionId
()
:
Promise
<
StatusOr
<
string
|
null
>
>
Returns
Promise
<
StatusOr
<
string
|
null
>
>
get
Settings
getSettings
()
:
Promise
<
StatusOr
<
ActionSettings
>
>
Returns
Promise
<
StatusOr
<
ActionSettings
>
>
get
Status
getStatus
()
:
Promise
<
Status
>
Returns
Promise
<
Status
>
get
Stream
Sources
Node
getStreamSourcesNode
(
requestPayload
?:
boolean
)
:
Promise
<
StatusOr
<
GraphNode
>
>
Parameters
requestPayload
:
boolean
= true
Returns
Promise
<
StatusOr
<
GraphNode
>
>
has
Been
Called
hasBeenCalled
()
:
Promise
<
StatusOr
<
boolean
>
>
Returns
Promise
<
StatusOr
<
boolean
>
>
has
Been
Run
hasBeenRun
()
:
Promise
<
StatusOr
<
boolean
>
>
Returns
Promise
<
StatusOr
<
boolean
>
>
has
Header
hasHeader
(
name
:
string
)
:
Promise
<
StatusOr
<
boolean
>
>
Parameters
name
:
string
Returns
Promise
<
StatusOr
<
boolean
>
>
is
Done
isDone
()
:
Promise
<
StatusOr
<
boolean
>
>
Returns
Promise
<
StatusOr
<
boolean
>
>
log
log
(
value
:
unknown
)
:
Promise
<
Status
>
Parameters
value
:
unknown
Returns
Promise
<
Status
>
make
Nested
makeNested
(
schemaOrName
:
string
|
ActionSchema
,
options
?:
{
forwardHeaders
?:
boolean
;
id
?:
string
;
propagateIo
?:
boolean
}
,
)
:
Promise
<
StatusOr
<
GraphAction
>
>
Parameters
schemaOrName
:
string
|
ActionSchema
options
:
{
forwardHeaders
?:
boolean
;
id
?:
string
;
propagateIo
?:
boolean
}
= {}
Returns
Promise
<
StatusOr
<
GraphAction
>
>
register
Stream
registerStream
(
purpose
:
string
,
source
:
Record
<
string
,
unknown
>
,
producerId
?:
string
,
parentProducerId
?:
string
,
)
:
Promise
<
StatusOr
<
StreamReference
>
>
Parameters
purpose
:
string
source
:
Record
<
string
,
unknown
>
Optional
producerId
:
string
Optional
parentProducerId
:
string
Returns
Promise
<
StatusOr
<
StreamReference
>
>
release
release
()
:
Promise
<
Status
>
Returns
Promise
<
Status
>
remove
Header
removeHeader
(
name
:
string
)
:
Promise
<
Status
>
Parameters
name
:
string
Returns
Promise
<
Status
>
resolve
Node
resolveNode
(
reference
:
NodeRef
)
:
Promise
<
StatusOr
<
GraphNode
>
>
Parameters
reference
:
NodeRef
Returns
Promise
<
StatusOr
<
GraphNode
>
>
run
run
()
:
Promise
<
StatusOr
<
GraphAction
>
>
Returns
Promise
<
StatusOr
<
GraphAction
>
>
set
Header
setHeader
(
name
:
string
,
value
:
ByteSource
)
:
Promise
<
Status
>
Parameters
name
:
string
value
:
ByteSource
Returns
Promise
<
Status
>
set
Settings
setSettings
(
settings
:
ActionSettings
)
:
Promise
<
Status
>
Parameters
settings
:
ActionSettings
Returns
Promise
<
Status
>
wait
wait
(
timeoutMs
?:
number
)
:
Promise
<
StatusOr
<
GraphAction
>
>
Parameters
Optional
timeoutMs
:
number
Returns
Promise
<
StatusOr
<
GraphAction
>
>
wait
For
Dispatch
waitForDispatch
(
timeoutMs
?:
number
)
:
Promise
<
Status
>
Parameters
Optional
timeoutMs
:
number
Returns
Promise
<
Status
>
Static
create
create
(
schema
:
ActionSchema
,
options
?:
ActionCreateOptions
,
)
:
Promise
<
StatusOr
<
GraphAction
>
>
Parameters
schema
:
ActionSchema
options
:
ActionCreateOptions
= {}
Returns
Promise
<
StatusOr
<
GraphAction
>
>
Static
make
Node
Id
makeNodeId
(
actionId
:
string
,
nodeName
:
string
)
:
StatusOr
<
string
>
Parameters
actionId
:
string
nodeName
:
string
Returns
StatusOr
<
string
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
call
cancel
contains
Port
expose
Stream
Sources
get
Dispatch
Status
get
Header
get
Headers
get
Id
get
Input
get
Log
Node
get
Name
get
Node
get
Output
get
Port
get
Schema
get
Session
Id
get
Settings
get
Status
get
Stream
Sources
Node
has
Been
Called
has
Been
Run
has
Header
is
Done
log
make
Nested
register
Stream
release
remove
Header
resolve
Node
run
set
Header
set
Settings
wait
wait
For
Dispatch
create
make
Node
Id
A11 guides
Python API
C++ internals
A11 TypeScript API - v0.7.26
Loading...
One C++ Action with familiar input, output, wait, and cancellation methods.