NotificationsManager Interface

Provides notifications from this client to others and subscription to their notifications.

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.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

/** @sealed */
export interface NotificationsManager<T extends InternalUtilityTypes.NotificationListeners<T>>

Type Parameters

Parameter	Constraint	Description
T	InternalUtilityTypes.NotificationListeners<T>

Remarks

Create using Notifications(initialSubscriptions) registered to NotificationsWorkspace or StatesWorkspace.

Properties

Property	Alerts	Modifiers	Type	Description
emit	Alpha	readonly	NotificationEmitter<T>	Send notifications to other clients.
events	Alpha	readonly	Listenable<NotificationsManagerEvents>	Events for Notifications manager.
notifications	Alpha	readonly	NotificationListenable<T>	Provides subscription to notifications from other clients.
presence	Alpha	readonly	Presence	Containing Presence

Property Details

emit

Send notifications to other clients.

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

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

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

readonly emit: NotificationEmitter<T>;

Type: NotificationEmitter<T>

events

Events for Notifications manager.

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

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

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

readonly events: Listenable<NotificationsManagerEvents>;

Type: Listenable<NotificationsManagerEvents>

notifications

Provides subscription to notifications from other clients.

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

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

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

readonly notifications: NotificationListenable<T>;

Type: NotificationListenable<T>

presence

Containing Presence

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

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

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

readonly presence: Presence;

Type: Presence