kernl API
    Preparing search index...

    Interface MessagingBackend

    The backend contract a provider exposes. Structurally identical to kehto's DmAdapter so a provider's backend can be handed to createDmService without translation, while keeping this package free of a kehto dependency.

    interface MessagingBackend {
        close?(): void;
        conversations(
            query?: DmConversationQuery,
        ): DmConversationPage | Promise<DmConversationPage>;
        messages(query: DmMessageQuery): DmMessagePage | Promise<DmMessagePage>;
        send(request: DmSendRequest): Promise<DmSendResult>;
        status(): DmStatus | Promise<DmStatus>;
        subscribe(
            request: DmSubscribeRequest,
            onMessage: (message: DmMessage) => void,
        ): DmSubscription | Promise<DmSubscription>;
        unsubscribe(subscriptionId: string): DmOk | Promise<DmOk>;
    }

    Hierarchy (View Summary)

    Index
    close? conversations messages send status subscribe unsubscribe

    • Returns void

    • Parameters

      • Optionalquery: DmConversationQuery

      Returns DmConversationPage | Promise<DmConversationPage>

    • Parameters

      • query: DmMessageQuery

      Returns DmMessagePage | Promise<DmMessagePage>

    • Parameters

      • request: DmSendRequest

      Returns Promise<DmSendResult>

    • Returns DmStatus | Promise<DmStatus>

    • Parameters

      • request: DmSubscribeRequest
      • onMessage: (message: DmMessage) => void

      Returns DmSubscription | Promise<DmSubscription>

    • Parameters

      • subscriptionId: string

      Returns DmOk | Promise<DmOk>

    Settings
    Member Visibility

    On This Page
    Methods