Prometheus Entity Management API
Preparing search index...
@prometheus-ags/entity-graph-core
devtools
GraphDevtoolsController
Interface GraphDevtoolsController
interface
GraphDevtoolsController
{
capabilities
:
GraphDevtoolsCapabilities
;
storeId
:
string
;
captureCompatibilitySnapshot
(
label
?:
string
)
:
number
;
clearHistory
()
:
void
;
clearSnapshotHistory
()
:
void
;
configureSnapshotLimit
(
snapshotLimit
:
number
)
:
void
;
confirmHistoryImport
(
candidateId
:
string
,
cursor
:
number
,
)
:
GraphDevtoolsHistoryImportRestoreResult
;
connect
(
clientId
?:
string
)
:
GraphDevtoolsTransport
;
getCompatibilitySnapshotReferences
()
:
readonly
{
bytes
:
number
;
capturedAt
:
string
;
cursor
:
number
;
eventSequence
:
number
|
null
;
label
?:
string
;
status
:
"retained"
;
}
[]
;
getEntityRecords
()
:
GraphDevtoolsEntityRecordsSnapshot
;
getHistory
()
:
readonly
GraphDevtoolsEvent
[]
;
getHistoryStatus
()
:
GraphDevtoolsHistoryStatus
;
getRelationships
()
:
GraphDevtoolsRelationshipsSnapshot
;
getSnapshot
()
:
GraphDevtoolsSnapshot
;
getSnapshotHistoryStatus
()
:
GraphDevtoolsSnapshotHistoryStatus
;
getSnapshotReferences
()
:
readonly
{
bytes
:
number
;
capturedAt
:
string
;
cursor
:
number
;
eventSequence
:
number
|
null
;
label
?:
string
;
status
:
"retained"
;
}
[]
;
getViews
()
:
GraphDevtoolsViewsSnapshot
;
handleCommand
(
command
:
unknown
)
:
GraphDevtoolsResult
;
inspectHistoryImport
(
candidate
:
unknown
,
)
:
GraphDevtoolsHistoryImportInspectionResult
;
isDisposed
()
:
boolean
;
registerView
(
definition
:
GraphDevtoolsViewDefinition
,
)
:
GraphDevtoolsViewRegistration
;
returnToLive
()
:
GraphDevtoolsReturnToLiveReceipt
|
null
;
rewind
(
cursor
:
number
)
:
GraphDevtoolsRewindResult
|
null
;
subscribe
(
listener
:
(
event
:
GraphDevtoolsEvent
)
=>
void
,
replay
?:
boolean
,
)
:
()
=>
void
;
subscribeSnapshotHistory
(
listener
:
()
=>
void
)
:
()
=>
void
;
}
Index
Properties
capabilities
store
Id
Methods
capture
Compatibility
Snapshot
clear
History
clear
Snapshot
History
configure
Snapshot
Limit
confirm
History
Import
connect
get
Compatibility
Snapshot
References
get
Entity
Records
get
History
get
History
Status
get
Relationships
get
Snapshot
get
Snapshot
History
Status
get
Snapshot
References
get
Views
handle
Command
inspect
History
Import
is
Disposed
register
View
return
To
Live
rewind
subscribe
subscribe
Snapshot
History
Properties
Readonly
capabilities
capabilities
:
GraphDevtoolsCapabilities
Readonly
store
Id
storeId
:
string
Methods
capture
Compatibility
Snapshot
captureCompatibilitySnapshot
(
label
?:
string
)
:
number
Parameters
Optional
label
:
string
Returns
number
clear
History
clearHistory
()
:
void
Returns
void
clear
Snapshot
History
clearSnapshotHistory
()
:
void
Returns
void
configure
Snapshot
Limit
configureSnapshotLimit
(
snapshotLimit
:
number
)
:
void
Parameters
snapshotLimit
:
number
Returns
void
confirm
History
Import
confirmHistoryImport
(
candidateId
:
string
,
cursor
:
number
,
)
:
GraphDevtoolsHistoryImportRestoreResult
Parameters
candidateId
:
string
cursor
:
number
Returns
GraphDevtoolsHistoryImportRestoreResult
connect
connect
(
clientId
?:
string
)
:
GraphDevtoolsTransport
Parameters
Optional
clientId
:
string
Returns
GraphDevtoolsTransport
get
Compatibility
Snapshot
References
getCompatibilitySnapshotReferences
()
:
readonly
{
bytes
:
number
;
capturedAt
:
string
;
cursor
:
number
;
eventSequence
:
number
|
null
;
label
?:
string
;
status
:
"retained"
;
}
[]
Returns
readonly
{
bytes
:
number
;
capturedAt
:
string
;
cursor
:
number
;
eventSequence
:
number
|
null
;
label
?:
string
;
status
:
"retained"
;
}
[]
get
Entity
Records
getEntityRecords
()
:
GraphDevtoolsEntityRecordsSnapshot
Returns
GraphDevtoolsEntityRecordsSnapshot
get
History
getHistory
()
:
readonly
GraphDevtoolsEvent
[]
Returns
readonly
GraphDevtoolsEvent
[]
get
History
Status
getHistoryStatus
()
:
GraphDevtoolsHistoryStatus
Returns
GraphDevtoolsHistoryStatus
get
Relationships
getRelationships
()
:
GraphDevtoolsRelationshipsSnapshot
Returns
GraphDevtoolsRelationshipsSnapshot
get
Snapshot
getSnapshot
()
:
GraphDevtoolsSnapshot
Returns
GraphDevtoolsSnapshot
get
Snapshot
History
Status
getSnapshotHistoryStatus
()
:
GraphDevtoolsSnapshotHistoryStatus
Returns
GraphDevtoolsSnapshotHistoryStatus
get
Snapshot
References
getSnapshotReferences
()
:
readonly
{
bytes
:
number
;
capturedAt
:
string
;
cursor
:
number
;
eventSequence
:
number
|
null
;
label
?:
string
;
status
:
"retained"
;
}
[]
Returns
readonly
{
bytes
:
number
;
capturedAt
:
string
;
cursor
:
number
;
eventSequence
:
number
|
null
;
label
?:
string
;
status
:
"retained"
;
}
[]
get
Views
getViews
()
:
GraphDevtoolsViewsSnapshot
Returns
GraphDevtoolsViewsSnapshot
handle
Command
handleCommand
(
command
:
unknown
)
:
GraphDevtoolsResult
Parameters
command
:
unknown
Returns
GraphDevtoolsResult
inspect
History
Import
inspectHistoryImport
(
candidate
:
unknown
,
)
:
GraphDevtoolsHistoryImportInspectionResult
Parameters
candidate
:
unknown
Returns
GraphDevtoolsHistoryImportInspectionResult
is
Disposed
isDisposed
()
:
boolean
Returns
boolean
register
View
registerView
(
definition
:
GraphDevtoolsViewDefinition
,
)
:
GraphDevtoolsViewRegistration
Parameters
definition
:
GraphDevtoolsViewDefinition
Returns
GraphDevtoolsViewRegistration
return
To
Live
returnToLive
()
:
GraphDevtoolsReturnToLiveReceipt
|
null
Returns
GraphDevtoolsReturnToLiveReceipt
|
null
rewind
rewind
(
cursor
:
number
)
:
GraphDevtoolsRewindResult
|
null
Parameters
cursor
:
number
Returns
GraphDevtoolsRewindResult
|
null
subscribe
subscribe
(
listener
:
(
event
:
GraphDevtoolsEvent
)
=>
void
,
replay
?:
boolean
,
)
:
()
=>
void
Parameters
listener
:
(
event
:
GraphDevtoolsEvent
)
=>
void
Optional
replay
:
boolean
Returns
()
=>
void
subscribe
Snapshot
History
subscribeSnapshotHistory
(
listener
:
()
=>
void
)
:
()
=>
void
Parameters
listener
:
()
=>
void
Returns
()
=>
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
capabilities
store
Id
Methods
capture
Compatibility
Snapshot
clear
History
clear
Snapshot
History
configure
Snapshot
Limit
confirm
History
Import
connect
get
Compatibility
Snapshot
References
get
Entity
Records
get
History
get
History
Status
get
Relationships
get
Snapshot
get
Snapshot
History
Status
get
Snapshot
References
get
Views
handle
Command
inspect
History
Import
is
Disposed
register
View
return
To
Live
rewind
subscribe
subscribe
Snapshot
History
Prometheus Entity Management API
Loading...