ViewsAPI
Defined in: namespaces-core-plugins.ts:528
Host-rendered Saved Views (fn-95).
fn-95
Methods
Section titled “Methods”register()
Section titled “register()”register(
definition):Promise<string>
Defined in: namespaces-core-plugins.ts:530
Registers a saved view. Returns viewId. [views.register]
Parameters
Section titled “Parameters”definition
Section titled “definition”Returns
Section titled “Returns”Promise<string>
unregisterSavedView()
Section titled “unregisterSavedView()”unregisterSavedView(
viewId):Promise<void>
Defined in: namespaces-core-plugins.ts:532
Unregisters a saved view. [views.register]
Parameters
Section titled “Parameters”viewId
Section titled “viewId”string
Returns
Section titled “Returns”Promise<void>
list()
Section titled “list()”list(
filter?):Promise<SavedViewDefinition[]>
Defined in: namespaces-core-plugins.ts:534
Lists saved views. [views.read]
Parameters
Section titled “Parameters”filter?
Section titled “filter?”Returns
Section titled “Returns”Promise<SavedViewDefinition[]>
get(
viewId):Promise<SavedViewDefinition|null>
Defined in: namespaces-core-plugins.ts:536
Gets a saved view, or null. [views.read]
Parameters
Section titled “Parameters”viewId
Section titled “viewId”string
Returns
Section titled “Returns”Promise<SavedViewDefinition | null>
query()
Section titled “query()”query(
viewId):Promise<AnyJSONValue>
Defined in: namespaces-core-plugins.ts:538
Resolves the view’s query (cached, single-flight). [views.read]
Parameters
Section titled “Parameters”viewId
Section titled “viewId”string
Returns
Section titled “Returns”Promise<AnyJSONValue>
subscribe()
Section titled “subscribe()”subscribe(
viewId,callback):Promise<string>
Defined in: namespaces-core-plugins.ts:540
Subscribes to view refreshes. Returns a token. [views.read]
Parameters
Section titled “Parameters”viewId
Section titled “viewId”string
callback
Section titled “callback”(result) => void
Returns
Section titled “Returns”Promise<string>
unsubscribe()
Section titled “unsubscribe()”unsubscribe(
token):Promise<void>
Defined in: namespaces-core-plugins.ts:542
Cancels a subscription.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
refreshNow()
Section titled “refreshNow()”refreshNow(
viewId):Promise<void>
Defined in: namespaces-core-plugins.ts:544
Forces a refresh now. [views.read]
Parameters
Section titled “Parameters”viewId
Section titled “viewId”string
Returns
Section titled “Returns”Promise<void>
renderIntoPanel()
Section titled “renderIntoPanel()”renderIntoPanel(
viewId,panelId,target):Promise<string>
Defined in: namespaces-core-plugins.ts:546
Renders a saved view into a registered panel. Returns panelId. [views.read]
Parameters
Section titled “Parameters”viewId
Section titled “viewId”string
panelId
Section titled “panelId”string
target
Section titled “target”string
Returns
Section titled “Returns”Promise<string>
invokeRow()
Section titled “invokeRow()”invokeRow(
viewId,rowId,actionId):Promise<never>
Defined in: namespaces-core-plugins.ts:551
QUIRK: v1 stub — ALWAYS rejects notSupportedV1 (VS-12). Row-action
invocation is deferred to v2.
Parameters
Section titled “Parameters”viewId
Section titled “viewId”string
string
actionId
Section titled “actionId”string
Returns
Section titled “Returns”Promise<never>