Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(client-presence): SessionClientStatus Docs #22905

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions packages/framework/presence/src/presence.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,17 +31,28 @@ import type { ISubscribable } from "@fluid-experimental/presence/internal/events
export type ClientSessionId = SessionId & { readonly ClientSessionId: "ClientSessionId" };

/**
* The connection status of the {@link ISessionClient}.
* An object containing the possible connection statuses of an {@link ISessionClient}.
*
* @alpha
*/
export const SessionClientStatus = {
/**
* The session client is connected to the delta stream.
* Can send to and receive updates from other session clients.
*/
Connected: "Connected",
/**
* The session client is not connected to the delta stream.
* Cannot send to or receive updates from other session clients.
*/
Disconnected: "Disconnected",
} as const;

/**
* Type for the connection status of the {@link ISessionClient}.
* Represents the connection status of an {@link ISessionClient}.
*
* This type can be either `'Connected'` or `'Disconnected'`, indicating whether
* the session client is currently able to send and receive updates.
*
* @alpha
*/
Expand Down
12 changes: 6 additions & 6 deletions packages/framework/presence/src/systemWorkspace.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ import { assert } from "@fluidframework/core-utils/internal";

import type { ClientConnectionId } from "./baseTypes.js";
import type { InternalTypes } from "./exposedInternalTypes.js";
import {
SessionClientStatus,
type ClientSessionId,
type IPresence,
type ISessionClient,
type PresenceEvents,
import type {
ClientSessionId,
IPresence,
ISessionClient,
PresenceEvents,
} from "./presence.js";
import { SessionClientStatus } from "./presence.js";
import type { PresenceStatesInternal } from "./presenceStates.js";
import type { PresenceStates, PresenceStatesSchema } from "./types.js";

Expand Down
Loading