ToastNotificationHistory.Remove Method

Definition

Namespace:

Windows.UI.Notifications

Overloads

Remove(String)	Removes an individual toast, with the specified tag label, from action center.
Remove(String, String)	Removes a toast notification from the action using the notification's tag and group labels.
Remove(String, String, String)	Removes an individual toast notification from action center, identified by the combination of tag label, group label and app ID.

Remove(String)

Removes an individual toast, with the specified tag label, from action center.

public:
 virtual void Remove(Platform::String ^ tag) = Remove;

/// [Windows.Foundation.Metadata.Overload("Remove")]
void Remove(winrt::hstring const& tag);

[Windows.Foundation.Metadata.Overload("Remove")]
public void Remove(string tag);

function remove(tag)

Public Sub Remove (tag As String)

Parameters

tag

String

Platform::String

winrt::hstring

The tag label of the toast notification to be removed.

Attributes

OverloadAttribute

Remarks

You should use this overload to remove notifications when your app's toast notification categorization system was built using only tags.

See also

• Remove(String, String, String)
• Remove(String, String)

Remove(String, String)

Removes a toast notification from the action using the notification's tag and group labels.

public:
 virtual void Remove(Platform::String ^ tag, Platform::String ^ group) = Remove;

/// [Windows.Foundation.Metadata.Overload("RemoveGroupedTag")]
void Remove(winrt::hstring const& tag, winrt::hstring const& group);

[Windows.Foundation.Metadata.Overload("RemoveGroupedTag")]
public void Remove(string tag, string group);

function remove(tag, group)

Public Sub Remove (tag As String, group As String)

Parameters

tag

String

Platform::String

winrt::hstring

The tag label of the toast notification to be removed.

group

String

Platform::String

winrt::hstring

The group label of the toast notification to be removed.

Attributes

OverloadAttribute

Remarks

You should use this overload to remove notifications when your app's toast notification categorization system was built using tags and groups.

See also

• Remove(String, String, String)
• Remove(String)

Remove(String, String, String)

Removes an individual toast notification from action center, identified by the combination of tag label, group label and app ID.

public:
 virtual void Remove(Platform::String ^ tag, Platform::String ^ group, Platform::String ^ applicationId) = Remove;

/// [Windows.Foundation.Metadata.Overload("RemoveGroupedTagWithId")]
void Remove(winrt::hstring const& tag, winrt::hstring const& group, winrt::hstring const& applicationId);

[Windows.Foundation.Metadata.Overload("RemoveGroupedTagWithId")]
public void Remove(string tag, string group, string applicationId);

function remove(tag, group, applicationId)

Public Sub Remove (tag As String, group As String, applicationId As String)

Parameters

tag

String

Platform::String

winrt::hstring

The tag label of the toast notification to be removed.

group

String

Platform::String

winrt::hstring

The group label of the toast notification to be removed.

applicationId

String

Platform::String

winrt::hstring

The app ID of the app that sent the specified toast notification. This app must be part of the same app package as the app making this remove request.

Attributes

OverloadAttribute

Remarks

You should use this overload to remove notifications for a specific app in your app package, as specified by the applicationId parameter. If your app only uses tags, you can pass in an empty string for the group parameter.

See also

• Remove(String, String)
• Remove(String)