WebUICachedFileUpdaterActivatedEventArgs Class

  • Reference

Definition

Namespace:
Windows.UI.WebUI
Edit

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.

public ref class WebUICachedFileUpdaterActivatedEventArgs sealed : ICachedFileUpdaterActivatedEventArgs, IActivatedEventArgsDeferral
public ref class WebUICachedFileUpdaterActivatedEventArgs sealed : IActivatedEventArgsWithUser, ICachedFileUpdaterActivatedEventArgs, IActivatedEventArgsDeferral
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
class WebUICachedFileUpdaterActivatedEventArgs final : ICachedFileUpdaterActivatedEventArgs, IActivatedEventArgsDeferral
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
class WebUICachedFileUpdaterActivatedEventArgs final : IActivatedEventArgsWithUser, ICachedFileUpdaterActivatedEventArgs, IActivatedEventArgsDeferral
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
public sealed class WebUICachedFileUpdaterActivatedEventArgs : ICachedFileUpdaterActivatedEventArgs, IActivatedEventArgsDeferral
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
public sealed class WebUICachedFileUpdaterActivatedEventArgs : IActivatedEventArgsWithUser, ICachedFileUpdaterActivatedEventArgs, IActivatedEventArgsDeferral
Public NotInheritable Class WebUICachedFileUpdaterActivatedEventArgs
Implements IActivatedEventArgsDeferral, ICachedFileUpdaterActivatedEventArgs
Public NotInheritable Class WebUICachedFileUpdaterActivatedEventArgs
Implements IActivatedEventArgsDeferral, IActivatedEventArgsWithUser, ICachedFileUpdaterActivatedEventArgs
Inheritance
Object Platform::Object IInspectable WebUICachedFileUpdaterActivatedEventArgs
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute
Implements
IActivatedEventArgs ICachedFileUpdaterActivatedEventArgs IActivatedEventArgsDeferral IActivatedEventArgsWithUser

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Examples

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

// 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.

Remarks

Learn more about providing updates for files that your app offers in the Quickstart: Providing file services through 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).

Version history

Windows version SDK version Value added
1607 14393 User

Properties

ActivatedOperation

Gets the app activated operation.
CachedFileUpdaterUI

Gets the letterbox UI of the file picker that is displayed when a file needs updates from the app.
Kind

Gets the activation type.
PreviousExecutionState

Gets the execution state of the app before it was activated.
SplashScreen

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.
User

Gets the user that the app was activated for.

Applies to

See also