Skip to main content

NotificationsWithSubscriptionsConfiguration TypeAlias

Type alias for the return type of Notifications(initialSubscriptions).

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 type NotificationsWithSubscriptionsConfiguration<TSubscriptions extends InternalUtilityTypes.NotificationListenersWithSubscriberSignatures<TSubscriptions>, RegistrationKeyRestrictions extends string = string> = InternalTypes.ManagerFactory<RegistrationKeyRestrictions, InternalTypes.ValueRequiredState<InternalTypes.NotificationType>, NotificationsManager<InternalUtilityTypes.NotificationListenersFromSubscriberSignatures<TSubscriptions>>>;

Type Parameters​

ParameterConstraintDefaultDescription
TSubscriptionsInternalUtilityTypes.NotificationListenersWithSubscriberSignatures<TSubscriptions>
RegistrationKeyRestrictionsstringstringOptional type parameter to constrain allowed registration keys for this Notification within a workspace. Specification is recommended to highlight connection between schema and factory when spread across modules.

Remarks​

Use this type instead of any InternalPresenceTypes that may be revealed from examining factory return type.