ActiveNotification interface

Package:

@azure/communication-react

Active notifications to be shown via NotificationStack.

Properties

ariaLive	Aria-live property for the notification.
autoDismiss	If set, notification will automatically dismiss after 5 seconds
onClickPrimaryButton	Callback called when the primary button inside notification bar is clicked.
onClickSecondaryButton	Callback called when the primary button inside notification bar is clicked.
onDismiss	Callback called when the notification is dismissed.
timestamp	The latest timestamp when this notification was observed. When available, this is used to track notifications that have already been seen and dismissed by the user.
type	Type of error that is active.

Property Details

ariaLive

Aria-live property for the notification.

ariaLive?: "assertive" | "off" | "polite"

Property Value

"assertive" | "off" | "polite"

autoDismiss

If set, notification will automatically dismiss after 5 seconds

autoDismiss?: boolean

Property Value

boolean

onClickPrimaryButton

Callback called when the primary button inside notification bar is clicked.

onClickPrimaryButton?: () => void

Property Value

() => void

onClickSecondaryButton

Callback called when the primary button inside notification bar is clicked.

onClickSecondaryButton?: () => void

Property Value

() => void

onDismiss

Callback called when the notification is dismissed.

onDismiss?: () => void

Property Value

() => void

timestamp

The latest timestamp when this notification was observed.

When available, this is used to track notifications that have already been seen and dismissed by the user.

timestamp?: Date

Property Value

Date

type

Type of error that is active.

type: keyof NotificationStackStrings

Property Value

keyof NotificationStackStrings