Interface Topics

Asks the dashboard to show its access request prompt for a resource the user can't access, scoped like the Access API's /access/{resourceType}/{resourceId}/requests. Replies once the prompt is shown. The prompt handles the Access API outcome (SSO enforcement, pending or declined requests, request limits), so the reply doesn't report it.

ok: false reasons:

• unsupported: the dashboard doesn't show access requests for the sending application
• already-has-access: the user already has access to the resource, so there is nothing to request

Reports user activity in an application, e.g. for the recents feed. Fire-and-forget.

The base path for an application.

An unknown application returns {ok: false}.

The capabilities the host provides. A missing key means the host does not provide it.

The available application configuration modules.

The foreground application's context, or null when it has published none.

Publishes the sending application's context. null clears it. Fire-and-forget.

The foreground application ID, or null on dashboard-level routes.

The dashboard applications and installations available to the current user. Each member publishes its own raw serialised record, so the kinds are distinguished by shape: an Application has a type of 'studio' | 'coreApp', a LocalApplication adds local, and an Installation has no type and carries applicationId with a nested application object.

Asks the dashboard to reload the sending application with its latest code, without reloading the dashboard. Replies before the application is unmounted.

ok: false reasons:

• unsupported: the dashboard can't reload the sending application

The session token for the reading connection, or null while signed out. The host writes it to each connection separately, so one application never sees another's token.

Requests a dashboard session token.

The signed-in user's favorited documents, published while the host provides favorites.

Favorites or unfavorites a document. The host replies once favorites.documents reflects the change, so a read after the reply sees it. A favorite is identified by its published document ID, type, resource and schemaName (workspace).

The current dashboard location and active navigation.

Requests navigation and replies when the location commits.

ok: false reasons:

• not-navigable: the URL cannot be handled by a dashboard application
• interrupted: another navigation superseded the request
• failed: the router rejected or did not commit the request

The current organization, or null without an active organization.

The open panel, its application, display mode, and optional width in pixels.

Opens, updates, resizes, or closes an application's panel.

The resolved dashboard color scheme.

Whether the dashboard dock is pinned open.

The signed-in user, or null while signed out.

A worker messages its own application's views. Only that application's views receive it; they read it with useWorker.

A view posts to one of its own application's workers by service name. The dashboard passes the payload to that worker and returns its reply, or refuses with NO_RESPONDER when the worker isn't running. Views send it with useWorker.