Skip to main content

NotificationsWorkspace Interface

NotificationsWorkspace maintains a registry of NotificationsManagers that facilitate messages across client members in a session. \

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 NotificationsWorkspace<TSchema extends NotificationsWorkspaceSchema>

Type Parameters​

Parameter Constraint Description
TSchema NotificationsWorkspaceSchema

Properties​

Property Alerts Modifiers Type Description
notifications Alpha readonly StatesWorkspaceEntries<TSchema> Registry of NotificationsManagers.
presence Alpha readonly PresenceWithNotifications Containing PresenceWithNotifications

Methods​

Method Alerts Return Type Description
add(key, manager) Alpha asserts this is NotificationsWorkspace<TSchema & Record<TKey, InternalTypes.ManagerFactory<TKey, TValue, TManager>>> Registers a new NotificationsManager with the NotificationsWorkspace.

Property Details​

notifications​

Registry of NotificationsManagers.

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

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

Signature​
readonly notifications: StatesWorkspaceEntries<TSchema>;

Type: StatesWorkspaceEntries<TSchema>

presence​

Containing PresenceWithNotifications

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

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

Signature​
readonly presence: PresenceWithNotifications;

Type: PresenceWithNotifications

Method Details​

add​

Registers a new NotificationsManager with the NotificationsWorkspace.

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

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

Signature​
add<TKey extends string, TValue extends InternalTypes.ValueDirectoryOrState<any>, TManager extends NotificationsManager<any>>(key: TKey, manager: InternalTypes.ManagerFactory<TKey, TValue, TManager>): asserts this is NotificationsWorkspace<TSchema & Record<TKey, InternalTypes.ManagerFactory<TKey, TValue, TManager>>>;
Type Parameters​
Parameter Constraint Description
TKey string
TValue InternalTypes.ValueDirectoryOrState<any>
TManager NotificationsManager<any>

Parameters​

Parameter Type Description
key TKey new unique key for the NotificationsManager within the workspace
manager InternalTypes.ManagerFactory<TKey, TValue, TManager> factory for creating a NotificationsManager

Returns​

Return type: asserts this is NotificationsWorkspace<TSchema & Record<TKey, InternalTypes.ManagerFactory<TKey, TValue, TManager>>>