CachedFileUpdaterActivatedEventArgs Class

Definition

Namespace:

Windows.ApplicationModel.Activation

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

JavaScript This type appears as WebUICachedFileUpdaterActivatedEventArgs.

public ref class CachedFileUpdaterActivatedEventArgs sealed : IActivatedEventArgsWithUser, ICachedFileUpdaterActivatedEventArgs

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class CachedFileUpdaterActivatedEventArgs final : IActivatedEventArgsWithUser, ICachedFileUpdaterActivatedEventArgs

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class CachedFileUpdaterActivatedEventArgs : IActivatedEventArgsWithUser, ICachedFileUpdaterActivatedEventArgs

Public NotInheritable Class CachedFileUpdaterActivatedEventArgs
Implements IActivatedEventArgsWithUser, ICachedFileUpdaterActivatedEventArgs

Inheritance

Object Platform::Object IInspectable CachedFileUpdaterActivatedEventArgs

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

Implements

IActivatedEventArgs ICachedFileUpdaterActivatedEventArgs 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 activation point.

// CachedFileUpdater activated event handler
protected override void OnCachedFileUpdaterActivated(CachedFileUpdaterActivatedEventArgs args)
{
    var CachedFileUpdaterPage = new SDKTemplate.CachedFileUpdaterPage();
    CachedFileUpdaterPage.Activate(args);
}

// Overloaded method to respond to CachedFileUpdater events
public void Activate(CachedFileUpdaterActivatedEventArgs args)
{
            // Get file picker UI
            cachedFileUpdaterUI = args.CachedFileUpdaterUI;

            cachedFileUpdaterUI.FileUpdateRequested += CachedFileUpdaterUI_FileUpdateRequested;
            cachedFileUpdaterUI.UIRequested += CachedFileUpdaterUI_UIRequested;

            switch (cachedFileUpdaterUI.UpdateTarget)
            {
                case CachedFileTarget.Local:
                    scenarios = new List<Scenario> { new Scenario() { Title = "Get latest version", ClassType = typeof(FilePickerContracts.CachedFileUpdater_Local) } };
                    break;
                case CachedFileTarget.Remote:
                    scenarios = new List<Scenario> { new Scenario() { Title = "Remote file update", ClassType = typeof(FilePickerContracts.CachedFileUpdater_Remote) } };
                    break;
            }

            Window.Current.Activate();
        }

For C#, args for an OnCachedFileUpdaterActivated override on the Application object references a CachedFileUpdaterActivatedEventArgs object. The OnCachedFileUpdaterActivated override is in the App.xaml.cs file and the Activate method is in the CachedFileUpdaterPage.xaml.cs file of the File picker contracts sample.

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.

A CachedFileUpdaterActivatedEventArgs object is passed to the app's activated event handler when the user saves a file that requires content management from the app. This type of activation is indicated by the ActivationKind.CachedFileUpdater value returned by the Kind property.

Apps written in JavaScript must listen for and handle Windows.UI.WebUI.WebUIApplication.activated events.

UWP app using C++, C#, or Visual Basic typically implement activation points by overriding methods of the Application object. The default template app.xaml code-behind files always include an override for OnLaunched, but defining overrides for other activation points such as OnCachedFileUpdaterActivated is up to your app code.

All Application overrides involved in an activation scenario should call Window.Activate in their implementations.

Version history

Windows version	SDK version	Value added
1607	14393	User

Properties

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 a SplashScreen 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.

See also

• ActivationKind
• Windows.Storage.Provider
• Activated
• OnCachedFileUpdaterActivated(CachedFileUpdaterActivatedEventArgs)
• Application
• File picker contracts sample