FeedResourceRequestedArgs Class

  • Reference

Definition

Namespace:
Microsoft.Windows.Widgets.Feeds.Providers
Edit

Provides data for the FeedResourceRequestedArgs event which is raised when the feed's content requests a resource that matches the web request filter string for a feed in the WebRequestFilter attribute of the Definition element in the provider's package manifest file. For more information, see Feed provider package manifest XML format.

public ref class FeedResourceRequestedArgs sealed
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.Windows.Widgets.WidgetContract, 327680)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class FeedResourceRequestedArgs final
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.Windows.Widgets.WidgetContract), 327680)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class FeedResourceRequestedArgs
Public NotInheritable Class FeedResourceRequestedArgs
Inheritance
Object Platform::Object IInspectable FeedResourceRequestedArgs
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute

Remarks

Feed providers can access the resource request through the FeedResourceRequestedArgs.Request property and set the FeedResourceRequestedArgs.Response property to a FeedResourceResponse that contains a stream to the resource and then return. If the evaluation or the resource is not immediately available, the provider should request a deferral by calling FeedResourceRequestedArgs.GetDeferral, initiate a background task, and complete the deferral when the resource is available.

If the provider returns the OnResourceRequested call without setting the FeedResourceRequestedArgs.Response property, a web fetch will be made. When returning without a FeedResourceResponse, the provider may modify the Headers collection which will then be used by the web fetch.

Properties

FeedDefinitionId

Gets the definition ID of the feed associated with the resource request.
FeedProviderDefinitionId

Gets the definition ID of the feed provider associated with the resource request.
Request

Sets the FeedResourceRequest representing the feed resource request.
Response

Gets or sets the FeedResourceResponse representing the response to the feed resource request.

Methods

GetDeferral()

Informs the system that the resource response task might continue to perform work after the IFeedResourceProvider.OnResourceRequested

Applies to