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 オブジェクトが 含まれています。

注釈

アプリが Cached File Updater コントラクトに参加している場合は、このクラスを使用して、Windows が FileUpdateRequested イベントを起動してファイルの更新を要求したときに応答します。 FileUpdateRequestedEventArgs を使用して、イベント ハンドラーからこのクラスにアクセスできます。Request プロパティ。 FileUpdateRequested イベントへの応答の一環として、更新の状態を示すために、このクラスの Status プロパティを設定する必要があります。

FileUpdateRequested および FileUpdateRequestedEventArgs で更新要求に応答する方法の詳細を確認してください。

アプリが FileUpdateRequested イベント ハンドラーから戻る前に更新を完了できない場合は、 GetDeferral プロパティを使用して非同期的に更新を完了できます。

プロパティ

ContentId	ファイルのローカル バージョンを対応するリモート バージョンに関連付けるために使用される一意識別子を取得します。
File	更新するファイルのローカル にキャッシュされたコピーを表す StorageFile オブジェクトを取得します。
Status	更新プログラムの状態を取得または設定します。 このプロパティは、 FileUpdateRequested イベントに応答して設定されます。
UserInputNeededMessage	FileUpdateRequest を完了するためにユーザー入力が必要であることを示すメッセージを取得または設定します。

メソッド

GetDeferral()	更新を非同期的に完了するために使用される オブジェクトを取得します。
UpdateLocalFile(IStorageFile)	リモート ファイルを表す新しいバージョンのローカル ファイルを指定します。