FileUpdateRequest 类

定义

命名空间:

Windows.Storage.Provider

提供有关请求的文件更新的信息，以便应用可以完成请求。

public ref class FileUpdateRequest sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
class FileUpdateRequest final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public sealed class FileUpdateRequest

Public NotInheritable Class FileUpdateRequest

继承

Object Platform::Object IInspectable FileUpdateRequest

属性

ContractVersionAttribute

Windows 要求

设备系列	Windows 10 (在 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox 中引入)
API contract	Windows.Foundation.UniversalApiContract (在 v1.0 中引入)

示例

文件选取器协定示例演示如何响应 FileUpdateRequested 事件，包括如何使用 Request 获取 FileUpdateRequest。

// Event handler
void CachedFileUpdaterUI_FileUpdateRequested(CachedFileUpdaterUI sender, FileUpdateRequestedEventArgs args)
{
    fileUpdateRequest = args.Request;
    fileUpdateRequestDeferral = fileUpdateRequest.GetDeferral();
    switch (cachedFileUpdaterUI.UIStatus)
    {
        case UIStatus.Hidden:
            fileUpdateRequest.Status = FileUpdateStatus.UserInputNeeded;
            fileUpdateRequestDeferral.Complete();
            break;
        case UIStatus.Visible:
            break;
        case UIStatus.Unavailable:
            fileUpdateRequest.Status = FileUpdateStatus.Failed;
            fileUpdateRequestDeferral.Complete();
            break;
    }
}

// Register for the event
cachedFileUpdaterUI.FileUpdateRequested += CachedFileUpdaterUI_FileUpdateRequested;

args 包含 FileUpdateRequestedEventArgs 对象。

注解

如果你的应用参与缓存文件更新程序合约，请使用此类在 Windows 触发 FileUpdateRequested 事件以请求文件更新时做出响应。 可以使用 FileUpdateRequestedEventArgs 从事件处理程序访问此类。请求 属性。 作为对 FileUpdateRequested 事件的响应的一部分，必须设置此类的 Status 属性以指示更新的状态。

在 FileUpdateRequested 和 FileUpdateRequestedEventArgs 中详细了解如何响应更新请求。

如果你的应用在从 FileUpdateRequested 事件处理程序返回之前无法完成更新，则可以使用 GetDeferral 属性异步完成更新。

属性

ContentId	获取用于将文件的本地版本与相应的远程版本关联的唯一标识符。
File	获取一个 StorageFile 对象，该对象代表要更新的文件的本地缓存副本。
Status	获取或设置更新的状态。 设置此属性以响应 FileUpdateRequested 事件。
UserInputNeededMessage	获取或设置一条消息给用户，指示需要用户输入才能完成 FileUpdateRequest。

方法

GetDeferral()	获取用于异步完成更新的对象。
UpdateLocalFile(IStorageFile)	提供本地文件的新版本来表示远程文件。