StorageProviderSyncRootManager StorageProviderSyncRootManager StorageProviderSyncRootManager StorageProviderSyncRootManager Class

Definition

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

Prerelease APIs are identified by a Prerelease label.

[Contains prerelease APIs.]
Provides the ability to register or unregister a Cloud Storage Provider sync root with the operating system.

public : static class StorageProviderSyncRootManagerpublic static class StorageProviderSyncRootManagerPublic Static Class StorageProviderSyncRootManager// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.16257.0)
API contract
Windows.Storage.Provider.CloudFilesContract (introduced v1)

Methods

GetCurrentSyncRoots() GetCurrentSyncRoots() GetCurrentSyncRoots() GetCurrentSyncRoots()

Prerelease. Gets all of the currently registered sync roots.

public : static IVectorView<StorageProviderSyncRootInfo> GetCurrentSyncRoots()public static IReadOnlyList<StorageProviderSyncRootInfo> GetCurrentSyncRoots()Public Static Function GetCurrentSyncRoots() As IReadOnlyList( Of StorageProviderSyncRootInfo )// You can use this method in JavaScript.
Returns
IVectorView<StorageProviderSyncRootInfo> IReadOnlyList<StorageProviderSyncRootInfo> IReadOnlyList<StorageProviderSyncRootInfo> IReadOnlyList<StorageProviderSyncRootInfo>

A collection of currently registered sync roots.

Remarks

This collection can include both legacy sync roots and sync roots registered with SyncRootManager.Register(SyncRootInformation).

GetSyncRootInformationForFolder(IStorageFolder) GetSyncRootInformationForFolder(IStorageFolder) GetSyncRootInformationForFolder(IStorageFolder) GetSyncRootInformationForFolder(IStorageFolder)

Prerelease. Returns SyncRootInformation given a storage folder.

public : static StorageProviderSyncRootInfo GetSyncRootInformationForFolder(IStorageFolder folder)public static StorageProviderSyncRootInfo GetSyncRootInformationForFolder(IStorageFolder folder)Public Static Function GetSyncRootInformationForFolder(folder As IStorageFolder) As StorageProviderSyncRootInfo// You can use this method in JavaScript.
Parameters
folder
IStorageFolder IStorageFolder IStorageFolder IStorageFolder

The storage folder for the sync root.

Returns

GetSyncRootInformationForId(String) GetSyncRootInformationForId(String) GetSyncRootInformationForId(String) GetSyncRootInformationForId(String)

Prerelease. Returns StorageProviderSyncRootInfo given a sync root Id.

public : static StorageProviderSyncRootInfo GetSyncRootInformationForId(PlatForm::String id)public static StorageProviderSyncRootInfo GetSyncRootInformationForId(String id)Public Static Function GetSyncRootInformationForId(id As String) As StorageProviderSyncRootInfo// You can use this method in JavaScript.
Parameters
id
PlatForm::String String String String

A string value of the sync root Id.

Returns

Register(StorageProviderSyncRootInfo) Register(StorageProviderSyncRootInfo) Register(StorageProviderSyncRootInfo) Register(StorageProviderSyncRootInfo)

Prerelease. Registers a sync root with the operating system.

public : static void Register(StorageProviderSyncRootInfo syncRootInformation)public static void Register(StorageProviderSyncRootInfo syncRootInformation)Public Static Function Register(syncRootInformation As StorageProviderSyncRootInfo) As void// You can use this method in JavaScript.
Parameters

Remarks

Multiple sync roots cannot be registered with the same path.

Unregister(String) Unregister(String) Unregister(String) Unregister(String)

Prerelease. Unregisters a sync root from the operating system.

public : static void Unregister(PlatForm::String id)public static void Unregister(String id)Public Static Function Unregister(id As String) As void// You can use this method in JavaScript.
Parameters
id
PlatForm::String String String String

The Id of the sync root to unregister.