Microsoft.Windows.Widgets.Providers Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provides APIs for implementing a widget provider for Windows Widgets.
Classes
WidgetActionInvokedArgs |
Provides data for the Microsoft.Windows.Widgets.Providers.IWidgetProvider.OnActionInvoked callback, which is raised when an action is invoked on a widget, such as the user clicking on a button. |
WidgetAnalyticsInfoReportedArgs |
Provides data for the OnAnalyticsInfoReported) event which is raised when the widget host reports analytics data associated with a user interaction with a widget. |
WidgetContext |
Provides information about the configuration of a widget within the widget host. |
WidgetContextChangedArgs |
Provides data for the Microsoft.Windows.Widgets.Providers.IWidgetProvider.OnWidgetContextChanged callback. |
WidgetCustomizationRequestedArgs |
Provides data for the OnCustomizationRequested) event which is raised when the user has requested widget customization through the widget host UI. |
WidgetErrorInfoReportedArgs |
Provides data for the OnErrorInfoReported) event which is raised when the widget host reports a widget error. |
WidgetInfo |
Contains status information for a widget, including the visual template, data template, custom state, the last update time, and context information from the widget host. |
WidgetManager |
Provides methods for querying, updating, and deleting widgets. |
WidgetMessageReceivedArgs |
Provides data for the IWidgetProviderMessage.OnMessageReceived event which is raised when the widget's content posts a message using the window.chrome.webview.postMessage JavaScript method. |
WidgetResourceRequest |
Represents a resource request received through an implementation of IWidgetResourceProvider.OnResourceRequested. |
WidgetResourceRequestedArgs |
Provides data for the IWidgetResourceProvider.OnResourceRequested event which is raised when the widget's content requests a resource that matches the web request filter string for a widget in the WebRequestFilter attribute of the Definition element in the provider's package manifest file. For more information, see Widget provider package manifest XML format. |
WidgetResourceResponse |
Represents a response to a resource request received through an implementation of IWidgetResourceProvider.OnResourceRequested. |
WidgetUpdateRequestOptions |
Provides data for calls to Microsoft.Windows.Widgets.Providers.WidgetManager.UpdateWidget. |
Interfaces
IWidgetManager |
The interface that is implemented by the WidgetManager class, which provides methods for querying, updating and deleting widgets. |
IWidgetManager2 |
An interface that is implemented by the WidgetManager class, extending the functionality introduced with the IWidgetManager interface. |
IWidgetProvider |
This interface is implemented by Windows Widget providers to receive callbacks from the widget host for widget lifetime events. |
IWidgetProvider2 |
This interface is implemented by Windows widget providers to receive callbacks from the widget host for widget customization events. |
IWidgetProviderAnalytics |
This optional interface can be implemented by Windows widget providers to receive callbacks from the widget host for widget analytics events. |
IWidgetProviderErrors |
This interface is implemented by Windows widget providers to receive callbacks from the widget host for widget errors. |
IWidgetProviderMessage |
This optional interface can be implemented by a widget provider to receive string messages from the widget's web content that has been posted using the window.chrome.webview.postMessage JavaScript method. |
IWidgetResourceProvider |
This optional interface can be implemented by a widget provider to monitor, provide, or alter resources that are requested by the widget web content. |
Remarks
IWidgetProvider is the interface that must be implemented by widget providers in order to receive callback notifications for widget lifecycle events. This interface must be implemented as an Out-of-process COM Server.
The WidgetManager class provides methods for updating, querying, and deleting widgets.