ToastDismissalReason Enum

Definition

Namespace:

Windows.UI.Notifications

Specifies the reason that a toast notification is no longer being shown. Used with ToastDismissedEventArgs.Reason.

public enum class ToastDismissalReason

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
enum class ToastDismissalReason

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public enum ToastDismissalReason

var value = Windows.UI.Notifications.ToastDismissalReason.userCanceled

Public Enum ToastDismissalReason

Inheritance

Enum

ToastDismissalReason

Attributes

ContractVersionAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Fields

Name	Value	Description
UserCanceled	0	The user dismissed the toast notification.
ApplicationHidden	1	The app explicitly hid the toast notification by calling the ToastNotifier.hide method.
TimedOut	2	The toast notification had been shown for the maximum allowed time and was faded out. The maximum time to show a toast notification is 7 seconds except in the case of long-duration toasts, in which case it is 25 seconds.

See also

• Reason
• Toast notifications sample
• Sending toast notifications from desktop apps sample
• Toast XML schema
• Toast notification overview
• Quickstart: Sending a toast notification
• Quickstart: Sending a toast push notification
• Quickstart: Sending a toast notification from the desktop
• Guidelines and checklist for toast notifications
• How to handle activation from a toast notification
• How to opt in for toast notifications
• How to schedule a toast notification
• How to enable desktop toast notifications through an AppUserModelID
• The toast template catalog
• Toast audio options