WebUICachedFileUpdaterActivatedEventArgs class (Windows)

2 out of 2 rated this helpful - Rate this topic

Provides information about the activated event that fires when the user saves or opens a file that needs updates from the app.

C#/C++/VB: This type appears as CachedFileUpdaterActivatedEventArgs.

Syntax

JavaScript


/* For information about creating or accessing this object, see Remarks. */

Attributes

MarshalingBehaviorAttribute(Standard)
VersionAttribute(NTDDI_WIN8)

Members

The WebUICachedFileUpdaterActivatedEventArgs class has these types of members:

Methods
Properties

Methods

The WebUICachedFileUpdaterActivatedEventArgs class inherits methods from the Object class (C#/VB/C++).

Properties

The WebUICachedFileUpdaterActivatedEventArgs class has these properties.

Property	Access type	Description
ActivatedOperation	Read-only	Gets the app activated operation.
CachedFileUpdaterUI	Read-only	Gets the letterbox UI of the file picker that is displayed when a file needs updates from the app.
Kind	Read-only	Gets the activation type.
PreviousExecutionState	Read-only	Gets the execution state of the app before it was activated.
SplashScreen	Read-only	Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

Remarks

Learn more about providing updates for files that your app offers in the Quickstart: Providing file services through file pickers and in the Windows.Storage.Pickers.Provider namespace reference.

This object is accessed when you implement an event handler for the WinJS.Application.Onactivated or the Windows.UI.WebUI.WebUIApplication.activated events when ActivationKind is cachedFileUpdater.

Note : This class is not agile, which means that you need to consider its threading model and marshaling behavior. For more info, see Threading and Marshaling (C++/CX).

Examples

The File picker contracts sample demonstrates how to respond to a cachedFileUpdater activated event.

JavaScript



// cachedFileUpdater activated event handler
function activated(eventObject) {
        // Identify whether app was launched for cachedFileUpdater
        if (eventObject.detail.kind === Windows.ApplicationModel.Activation.ActivationKind.cachedFileUpdater) {
            // Perform tasks to prepare your app to display its file picker page

            // Get file picker UI
            cachedFileUpdaterUI = eventObject.detail.cachedFileUpdaterUI;

            cachedFileUpdaterUI.addEventListener("fileupdaterequested", onFileUpdateRequest);
            cachedFileUpdaterUI.addEventListener("uirequested", onUIRequested);

            switch (cachedFileUpdaterUI.updateTarget) {
                case Windows.Storage.Provider.CachedFileTarget.local:
                    scenarios = [{ url: "/html/cachedFileUpdaterScenario1.html", title: "Get latest version" }];
                    break;
                case Windows.Storage.Provider.CachedFileTarget.remote:
                    scenarios = [{ url: "/html/cachedFileUpdaterScenario2.html", title: "Remote file update" }];
                    break;
            }
            SdkSample.scenarios = scenarios;
        }
    }

// Register the activated event handler
WinJS.Application.addEventListener("activated", activated, false);

For JavaScript, eventObject contains a webUICachedFileUpdaterActivatedEventArgs object.

Requirements

Minimum supported client	Windows 8 [Windows Store apps only]
Minimum supported server	Windows Server 2012 [Windows Store apps only]
Namespace	Windows.UI.WebUI
Metadata	Windows.winmd

WebUICachedFileUpdaterActivatedEventArgs class