Documentation
    Preparing search index...

    Interface OutboxServiceOptions

    Options for createOutboxService.

    interface OutboxServiceOptions {
        router: OutboxRouter;
        getQueryRouter?(
            windowId: string,
            context: ServiceRuntimeContext | undefined,
        ): OutboxRouter;
        getReadRouter?(
            windowId: string,
            context: ServiceRuntimeContext | undefined,
        ): OutboxRouter;
    }
    Index

    Properties

    router: OutboxRouter

    The outbox router the shell uses to reach relays. Required.

    Methods

    • Optionally selects a query-specific router for a live napplet source.

      Parameters

      • windowId: string

        The authenticated source window for the request.

      • context: ServiceRuntimeContext | undefined

        Narrow runtime context for source-bound policy checks.

      Returns OutboxRouter

      Router used only for that source's one-shot outbox queries.

    • Optionally selects a source-scoped router for event-returning reads.

      The selected router is used for outbox.getEvent, outbox.query, and outbox.subscribe. A query-specific router takes precedence when both hooks are supplied.

      Parameters

      • windowId: string

        The authenticated source window for the request.

      • context: ServiceRuntimeContext | undefined

        Narrow runtime context for source-bound policy checks.

      Returns OutboxRouter

      Router used for that source's event-returning reads.