Skip to main content

Class: BridgeProvider

Defined in: packages/client/src/providers/bridge.ts:31

State and change notification for providers. Subclasses implement detect and createSession, and call setState.

Extends​

Constructors​

Constructor​

new BridgeProvider(options?): BridgeProvider

Defined in: packages/client/src/providers/bridge.ts:40

Parameters​

options?​

BridgeProviderOptions = {}

Returns​

BridgeProvider

Overrides​

BaseProvider.constructor

Properties​

asksFirst​

readonly asksFirst: true = true

Defined in: packages/client/src/providers/bridge.ts:35

The visitor's own AI: proposed first (see LeuriaOptions.fallback).


client​

readonly client: BridgeClient

Defined in: packages/client/src/providers/bridge.ts:32


id​

readonly id: string

Defined in: packages/client/src/providers/base.ts:12

Inherited from​

BaseProvider.id


label​

readonly label: string

Defined in: packages/client/src/providers/base.ts:13

Inherited from​

BaseProvider.label


locality​

readonly locality: Locality

Defined in: packages/client/src/providers/base.ts:14

Inherited from​

BaseProvider.locality


offers​

readonly offers: readonly ["chat", "embed"]

Defined in: packages/client/src/providers/bridge.ts:33

Methods​

connect()​

connect(): Promise<void>

Defined in: packages/client/src/providers/bridge.ts:77

Open Leuria and wait for the visitor's answer. When Leuria doesn't answer within a few seconds, the provider says it isn't running (the UI offers to get it) and keeps waiting: an app that starts late, or is installed meanwhile, still connects. A new call replaces the last.

Returns​

Promise<void>


createSession()​

createSession(options): Promise<ProviderSession>

Defined in: packages/client/src/providers/bridge.ts:133

Parameters​

options​

SessionOptions

Returns​

Promise<ProviderSession>

Overrides​

BaseProvider.createSession


detect()​

detect(): Promise<void>

Defined in: packages/client/src/providers/bridge.ts:45

Check availability. Cheap and safe to call often.

Returns​

Promise<void>

Overrides​

BaseProvider.detect


disconnect()​

disconnect(): void

Defined in: packages/client/src/providers/bridge.ts:104

Returns​

void


embed()​

embed(__namedParameters): Promise<EmbedResult>

Defined in: packages/client/src/providers/bridge.ts:114

Parameters​

__namedParameters​

EmbedRequest

Returns​

Promise<EmbedResult>


getState()​

getState(): ProviderState

Defined in: packages/client/src/providers/base.ts:20

Current state; the core re-reads it after onChange fires.

Returns​

ProviderState

Inherited from​

BaseProvider.getState


manage()​

manage(): void

Defined in: packages/client/src/providers/bridge.ts:110

Open Leuria on this site's settings: the visitor changes its AI and model there.

Returns​

void


onChange()​

onChange(listener): () => void

Defined in: packages/client/src/providers/base.ts:22

Subscribe to state changes. Returns the unsubscribe function.

Parameters​

listener​

() => void

Returns​

() => void

Inherited from​

BaseProvider.onChange


setState()​

protected setState(patch): void

Defined in: packages/client/src/providers/base.ts:30

Parameters​

patch​

Partial<ProviderState>

Returns​

void

Inherited from​

BaseProvider.setState