OpenFairyGUI API
Preparing search index...
backend/src
BackendRuntime
Class BackendRuntime
Index
Constructors
constructor
Methods
apply
Transaction
cancel
Job
close
Session
get
Cache
Snapshot
get
Capabilities
get
Events
get
Job
get
Session
list
Jobs
materialize
Session
open
Project
Session
open
Session
refresh
Cache
save
Session
Constructors
constructor
new
BackendRuntime
(
options
?:
BackendRuntimeOptions
)
:
BackendRuntime
Parameters
options
:
BackendRuntimeOptions
= {}
Returns
BackendRuntime
Methods
apply
Transaction
applyTransaction
(
input
:
ApplySessionTransactionInput
,
)
:
Promise
<
BackendResult
<
BackendSessionSnapshot
,
|
ApplyUamTransactionAppError
|
SessionNotFoundError
|
SessionStaleWriteError
,
>
,
>
Parameters
input
:
ApplySessionTransactionInput
Returns
Promise
<
BackendResult
<
BackendSessionSnapshot
,
|
ApplyUamTransactionAppError
|
SessionNotFoundError
|
SessionStaleWriteError
,
>
,
>
cancel
Job
cancelJob
(
input
:
CancelJobInput
,
)
:
BackendResult
<
BackendJobSnapshot
,
|
SessionNotFoundError
|
BackendJobNotFoundError
|
BackendJobNotCancellableError
,
>
Parameters
input
:
CancelJobInput
Returns
BackendResult
<
BackendJobSnapshot
,
|
SessionNotFoundError
|
BackendJobNotFoundError
|
BackendJobNotCancellableError
,
>
close
Session
closeSession
(
input
:
{
sessionId
:
string
}
,
)
:
Promise
<
BackendResult
<
{
closed
:
true
;
sessionId
:
string
}
,
SessionNotFoundError
>
,
>
Parameters
input
:
{
sessionId
:
string
}
Returns
Promise
<
BackendResult
<
{
closed
:
true
;
sessionId
:
string
}
,
SessionNotFoundError
>
,
>
get
Cache
Snapshot
getCacheSnapshot
(
input
:
GetCacheSnapshotInput
,
)
:
BackendResult
<
BackendCacheSnapshot
,
SessionNotFoundError
>
Parameters
input
:
GetCacheSnapshotInput
Returns
BackendResult
<
BackendCacheSnapshot
,
SessionNotFoundError
>
get
Capabilities
getCapabilities
()
:
BackendSuccess
<
BackendCapabilities
>
Returns
BackendSuccess
<
BackendCapabilities
>
get
Events
getEvents
(
input
:
GetEventsInput
,
)
:
BackendResult
<
GetEventsSnapshot
,
SessionNotFoundError
|
EventCursorInvalidError
,
>
Parameters
input
:
GetEventsInput
Returns
BackendResult
<
GetEventsSnapshot
,
SessionNotFoundError
|
EventCursorInvalidError
>
get
Job
getJob
(
input
:
GetJobInput
,
)
:
BackendResult
<
BackendJobSnapshot
,
SessionNotFoundError
|
BackendJobNotFoundError
,
>
Parameters
input
:
GetJobInput
Returns
BackendResult
<
BackendJobSnapshot
,
SessionNotFoundError
|
BackendJobNotFoundError
,
>
get
Session
getSession
(
input
:
{
sessionId
:
string
}
,
)
:
BackendResult
<
BackendSessionSnapshot
,
SessionNotFoundError
>
Parameters
input
:
{
sessionId
:
string
}
Returns
BackendResult
<
BackendSessionSnapshot
,
SessionNotFoundError
>
list
Jobs
listJobs
(
input
:
ListJobsInput
,
)
:
BackendResult
<
BackendJobListSnapshot
,
SessionNotFoundError
>
Parameters
input
:
ListJobsInput
Returns
BackendResult
<
BackendJobListSnapshot
,
SessionNotFoundError
>
materialize
Session
materializeSession
(
input
:
MaterializeSessionInput
,
)
:
Promise
<
BackendResult
<
MaterializeSessionSnapshot
,
|
BackendCapabilityUnavailableError
|
SessionNotFoundError
|
SessionStaleWriteError
|
InProcessLockConflictError
|
UamFidelityUnsupportedError
|
MaterializeValidationFailedError
|
MaterializeWriteFailedError
|
PathPolicyViolationError
,
>
,
>
Parameters
input
:
MaterializeSessionInput
Returns
Promise
<
BackendResult
<
MaterializeSessionSnapshot
,
|
BackendCapabilityUnavailableError
|
SessionNotFoundError
|
SessionStaleWriteError
|
InProcessLockConflictError
|
UamFidelityUnsupportedError
|
MaterializeValidationFailedError
|
MaterializeWriteFailedError
|
PathPolicyViolationError
,
>
,
>
open
Project
Session
openProjectSession
(
input
:
OpenProjectSessionInput
,
)
:
BackendResult
<
BackendSessionSnapshot
>
Parameters
input
:
OpenProjectSessionInput
Returns
BackendResult
<
BackendSessionSnapshot
>
open
Session
openSession
(
input
:
{
projectPath
:
string
}
,
)
:
Promise
<
BackendResult
<
BackendSessionSnapshot
,
|
AdvisoryLockConflictError
|
BackendCapabilityUnavailableError
|
InProcessLockConflictError
,
>
,
>
Parameters
input
:
{
projectPath
:
string
}
Returns
Promise
<
BackendResult
<
BackendSessionSnapshot
,
|
AdvisoryLockConflictError
|
BackendCapabilityUnavailableError
|
InProcessLockConflictError
,
>
,
>
refresh
Cache
refreshCache
(
input
:
RefreshCacheInput
,
)
:
BackendResult
<
BackendJobSnapshot
,
SessionNotFoundError
>
Parameters
input
:
RefreshCacheInput
Returns
BackendResult
<
BackendJobSnapshot
,
SessionNotFoundError
>
save
Session
saveSession
(
input
:
SaveSessionInput
,
)
:
Promise
<
BackendResult
<
BackendSessionSnapshot
|
MaterializeSessionSnapshot
,
|
BackendCapabilityUnavailableError
|
SessionNotFoundError
|
SessionStaleWriteError
|
InProcessLockConflictError
|
SavePartialFailureError
|
UamFidelityUnsupportedError
|
MaterializeValidationFailedError
|
MaterializeWriteFailedError
|
PathPolicyViolationError
,
>
,
>
Parameters
input
:
SaveSessionInput
Returns
Promise
<
BackendResult
<
BackendSessionSnapshot
|
MaterializeSessionSnapshot
,
|
BackendCapabilityUnavailableError
|
SessionNotFoundError
|
SessionStaleWriteError
|
InProcessLockConflictError
|
SavePartialFailureError
|
UamFidelityUnsupportedError
|
MaterializeValidationFailedError
|
MaterializeWriteFailedError
|
PathPolicyViolationError
,
>
,
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
apply
Transaction
cancel
Job
close
Session
get
Cache
Snapshot
get
Capabilities
get
Events
get
Job
get
Session
list
Jobs
materialize
Session
open
Project
Session
open
Session
refresh
Cache
save
Session
OpenFairyGUI API
Loading...