NotificationsManager Interface
Provides notifications from this client to others and subscription to their notifications.
To use, import via @fluidframework/presence/alpha.
For more information about our API support guarantees, see here.
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.
For more information about our API support guarantees, see here.
Signature
readonly emit: NotificationEmitter<T>;
Type: NotificationEmitter<T>
events
Events for Notifications manager.
For more information about our API support guarantees, see here.
Signature
readonly events: Listenable<NotificationsManagerEvents>;
Type: Listenable<NotificationsManagerEvents>
notifications
Provides subscription to notifications from other clients.
For more information about our API support guarantees, see here.
Signature
readonly notifications: NotificationListenable<T>;
Type: NotificationListenable<T>
presence
Containing Presence
For more information about our API support guarantees, see here.
Signature
readonly presence: Presence;
Type: Presence