CachedFileUpdaterTriggerDetails
CachedFileUpdaterTriggerDetails
CachedFileUpdaterTriggerDetails
CachedFileUpdaterTriggerDetails
Class
Definition
Provides details about the cached file operation that invoked the trigger.
public : sealed class CachedFileUpdaterTriggerDetails : ICachedFileUpdaterTriggerDetailspublic sealed class CachedFileUpdaterTriggerDetails : ICachedFileUpdaterTriggerDetailsPublic NotInheritable Class CachedFileUpdaterTriggerDetails Implements ICachedFileUpdaterTriggerDetails// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Remarks
Note
Obtain an instance of this class from an object that implements Windows.ApplicationModel.Background.IBackgroundTaskInstance.TriggerDetails
Properties
CanRequestUserInput CanRequestUserInput CanRequestUserInput CanRequestUserInput
Gets whether the system can display UI allowing the user to launch provider app in response to the cached file updater trigger.
public : PlatForm::Boolean CanRequestUserInput { get; }public bool CanRequestUserInput { get; }Public ReadOnly Property CanRequestUserInput As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
Whether the system can display UI allowing the user to launch provider app in response to the cached file updater trigger.
Remarks
The Cached File Updater pattern allows the provider app to specify that user input is needed to complete the cached file update by setting the Status property of the associated FileUpdateRequest to UserInputNeeded. It is possible that the system may not be able to show UI to the user during the background task, if the app that updated the file is not currently running in the foreground, for example. In this case, CanRequestUserInput will be false. So, you should check this value before requesting for the system to show UI. Setting the FileUpdateRequest status to UserInputNeeded will throw an exception if CanRequestUserInput is false.
UpdateRequest UpdateRequest UpdateRequest UpdateRequest
Gets the FileUpdateRequest object associated with the cached file update.
public : FileUpdateRequest UpdateRequest { get; }public FileUpdateRequest UpdateRequest { get; }Public ReadOnly Property UpdateRequest As FileUpdateRequest// You can use this property in JavaScript.
The FileUpdateRequest object associated with the cached file update.
UpdateTarget UpdateTarget UpdateTarget UpdateTarget
Gets the CachedFileTarget object associated with cached file update that indicates whether the local or remote file should be updated.
public : CachedFileTarget UpdateTarget { get; }public CachedFileTarget UpdateTarget { get; }Public ReadOnly Property UpdateTarget As CachedFileTarget// You can use this property in JavaScript.
The CachedFileTarget object associated with cached file update that indicates whether the local or remote file should be updated.