NotificationsWorkspace Interface
NotificationsWorkspace maintains a registry of NotificationsManagers that facilitate messages across client members in a session.
To use, import via @fluidframework/presence/alpha.
For more information about our API support guarantees, see here.
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 Partial<NotificationsWorkspaceSchema<TSchemaKeys>>, TSchemaKeys extends string & keyof TSchema = string & keyof TSchema>
Type Parameters
| Parameter | Constraint | Default | Description |
|---|---|---|---|
| TSchema | Partial<NotificationsWorkspaceSchema<TSchemaKeys>> | ||
| TSchemaKeys | string & keyof TSchema | string & keyof TSchema |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| notifications | Alpha | readonly | StatesWorkspaceEntries<TSchema, TSchemaKeys> | 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.
For more information about our API support guarantees, see here.
Signature
readonly notifications: StatesWorkspaceEntries<TSchema, TSchemaKeys>;
Type: StatesWorkspaceEntries<TSchema, TSchemaKeys>
presence
Containing PresenceWithNotifications
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.
For more information about our API support guarantees, see here.
Signature
add<TKey extends string, TValue extends InternalTypes.ValueDirectoryOrState<unknown>, TManager extends NotificationsManager<InternalUtilityTypes.NotificationListeners<unknown>>>(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<unknown> | |
| TManager | NotificationsManager<InternalUtilityTypes.NotificationListeners<unknown>> |
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>>>