OpenFairyGUI API
Preparing search index...
backend/src
BackendRuntime
Class BackendRuntime
Index
Constructors
constructor
Methods
apply
Transaction
close
Session
get
Cache
Snapshot
get
Capabilities
get
Events
get
Project
Outline
get
Session
materialize
Session
open
Project
Session
open
Session
preflight
Transaction
query
Entity
read
Resource
Bytes
read
Session
State
refresh
Cache
save
Session
validate
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
,
>
,
>
close
Session
closeSession
(
input
:
{
sessionId
:
string
}
,
)
:
Promise
<
BackendResult
<
{
closed
:
true
;
sessionId
:
string
}
,
SessionNotFoundError
|
SessionCloseFailedError
,
>
,
>
Parameters
input
:
{
sessionId
:
string
}
Returns
Promise
<
BackendResult
<
{
closed
:
true
;
sessionId
:
string
}
,
SessionNotFoundError
|
SessionCloseFailedError
,
>
,
>
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
Project
Outline
getProjectOutline
(
input
:
GetProjectOutlineInput
,
)
:
BackendResult
<
BackendProjectOutline
,
SessionNotFoundError
>
Parameters
input
:
GetProjectOutlineInput
Returns
BackendResult
<
BackendProjectOutline
,
SessionNotFoundError
>
get
Session
getSession
(
input
:
{
sessionId
:
string
}
,
)
:
BackendResult
<
BackendSessionSnapshot
,
SessionNotFoundError
>
Parameters
input
:
{
sessionId
:
string
}
Returns
BackendResult
<
BackendSessionSnapshot
,
SessionNotFoundError
>
materialize
Session
materializeSession
(
input
:
MaterializeSessionInput
,
)
:
Promise
<
BackendResult
<
MaterializeSessionSnapshot
,
|
SessionNotFoundError
|
SessionStaleWriteError
|
InProcessLockConflictError
|
UamFidelityUnsupportedError
|
MaterializeValidationFailedError
|
MaterializeWriteFailedError
|
PathPolicyViolationError
|
BackendCapabilityUnavailableError
,
>
,
>
Parameters
input
:
MaterializeSessionInput
Returns
Promise
<
BackendResult
<
MaterializeSessionSnapshot
,
|
SessionNotFoundError
|
SessionStaleWriteError
|
InProcessLockConflictError
|
UamFidelityUnsupportedError
|
MaterializeValidationFailedError
|
MaterializeWriteFailedError
|
PathPolicyViolationError
|
BackendCapabilityUnavailableError
,
>
,
>
open
Project
Session
openProjectSession
(
input
:
OpenProjectSessionInput
,
)
:
BackendResult
<
BackendSessionSnapshot
,
SessionIdConflictError
|
InProcessLockConflictError
,
>
Parameters
input
:
OpenProjectSessionInput
Returns
BackendResult
<
BackendSessionSnapshot
,
SessionIdConflictError
|
InProcessLockConflictError
,
>
open
Session
openSession
(
input
:
{
projectPath
:
string
}
,
)
:
Promise
<
BackendResult
<
BackendSessionSnapshot
,
|
InProcessLockConflictError
|
AdvisoryLockConflictError
|
BackendCapabilityUnavailableError
|
ProjectRootNotAllowedError
|
ProjectOpenFailedError
,
>
,
>
Parameters
input
:
{
projectPath
:
string
}
Returns
Promise
<
BackendResult
<
BackendSessionSnapshot
,
|
InProcessLockConflictError
|
AdvisoryLockConflictError
|
BackendCapabilityUnavailableError
|
ProjectRootNotAllowedError
|
ProjectOpenFailedError
,
>
,
>
preflight
Transaction
preflightTransaction
(
input
:
ApplySessionTransactionInput
,
)
:
Promise
<
BackendResult
<
BackendTransactionPreview
,
|
ApplyUamTransactionAppError
|
SessionNotFoundError
|
TransactionPreviewError
|
SessionStaleWriteError
,
>
,
>
Parameters
input
:
ApplySessionTransactionInput
Returns
Promise
<
BackendResult
<
BackendTransactionPreview
,
|
ApplyUamTransactionAppError
|
SessionNotFoundError
|
TransactionPreviewError
|
SessionStaleWriteError
,
>
,
>
query
Entity
queryEntity
(
input
:
QueryEntityInput
,
)
:
BackendResult
<
BackendEntitySnapshot
,
SessionNotFoundError
|
EntityQueryError
,
>
Parameters
input
:
QueryEntityInput
Returns
BackendResult
<
BackendEntitySnapshot
,
SessionNotFoundError
|
EntityQueryError
>
read
Resource
Bytes
readResourceBytes
(
input
:
ReadResourceBytesInput
,
)
:
BackendResult
<
BackendResourceBytesSnapshot
,
SessionNotFoundError
|
SessionReadError
|
SessionStaleReadError
,
>
Parameters
input
:
ReadResourceBytesInput
Returns
BackendResult
<
BackendResourceBytesSnapshot
,
SessionNotFoundError
|
SessionReadError
|
SessionStaleReadError
,
>
read
Session
State
readSessionState
(
input
:
ReadSessionStateInput
,
)
:
BackendResult
<
BackendSessionStateSnapshot
,
SessionNotFoundError
|
SessionReadError
|
SessionStaleReadError
,
>
Parameters
input
:
ReadSessionStateInput
Returns
BackendResult
<
BackendSessionStateSnapshot
,
SessionNotFoundError
|
SessionReadError
|
SessionStaleReadError
,
>
refresh
Cache
refreshCache
(
input
:
RefreshCacheInput
,
)
:
BackendResult
<
BackendCacheSnapshot
,
SessionNotFoundError
>
Parameters
input
:
RefreshCacheInput
Returns
BackendResult
<
BackendCacheSnapshot
,
SessionNotFoundError
>
save
Session
saveSession
(
input
:
SaveSessionInput
,
)
:
Promise
<
BackendResult
<
BackendSessionSnapshot
|
MaterializeSessionSnapshot
,
|
SessionNotFoundError
|
SessionStaleWriteError
|
InProcessLockConflictError
|
SavePartialFailureError
|
UamFidelityUnsupportedError
|
MaterializeValidationFailedError
|
MaterializeWriteFailedError
|
PathPolicyViolationError
|
BackendCapabilityUnavailableError
,
>
,
>
Parameters
input
:
SaveSessionInput
Returns
Promise
<
BackendResult
<
BackendSessionSnapshot
|
MaterializeSessionSnapshot
,
|
SessionNotFoundError
|
SessionStaleWriteError
|
InProcessLockConflictError
|
SavePartialFailureError
|
UamFidelityUnsupportedError
|
MaterializeValidationFailedError
|
MaterializeWriteFailedError
|
PathPolicyViolationError
|
BackendCapabilityUnavailableError
,
>
,
>
validate
Session
validateSession
(
input
:
ValidateSessionInput
,
)
:
BackendResult
<
ProjectValidationReport
,
SessionNotFoundError
>
Parameters
input
:
ValidateSessionInput
Returns
BackendResult
<
ProjectValidationReport
,
SessionNotFoundError
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
apply
Transaction
close
Session
get
Cache
Snapshot
get
Capabilities
get
Events
get
Project
Outline
get
Session
materialize
Session
open
Project
Session
open
Session
preflight
Transaction
query
Entity
read
Resource
Bytes
read
Session
State
refresh
Cache
save
Session
validate
Session
OpenFairyGUI API
Loading...