IWidgetProvider.Deactivate(String) Method

Definition

Namespace:

Microsoft.Windows.Widgets.Providers

Notifies the widget provider that the widget host is no longer actively requesting updated content from the provider.

public:
 void Deactivate(Platform::String ^ widgetId);

void Deactivate(winrt::hstring const& widgetId);

public void Deactivate(string widgetId);

function deactivate(widgetId)

Public Sub Deactivate (widgetId As String)

Parameters

widgetId

String

Platform::String

winrt::hstring

The unique identifier of the widget that is being deactivated. The widget ID value is dynamically generated by the WidgetManager. The widget ID remains the same for a widget from the moment of its creation until the moment the Widget is deleted. The widget ID is a unique value across all widgets and all widget providers.

Remarks

The Activate(WidgetContext) method is called to notify the widget provider that the widget host is interested in receiving updated content from the provider. These two methods define a window in which the widget host is most interested in showing the most up-to-date content. Widget providers can send updates to the widget at any time, such as in response to a push notification, but as with any background task, it's important to balance providing up-to-date content with resource concerns like battery life.