IWidgetProvider.Deactivate(String) メソッド

定義

名前空間:

Microsoft.Windows.Widgets.Providers

ウィジェット ホストがプロバイダーに更新されたコンテンツをアクティブに要求しなくなったことをウィジェット プロバイダーに通知します。

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)

パラメーター

widgetId

String

Platform::String

winrt::hstring

非アクティブ化されているウィジェットの一意識別子。 ウィジェット ID の値は、 によって WidgetManager動的に生成されます。 ウィジェット ID は、ウィジェットが作成された時点からウィジェットが削除されるまで同じままです。 ウィジェット ID は、すべてのウィジェットとすべてのウィジェット プロバイダーで一意の値です。

注釈

メソッドは Activate(WidgetContext) 、ウィジェット ホストがプロバイダーから更新されたコンテンツを受信することに関心があることをウィジェット プロバイダーに通知するために呼び出されます。 これら 2 つのメソッドでは、ウィジェット ホストが最新の内容を表示することに最も関心を持っているウィンドウが定義されています。 ウィジェット プロバイダーは、プッシュ通知への応答など、いつでもウィジェットに更新を送信できますが、バックグラウンド タスクと同様に、最新の内容を提供することと、バッテリーの寿命などのリソースに関する配慮との、バランスを取することが重要です。