Interface MessagingRegistry

Registry of providers; the shell holds exactly one.

interface MessagingRegistry {
    close(): void;
    composite(): MessagingBackend;
    disable(id: string): void;
    enable(id: string): void;
    get(id: string): ProviderEntry | undefined;
    list(): readonly ProviderEntry[];
    preferences(): MessagingPreferences;
    register(provider: MessagingProvider): void;
    setDefault(id: string): void;
}

Index

Methods

close composite disable enable get list preferences register setDefault

Methods

close

close(): void

Close every backend.

Returns void

composite

composite(): MessagingBackend

One backend that spans every enabled provider, for the NAP dm service.

Returns MessagingBackend

disable

disable(id: string): void
Parameters
- id: string
Returns void

enable

enable(id: string): void
Enable a provider. Throws unavailable:<reason> when it cannot run.
Parameters
- id: string
Returns void

get

get(id: string): ProviderEntry | undefined
Parameters
- id: string
Returns ProviderEntry | undefined

list

list(): readonly ProviderEntry[]

Returns readonly ProviderEntry[]

preferences

preferences(): MessagingPreferences

Returns MessagingPreferences

register

register(provider: MessagingProvider): void
Parameters
- provider: MessagingProvider
Returns void

setDefault

setDefault(id: string): void
Parameters
- id: string
Returns void