Interface FederationSession

interface FederationSession {
    federationDoc: Doc;
    federationRoomId: string;
    models: ReadonlyMap<string, CollabSession>;
    presence: Presence;
    projectId: string;
    user: UserIdentity;
    addModel(modelId: string): Promise<CollabSession>;
    dispose(): Promise<void>;
    getRecord(recordId: string): FederationRecord | undefined;
    listRecords(): FederationRecord[];
    modelIds(): string[];
    observeRecords(listener: (records: FederationRecord[]) => void): () => void;
    removeModel(modelId: string): Promise<void>;
    removeRecord(recordId: string): boolean;
    upsertRecord(record: FederationRecord): void;
    whenSynced(): Promise<void>;
}

Index

Properties

federationDoc federationRoomId models presence projectId user

Methods

addModel dispose getRecord listRecords modelIds observeRecords removeModel removeRecord upsertRecord whenSynced

Properties

`Readonly`federationDoc

federationDoc: Doc

`Readonly`federationRoomId

federationRoomId: string

`Readonly`models

models: ReadonlyMap<string, CollabSession>

Per-model sessions keyed by modelId.

`Readonly`presence

presence: Presence

`Readonly`projectId

projectId: string

`Readonly`user

user: UserIdentity

Methods

addModel

addModel(modelId: string): Promise<CollabSession>
Add a model to the session. Idempotent.
Parameters
- modelId: string
Returns Promise<CollabSession>

dispose

dispose(): Promise<void>

Returns Promise<void>

getRecord

getRecord(recordId: string): FederationRecord | undefined
Parameters
- recordId: string
Returns FederationRecord | undefined

listRecords

listRecords(): FederationRecord[]

Returns FederationRecord[]

modelIds

modelIds(): string[]

All loaded model IDs.

Returns string[]

observeRecords

observeRecords(listener: (records: FederationRecord[]) => void): () => void
Parameters
- listener: (records: FederationRecord[]) => void
Returns () => void

removeModel

removeModel(modelId: string): Promise<void>
Remove a model from the session and dispose its resources.
Parameters
- modelId: string
Returns Promise<void>

removeRecord

removeRecord(recordId: string): boolean
Parameters
- recordId: string
Returns boolean

upsertRecord

upsertRecord(record: FederationRecord): void
Parameters
- record: FederationRecord
Returns void

whenSynced

whenSynced(): Promise<void>

Resolves once every loaded session has finished its initial sync.

Returns Promise<void>