RoamingObjectStorageHelper Class

Reference

Definition

Namespace:: Microsoft.Toolkit.Uwp.Helpers

Assembly:: Microsoft.Toolkit.Uwp.dll

Package:: Microsoft.Toolkit.Uwp v6.1.1

Package:: Microsoft.Toolkit.Uwp v7.0.2

Package:: Microsoft.Toolkit.Uwp v7.1.2

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Caution

Package State Roaming will be removed in a futures Windows Update, see https://docs.microsoft.com/windows/deployment/planning/windows-10-deprecated-features for more information.

Store data in the Roaming environment (shared across all user devices).

public class RoamingObjectStorageHelper : Microsoft.Toolkit.Uwp.Helpers.BaseObjectStorageHelper

[System.Obsolete("Package State Roaming will be removed in a futures Windows Update, see https://docs.microsoft.com/windows/deployment/planning/windows-10-deprecated-features for more information.")]
public class RoamingObjectStorageHelper : Microsoft.Toolkit.Uwp.Helpers.BaseObjectStorageHelper

type RoamingObjectStorageHelper = class
    inherit BaseObjectStorageHelper

[<System.Obsolete("Package State Roaming will be removed in a futures Windows Update, see https://docs.microsoft.com/windows/deployment/planning/windows-10-deprecated-features for more information.")>]
type RoamingObjectStorageHelper = class
    inherit BaseObjectStorageHelper

Public Class RoamingObjectStorageHelper
Inherits BaseObjectStorageHelper

Inheritance: Object

BaseObjectStorageHelper
RoamingObjectStorageHelper

Attributes: ObsoleteAttribute

Constructors

RoamingObjectStorageHelper(IObjectSerializer)

Initializes a new instance of the RoamingObjectStorageHelper class, which can read and write data using the provided IObjectSerializer; In 6.1 and older the default Serializer was based on Newtonsoft.Json. To implement an IObjectSerializer based on System.Text.Json, Newtonsoft.Json, or DataContractJsonSerializer see https://aka.ms/wct/storagehelper-migration

Properties

Folder	Gets or sets the storage folder. (Inherited from BaseObjectStorageHelper)
Settings	Gets or sets the settings container. (Inherited from BaseObjectStorageHelper)

Methods

FileExistsAsync(String)	Determines whether a file already exists. (Inherited from BaseObjectStorageHelper)
KeyExists(String)	Determines whether a setting already exists. (Inherited from BaseObjectStorageHelper)
KeyExists(String, String)	Determines whether a setting already exists in composite. (Inherited from BaseObjectStorageHelper)
Read<T>(String, String, T)	Retrieves a single item by its key in composite. (Inherited from BaseObjectStorageHelper)
Read<T>(String, T)	Retrieves a single item by its key. (Inherited from BaseObjectStorageHelper)
ReadFileAsync<T>(String, T)	Retrieves an object from a file. (Inherited from BaseObjectStorageHelper)
Save<T>(String, IDictionary<String,T>)	Saves a group of items by its key in a composite. This method should be considered for objects that do not exceed 8k bytes during the lifetime of the application (refers to SaveFileAsync<T>(String, T) for complex/large objects) and for groups of settings which need to be treated in an atomic way. (Inherited from BaseObjectStorageHelper)
Save<T>(String, T)	Saves a single item by its key. This method should be considered for objects that do not exceed 8k bytes during the lifetime of the application (refers to SaveFileAsync<T>(String, T) for complex/large objects). (Inherited from BaseObjectStorageHelper)
SaveFileAsync<T>(String, T)	Saves an object inside a file. There is no limitation to use this method (refers to Save<T>(String, T) method for simple objects). (Inherited from BaseObjectStorageHelper)

Applies to