@fluidframework/presence Package

Package for client presence within a connected session.

See README.md for an overview of the package.

Interfaces

Interface	Alerts	Modifiers	Description
Attendee		sealed	A client within a Fluid session (period of container connectivity to service).
AttendeesEvents		sealed	Events from attendees.
BroadcastControls		sealed	Common controls for States objects.
BroadcastControlSettings			Value set to configure BroadcastControls.
Latest		sealed	State that provides the latest known value from this client to others and read access to their values. All participant clients must provide a value.
LatestArguments			Arguments that are passed to the @fluidframework/presence#StateFactory.latest function to create a Latest State object.
LatestArgumentsRaw			Arguments that are passed to the @fluidframework/presence#StateFactory.latest function to create a LatestRaw State object.
LatestClientData		sealed	State of a specific Attendee's value and its metadata.
LatestData		sealed	State of a value and its metadata.
LatestEvents		sealed	Events from LatestRaw.
LatestFactory		sealed	Factory for creating a Latest or LatestRaw State object.
LatestMap		sealed	State that provides a Map of latest known values from this client to others and read access to their values. Entries in the map may vary over time and by client, but all values are expected to be of the same type, which may be a union type.
LatestMapArguments			Arguments that are passed to the StateFactory.latestMap function.
LatestMapArgumentsRaw			Arguments that are passed to the StateFactory.latestMap function.
LatestMapClientData		sealed	Collection of latest known values for a specific Attendee.
LatestMapEvents		sealed	Events from LatestMapRaw.
LatestMapFactory		sealed	Factory for creating a LatestMap or LatestMapRaw State object.
LatestMapItemRemovedClientData		sealed	Identifier and metadata for a removed item.
LatestMapItemUpdatedClientData		sealed	State of a single item value, its key, and its metadata.
LatestMetadata		sealed	Metadata for the value state.
NotificationEmitter	Alpha	sealed	Interface for a notification emitter that can send typed notification to other clients.
NotificationListenable	Alpha	sealed	An object which allows the registration of listeners so that subscribers can be notified when a notification happens.
NotificationsManager	Alpha	sealed	Provides notifications from this client to others and subscription to their notifications.
NotificationsManagerEvents	Alpha	sealed
NotificationsWorkspace	Alpha	sealed	NotificationsWorkspace maintains a registry of NotificationsManagers that facilitate messages across client members in a session.
Presence		sealed	Provides top-level access to Presence feature set including known Attendees within a session and their custom states kept under StatesWorkspaces.
PresenceEvents		sealed	Events from Presence.
PresenceWithNotifications	Alpha	sealed	Provides top-level access to Presence feature set including known Attendees within a session and their custom states and notifications kept under StatesWorkspaces and NotificationsWorkspaces.
ProxiedValueAccessor	System		Represents a value that is accessed via a function call, which may result in no value.
RawValueAccessor	System		Represents a value that is accessed directly.
StateMap		sealed	Map of local client's values. Modifications are transmitted to all other connected clients.
StatesWorkspace		sealed	StatesWorkspace maintains a registry of State objects that all share and provide access to presence state values across client members in a session. State objects offer variations on how to manage states, but all share same principle that each client's state is independent and may only be updated by originating client.

Types

TypeAlias	Alerts	Modifiers	Description
Accessor	System		Utility type that conditionally represents an accessor type based on the base accessor type.
AttendeeId			A Fluid client session identifier.
AttendeeStatus			Represents the connection status of an Attendee. This type can be either 'Connected' or 'Disconnected', indicating whether the attendee is currently connected to the Fluid service. When 'Disconnected': - State changes are kept locally and communicated to others upon reconnect. - Notification requests are discarded (silently).
ClientConnectionId			A Fluid client connection identifier.
KeySchemaValidator			A validator function that can optionally be provided to do runtime validation of the custom key listed in a LatestMap.
LatestConfiguration		sealed	Type alias for the return type of LatestFactory when called with LatestArguments.
LatestMapConfiguration		sealed	Type alias for the return type of LatestMapFactory when called with LatestMapArguments.
LatestMapRaw		sealed	State that provides a Map of latest known values from this client to others and read access to their values. Entries in the map may vary over time and by client, but all values are expected to be of the same type, which may be a union type.
LatestMapRawConfiguration		sealed	Type alias for the return type of LatestMapFactory when called with LatestMapArgumentsRaw.
LatestMapRawEvents		sealed	Events from LatestMapRaw.
LatestRaw		sealed	State that provides the latest known value from this client to others and read access to their values. All participant clients must provide a value.
LatestRawConfiguration		sealed	Type alias for the return type of LatestFactory when called with LatestArgumentsRaw.
LatestRawEvents		sealed	Events from LatestRaw.
NotificationsConfiguration	Alpha	sealed	Type alias for the return type of Notifications(initialSubscriptions).
NotificationSubscriberSignatures	Alpha	sealed	Record of notification subscription signatures transformed from listener emit signatures.
NotificationsWithSubscriptionsConfiguration	Alpha	sealed	Type alias for the return type of Notifications(initialSubscriptions).
NotificationsWorkspaceSchema	Alpha		Schema for a NotificationsWorkspace workspace. Keys of schema are the keys of the NotificationsWorkspace providing access to NotificationsManagers.
StateSchemaValidator			A validator function that can optionally be provided to do runtime validation of the custom data stored in a presence workspace and managed by a state object.
StatesWorkspaceEntries		sealed	Map of State objects registered with StatesWorkspace.
StatesWorkspaceEntry			Single entry in StatesWorkspaceSchema or NotificationsWorkspaceSchema.
StatesWorkspaceSchema			Schema for a StatesWorkspace workspace. Keys of schema are the keys of the StatesWorkspace providing access to State objects.
ValueAccessor	System		Union of possible accessor types for a value.
WorkspaceAddress			Unique address within a session.

