Interface MessagingProvider

A pluggable private-messaging implementation.

interface MessagingProvider {
    description: string;
    id: string;
    name: string;
    properties: SecurityProperties;
    availability(): ProviderAvailability;
    createBackend(): MessagingBackend;
}

Index

Properties

description id name properties

Methods

availability createBackend

Properties

`Readonly`description

description: string

One sentence for the picker.

`Readonly`id

id: string

Stable identifier used as the conversation-id prefix (private:, legacy:).

`Readonly`name

name: string

User-facing name. No protocol vocabulary.

`Readonly`properties

properties: SecurityProperties

Methods

availability

availability(): ProviderAvailability

Whether the provider can run in this shell right now.

Returns ProviderAvailability

createBackend

createBackend(): MessagingBackend

Build the backend. Called once per enable; the registry owns the instance.

Returns MessagingBackend