StorageProviderSyncRootInfo
StorageProviderSyncRootInfo
StorageProviderSyncRootInfo
StorageProviderSyncRootInfo
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.]
Contains the properties of a Cloud Storage Provider's sync root to be registered with the operating system.
public : sealed class StorageProviderSyncRootInfo : IStorageProviderSyncRootInfopublic sealed class StorageProviderSyncRootInfo : IStorageProviderSyncRootInfoPublic NotInheritable Class StorageProviderSyncRootInfo Implements IStorageProviderSyncRootInfo// You can use this class in JavaScript.
- Attributes
| Device family |
Windows Desktop Extension SDK (introduced v10.0.16257.0)
|
| API contract |
Windows.Storage.Provider.CloudFilesContract (introduced v1)
|
Constructors
StorageProviderSyncRootInfo() StorageProviderSyncRootInfo() StorageProviderSyncRootInfo() StorageProviderSyncRootInfo()
Prerelease. A StorageProviderSyncRootInfo default constructor.
public : StorageProviderSyncRootInfo()public StorageProviderSyncRootInfo()Public Sub New()// You can use this method in JavaScript.
Properties
AllowPinning AllowPinning AllowPinning AllowPinning
Prerelease. Enables or disables the ability for files to be made available offline.
public : PlatForm::Boolean AllowPinning { get; set; }public bool AllowPinning { get; set; }Public ReadWrite Property AllowPinning As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if pinning is enabled; False otherwise
Remarks
Pinning refers to a file being made available offline.
Context Context Context Context
Prerelease. Contains the sync root identity information.
public : IBuffer Context { get; set; }public IBuffer Context { get; set; }Public ReadWrite Property Context As IBuffer// You can use this property in JavaScript.
DisplayNameResource DisplayNameResource DisplayNameResource DisplayNameResource
Prerelease. An optional display name that maps to the existing sync root registration.
public : PlatForm::String DisplayNameResource { get; set; }public string DisplayNameResource { get; set; }Public ReadWrite Property DisplayNameResource As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The display name.
HydrationPolicy HydrationPolicy HydrationPolicy HydrationPolicy
Prerelease. The hydration policy of the sync root registration.
public : HydrationPolicy HydrationPolicy { get; set; }public HydrationPolicy HydrationPolicy { get; set; }Public ReadWrite Property HydrationPolicy As HydrationPolicy// You can use this property in JavaScript.
A hydration policy enum value.
HydrationPolicyModifier HydrationPolicyModifier HydrationPolicyModifier HydrationPolicyModifier
Prerelease. The hydration policy modifier of the sync root registration.
public : HydrationPolicyModifier HydrationPolicyModifier { get; set; }public HydrationPolicyModifier HydrationPolicyModifier { get; set; }Public ReadWrite Property HydrationPolicyModifier As HydrationPolicyModifier// You can use this property in JavaScript.
- Value
- HydrationPolicyModifier HydrationPolicyModifier HydrationPolicyModifier HydrationPolicyModifier
A hydration policy modifier enum value.
IconResource IconResource IconResource IconResource
Prerelease. A path to an icon resource for the custom state of a file or folder.
public : PlatForm::String IconResource { get; set; }public string IconResource { get; set; }Public ReadWrite Property IconResource As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The path to the icon resource, e.g. "SyncProvider.dll,-100", or "SyncProvider.dll,-101"
Id Id Id Id
Prerelease. An identifier for the sync root.
public : PlatForm::String Id { get; set; }public string Id { get; set; }Public ReadWrite Property Id As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
An identifier in the form: [Storage Provider ID]![Windows SID]![Account ID]
Remarks
An example of an ID might look something like: "OneDrive!S-1-1234!Personal"
InSyncPolicy InSyncPolicy InSyncPolicy InSyncPolicy
Prerelease. Provides access to the sync policy for the Cloud Storage Provider.
public : InSyncPolicy InSyncPolicy { get; set; }public InSyncPolicy InSyncPolicy { get; set; }Public ReadWrite Property InSyncPolicy As InSyncPolicy// You can use this property in JavaScript.
The sync policy value.
Path Path Path Path
Prerelease. A storage folder that represents the path to the root of the cloud based folder system.
public : IStorageFolder Path { get; set; }public IStorageFolder Path { get; set; }Public ReadWrite Property Path As IStorageFolder// You can use this property in JavaScript.
A storage folder.
PopulationPolicy PopulationPolicy PopulationPolicy PopulationPolicy
Prerelease. The population policy of the sync root registration.
public : PopulationPolicy PopulationPolicy { get; set; }public PopulationPolicy PopulationPolicy { get; set; }Public ReadWrite Property PopulationPolicy As PopulationPolicy// You can use this property in JavaScript.
A population policy enum value.
ProtectionMode ProtectionMode ProtectionMode ProtectionMode
Prerelease. The protection mode of the sync root registration.
public : ProtectionMode ProtectionMode { get; set; }public ProtectionMode ProtectionMode { get; set; }Public ReadWrite Property ProtectionMode As ProtectionMode// You can use this property in JavaScript.
A protection mode enum value.
RecycleBinUri RecycleBinUri RecycleBinUri RecycleBinUri
Prerelease. A Uri to a cloud storage recycle bin.
public : Uri RecycleBinUri { get; set; }public Uri RecycleBinUri { get; set; }Public ReadWrite Property RecycleBinUri As Uri// You can use this property in JavaScript.
- Value
- Uri Uri Uri Uri
The Uri to the recycle bin.
ShowSiblingsAsGroup ShowSiblingsAsGroup ShowSiblingsAsGroup ShowSiblingsAsGroup
Prerelease. Shows sibling sync roots listed under the main sync root in the File Explorer.
public : PlatForm::Boolean ShowSiblingsAsGroup { get; set; }public bool ShowSiblingsAsGroup { get; set; }Public ReadWrite Property ShowSiblingsAsGroup As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if the sibling sync roots are shown, False otherwise
StorageProviderItemPropertyDefinitions StorageProviderItemPropertyDefinitions StorageProviderItemPropertyDefinitions StorageProviderItemPropertyDefinitions
Prerelease. Gets the StorageProviderItemPropertyDefinition information for a sync root.
public : IVector<StorageProviderItemPropertyDefinition> StorageProviderItemPropertyDefinitions { get; }public IList<StorageProviderItemPropertyDefinition> StorageProviderItemPropertyDefinitions { get; }Public ReadOnly Property StorageProviderItemPropertyDefinitions As IList<StorageProviderItemPropertyDefinition>// You can use this property in JavaScript.
- Value
- IVector<StorageProviderItemPropertyDefinition> IList<StorageProviderItemPropertyDefinition> IList<StorageProviderItemPropertyDefinition> IList<StorageProviderItemPropertyDefinition>
Version Version Version Version
Prerelease. The version number of the sync root.
public : PlatForm::String Version { get; set; }public string Version { get; set; }Public ReadWrite Property Version As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
A string value for the version number. E.g., "1.0"