Interface CatalogIntentResolver

A IntentResolver backed by a catalog, with a host hook to announce catalog/default changes.

interface CatalogIntentResolver {
    available(
        archetype: string,
    ): IntentAvailability | Promise<IntentAvailability>;
    handlers(): IntentAvailability[] | Promise<IntentAvailability[]>;
    invoke(
        request: IntentRequest,
        context: IntentResolverContext,
    ): IntentResult | Promise<IntentResult>;
    notifyChanged(archetype: string): void;
    onChanged?(
        listener: (availability: IntentAvailability) => void,
    ): () => void;
}

Hierarchy (View Summary)

IntentResolver
- CatalogIntentResolver

Index

Methods

available handlers invoke notifyChanged onChanged?

Methods

available

available(archetype: string): IntentAvailability | Promise<IntentAvailability>
Report whether the runtime can currently satisfy archetype, and how.
Parameters
- archetype: string
Returns IntentAvailability | Promise<IntentAvailability>
Inherited from IntentResolver.available
- Defined in packages/services/src/intent-service.ts:62

handlers

handlers(): IntentAvailability[] | Promise<IntentAvailability[]>
Report availability for every archetype the runtime can currently satisfy.

Returns IntentAvailability[] | Promise<IntentAvailability[]>
Inherited from IntentResolver.handlers
- Defined in packages/services/src/intent-service.ts:64

invoke

invoke(
request: IntentRequest,
context: IntentResolverContext,
): IntentResult | Promise<IntentResult>
Resolve request.archetype to a handler, create or focus its window, and deliver payload. Returns once the handler is resolved and the window created; delivery MAY complete asynchronously.
Parameters
- request: IntentRequest
- context: IntentResolverContext
Returns IntentResult | Promise<IntentResult>
Inherited from IntentResolver.invoke
- Defined in packages/services/src/intent-service.ts:60

notifyChanged

notifyChanged(archetype: string): void
Announce that the catalog or default handler for archetype changed. The resolver recomputes availability and notifies onChanged listeners, which the intent service forwards to napplets as intent.changed pushes.
Parameters
- archetype: string
Returns void
- Defined in packages/services/src/catalog-intent-resolver.ts:120

`Optional`onChanged

onChanged?(listener: (availability: IntentAvailability) => void): () => void
Register for availability changes (a napplet installed/removed, or a default handler changed). The service forwards each change to served napplets as an intent.changed push. Returns an unsubscribe handle. Resolvers whose catalog never changes at runtime MAY omit this.
Parameters
- listener: (availability: IntentAvailability) => void
Returns () => void
Inherited from IntentResolver.onChanged
- Defined in packages/services/src/intent-service.ts:71