Skip to main content

IOldestClientObservable Interface

This is to make OldestClientObserver work with either a IContainerRuntime or an IFluidDataStoreRuntime (both expose the relevant API surface and eventing). However, really this info probably shouldn't live on either, since neither is really the source of truth (they are just the only currently-available plumbing options). It's information about the connection, so the real source of truth is lower (at the connection layer).

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluid-experimental/oldest-client-observer/legacy.

For more information about our API support guarantees, see here.

Signature

export interface IOldestClientObservable extends IEventProvider<IOldestClientObservableEvents>

Extends: IEventProvider<IOldestClientObservableEvents>

Properties

Property Alerts Type Description
attachState Alpha AttachState
clientId Alpha string | undefined
connected Alpha boolean

Methods

Method Alerts Return Type Description
getQuorum() Alpha IQuorumClients

Property Details

attachState

This API is provided as an alpha preview and may change without notice.

To use, import via @fluid-experimental/oldest-client-observer/alpha.

For more information about our API support guarantees, see here.

Signature

attachState: AttachState;

Type: AttachState

clientId

This API is provided as an alpha preview and may change without notice.

To use, import via @fluid-experimental/oldest-client-observer/alpha.

For more information about our API support guarantees, see here.

Signature

clientId: string | undefined;

Type: string | undefined

connected

This API is provided as an alpha preview and may change without notice.

To use, import via @fluid-experimental/oldest-client-observer/alpha.

For more information about our API support guarantees, see here.

Signature

connected: boolean;

Type: boolean

Method Details

getQuorum

This API is provided as an alpha preview and may change without notice.

To use, import via @fluid-experimental/oldest-client-observer/alpha.

For more information about our API support guarantees, see here.

Signature

getQuorum(): IQuorumClients;

Returns

Return type: IQuorumClients