BackgroundDownloader.SuccessToastNotification Property

Definition

Namespace:

Windows.Networking.BackgroundTransfer

Gets or sets the ToastNotification that defines the content, associated metadata, and events used in a toast notification to indicate success of a download to the user.

public:
 property ToastNotification ^ SuccessToastNotification { ToastNotification ^ get(); void set(ToastNotification ^ value); };

ToastNotification SuccessToastNotification();

void SuccessToastNotification(ToastNotification value);

public ToastNotification SuccessToastNotification { get; set; }

var toastNotification = backgroundDownloader.successToastNotification;
backgroundDownloader.successToastNotification = toastNotification;

Public Property SuccessToastNotification As ToastNotification

Property Value

ToastNotification

The ToastNotification used to indicate download success.

Remarks

An app that uses Windows.Networking.BackgroundTransfer to communicate through a toast notification must declare that it is Toast capable in the app manifest file. The Toast capable setting is located under the Notifications section of Application tab. Set the Toast capable option to "Yes" so the app can receive toast notifications.

If Toast capable is not enabled in the app manifest, then any toast settings in the Windows.Networking.BackgroundTransfer namespace will be silently ignored and no toasts notifications will be received by the app.

Note

A user can manually disable or enable toast notifications for your app at any time.

For more information on toast notifications, see Sending toast notifications and How to opt in for toast notifications.

See also

• ToastNotification
• How to opt in for toast notifications