Functions

Function	Alerts	Return Type	Description
getPresence(fluidContainer)	Deprecated, Beta	Presence	Acquire a Presence from a Fluid Container
getPresenceFromDataStoreContext(context)	Legacy	Presence	Get Presence from a Fluid Data Store Context
Notifications(initialSubscriptions)	Alpha	NotificationsConfiguration<T, Key>	Factory for creating a @fluid-internal/presence-definitions#NotificationsManager.
Notifications(initialSubscriptions)	Alpha	NotificationsWithSubscriptionsConfiguration<TSubscriptions, Key>	Factory for creating a @fluid-internal/presence-definitions#NotificationsManager.

Variables

Variable	Modifiers	Type	Description
AttendeeStatus	readonly	{ readonly Connected: "Connected"; readonly Disconnected: "Disconnected"; }	The connection status of the Attendee.
StateFactory	readonly	{ readonly latest: import("@fluid-internal/presence-definitions").LatestFactory; readonly latestMap: import("@fluid-internal/presence-definitions").LatestMapFactory; }	Factory for creating presence State objects.

Namespaces

Namespace	Alerts	Description
InternalPresenceTypes	System	Collection of value types that are not intended to be used/imported directly outside of this package.
InternalPresenceUtilityTypes	System	Collection of utility types that are not intended to be used/imported directly outside of this package.

Function Details

getPresence

Acquire a Presence from a Fluid Container

This API is deprecated and will be removed in a future release.

Import from fluid-framework instead. This export will be removed in the 2.110.0 release. See https://github.com/microsoft/FluidFramework/issues/26397

This API is provided as a beta preview and may change without notice.

To use, import via @fluidframework/presence/beta.

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

Signature

getPresence: (fluidContainer: IFluidContainer) => Presence

Parameters

Parameter	Type	Description
fluidContainer	IFluidContainer	Fluid Container to acquire the map from

Returns

the Presence

Return type: Presence

getPresenceFromDataStoreContext

Get Presence from a Fluid Data Store Context

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

To use, import via @fluidframework/presence/legacy.

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

Signature

export declare function getPresenceFromDataStoreContext(context: IFluidDataStoreContext): Presence;

Parameters

Parameter	Type	Description
context	IFluidDataStoreContext

Returns

Return type: Presence

Notifications

Factory for creating a @fluid-internal/presence-definitions#NotificationsManager.

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

To use, import via @fluidframework/presence/alpha.

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

Signature

export declare function Notifications<T extends InternalPresenceUtilityTypes.NotificationListeners<T>, Key extends string = string>(initialSubscriptions: Partial<NotificationSubscriberSignatures<T>>): NotificationsConfiguration<T, Key>;

Type Parameters

Parameter	Constraint	Default	Description
T	InternalPresenceUtilityTypes.NotificationListeners<T>
Key	string	string

Parameters

Parameter	Type	Description
initialSubscriptions	Partial<NotificationSubscriberSignatures<T>>

Returns

Return type: NotificationsConfiguration<T, Key>

Notifications

Factory for creating a @fluid-internal/presence-definitions#NotificationsManager.

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

To use, import via @fluidframework/presence/alpha.

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

Signature

export declare function Notifications<TSubscriptions extends InternalPresenceUtilityTypes.NotificationListenersWithSubscriberSignatures<TSubscriptions>, Key extends string = string>(initialSubscriptions: Partial<TSubscriptions>): NotificationsWithSubscriptionsConfiguration<TSubscriptions, Key>;

Type Parameters

Parameter	Constraint	Default	Description
TSubscriptions	InternalPresenceUtilityTypes.NotificationListenersWithSubscriberSignatures<TSubscriptions>
Key	string	string

Parameters

Parameter	Type	Description
initialSubscriptions	Partial<TSubscriptions>

Returns

Return type: NotificationsWithSubscriptionsConfiguration<TSubscriptions, Key>

Variable Details

AttendeeStatus

The connection status of the Attendee.

Signature

AttendeeStatus: {
    readonly Connected: "Connected";
    readonly Disconnected: "Disconnected";
}

Type: { readonly Connected: "Connected"; readonly Disconnected: "Disconnected"; }

StateFactory

Factory for creating presence State objects.

Signature

StateFactory: {
    readonly latest: import("@fluid-internal/presence-definitions").LatestFactory;
    readonly latestMap: import("@fluid-internal/presence-definitions").LatestMapFactory;
}

Type: { readonly latest: import("@fluid-internal/presence-definitions").LatestFactory; readonly latestMap: import("@fluid-internal/presence-definitions").LatestMapFactory; }

Remarks

Use latest to create a LatestRaw State object. Use latestMap to create a LatestMapRaw State object.