Web​UI​Cached​File​Updater​Activated​Event​Args Web​UI​Cached​File​Updater​Activated​Event​Args Web​UI​Cached​File​Updater​Activated​Event​Args Class

Definition

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 : sealed class WebUICachedFileUpdaterActivatedEventArgs : IActivatedEventArgs, IActivatedEventArgsWithUser, ICachedFileUpdaterActivatedEventArgs, IActivatedEventArgsDeferralpublic sealed class WebUICachedFileUpdaterActivatedEventArgs : IActivatedEventArgs, IActivatedEventArgsWithUser, ICachedFileUpdaterActivatedEventArgs, IActivatedEventArgsDeferralPublic NotInheritable Class WebUICachedFileUpdaterActivatedEventArgs Implements IActivatedEventArgs, IActivatedEventArgsWithUser, ICachedFileUpdaterActivatedEventArgs, IActivatedEventArgsDeferral
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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)

.

Properties

ActivatedOperation ActivatedOperation ActivatedOperation

Gets the app activated operation.

public : ActivatedOperation ActivatedOperation { get; }public ActivatedOperation ActivatedOperation { get; }Public ReadOnly Property ActivatedOperation As ActivatedOperation
Value
ActivatedOperation ActivatedOperation ActivatedOperation

The activation operation.

Attributes

CachedFileUpdaterUI CachedFileUpdaterUI CachedFileUpdaterUI

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

public : CachedFileUpdaterUI CachedFileUpdaterUI { get; }public CachedFileUpdaterUI CachedFileUpdaterUI { get; }Public ReadOnly Property CachedFileUpdaterUI As CachedFileUpdaterUI
Value
CachedFileUpdaterUI CachedFileUpdaterUI CachedFileUpdaterUI

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

Attributes

Kind Kind Kind

Gets the activation type.

public : ActivationKind Kind { get; }public ActivationKind Kind { get; }Public ReadOnly Property Kind As ActivationKind
Attributes

PreviousExecutionState PreviousExecutionState PreviousExecutionState

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

public : ApplicationExecutionState PreviousExecutionState { get; }public ApplicationExecutionState PreviousExecutionState { get; }Public ReadOnly Property PreviousExecutionState As ApplicationExecutionState
Attributes

SplashScreen SplashScreen SplashScreen

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

public : SplashScreen SplashScreen { get; }public SplashScreen SplashScreen { get; }Public ReadOnly Property SplashScreen As SplashScreen
Value
SplashScreen SplashScreen SplashScreen

The object that provides splash screen information.

Attributes

Examples

The Splash screen sample demonstrates how to retrieve a splashScreen object in its activated event handler, if the app was launched:


// Identify and respond to all app activated events.
WinJS.Application.onactivated = function (eventObject) {

    // App was launched
    if (eventObject.detail.kind === Windows.ApplicationModel.Activation.ActivationKind.launch) {
        // Retrieve splash screen object
        splash = eventObject.detail.splashScreen;

        // Add code get image coordinates or listen for the dismissed event

        WinJS.UI.processAll();
    }
    // Add code to respond to other activated event types
};

In the sample, eventObject is an object provides information about the activated event. In the case of a ActivationKind.launch activated event, the eventObject is a WebUILaunchActivatedEventArgs object.

User User User

Gets the user that the app was activated for.

public : User User { get; }public User User { get; }Public ReadOnly Property User As User
Value
User User User

The user that the app was activated for.

Attributes
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Remarks

This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for.

This property returns null when a multi-user application is activated with no specific user context.

Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials.

See Also