EngineWindows Class |
Represents Windows user file system.
Inheritance HierarchyNamespace: ITHit.FileSystem.Windows
Assembly: ITHit.FileSystem.Windows (in ITHit.FileSystem.Windows.dll) Version: 8.3.27213.0
SyntaxThe EngineWindows type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | EngineWindows |
Creates a Windows user file system.
|
| EngineWindows(String, String) |
Creates a Windows user file system with specified root folder path and license.
|
Properties| Name | Description | |
|---|---|---|
 | AutoLock |
Automatically lock the file in the remote storage when a file handle is being opened for writing, unlock on close.
|
| ComponentName | (Inherited from Engine.) |
| DataPath |
Path to the location where Engine data is stored.
|
| License |
Gets or sets the license text.
(Inherited from Engine.) |
| MaxOperationsConcurrentRequests |
Maximum number of concurrent listing/move/delete operations. Default is MaxValue.
|
| MaxTransferConcurrentRequests |
Maximum number of concurrent create/update/read operations. Default is 6.
|
| ShellExtensionsComServerRpcEnabled |
Enables gRpc server to communicate with COM shell extensions running in a separate process. Default is false.
|
| State |
Gets the Engine state.
(Inherited from Engine.) |
| ThrowExceptions |
Indicates if the IEngine implementation must throw exception in case of any errors in the Engine itself
or in the user code occures.
(Inherited from Engine.) |
Methods| Name | Description | |
|---|---|---|
| AuthenticateAsync |
Reads auth info from lcal storage or shows login dialog on Windows platform.
|
| ClientNotifications | |
| CreateLogger | (Inherited from Engine.) |
| Dispose | (Inherited from Engine.) |
 | Dispose(Boolean) | Releases the unmanaged resources used by the EngineWindows and optionally releases the managed resources (Overrides EngineDispose(Boolean).) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| FilterAsync |
Allows filtering file system items.
(Overrides EngineFilterAsync(SyncDirection, OperationType, String, FileSystemItemType, String, IOperationContext).) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetFileSystemItemAsync |
Gets file or folder item corresponding to the remote storage item ID.
(Inherited from Engine.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
 | GetMenuCommandAsync |
Gets context menu command.
(Inherited from Engine.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsAuthenticatedAsync | (Inherited from Engine.) |
| IsThisDrivePath |
Returns true if the path is under this drive. False - otherwise.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnItemsChanged |
Rises the ItemsChanged event.
|
| OnItemsChangingAsync |
Rises the ItemsChanging event.
|
| OnStateChanged |
Rises the StateChanged event.
(Inherited from Engine.) |
| RiseError |
Rises Error event. Throws an exception if the ThrowExceptions
property is set to true.
(Inherited from Engine.) |
| ServerNotifications(Byte, ILogger) | (Overrides EngineServerNotifications(Byte, ILogger).) |
| ServerNotifications(String, ILogger) |
Creates, updates, moves and deletes files and folders in the user file system.
Use object returned by this method by path to apply changes sent by the remote storage.
(Overrides EngineServerNotifications(String, ILogger).) |
| SetRemoteStorageRootItemId |
Sets remote storage item ID for the root folder.
(Overrides EngineSetRemoteStorageRootItemId(Byte).) |
| StartAsync |
Starts listening and processing file system calls from operating system.
(Overrides EngineStartAsync(Boolean, CancellationToken).) |
| StopAsync |
Stops listening and processing file system calls from operating system.
(Overrides EngineStopAsync.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| ValidateSettings |
Validates Engine settings.
(Inherited from Engine.) |
Events| Name | Description | |
|---|---|---|
 | Debug |
Event fired when the IEngine or user file system implementation code sends a debug message.
(Inherited from Engine.) |
| Error |
Event fired in case of any exceptions in the IEngine or user file system implementation code.
(Inherited from Engine.) |
| ItemsChanged |
Event fired after an item in user file system was created, updated, deleted, moved or metadata changed.
This even is fired for both incoming and outgoing synchronization events.
It is also fired for failed updates that did not affect any items, providing information about the failure.
|
| ItemsChanging |
Event fired before an item in user file system was created, updated, deleted, moved or metadata changed.
It is also fired on hydration, upload and population progress.
This even is fired for both incoming and outgoing synchronization events.
|
| Message |
Event fired when the IEngine or user file system implementation code sends an informational message.
(Inherited from Engine.) |
| StateChanged |
Event fired when the Engine state changes.
(Inherited from Engine.) |
Fields| Name | Description | |
|---|---|---|
 | CancellationTokenSource |
Cancellation token source to cancel all running operations.
|
| FolderInvalidationIntervalMs |
Folder content invalidation interval. Default is 0 - the folder content is always valid after initial population.
|
| Logger |
Logger.
(Inherited from Engine.) |
| Path |
A root folder of your user file system. Your file system tree will be located under this folder.
(Inherited from Engine.) |
| Placeholders |
Provides access to placeholders in your user file system and data associated with each placeholder.
|
| SyncService |
Synchronization service.
|
RemarksProvides features specific to Windows OS, such as hydration, progress, etc.
See Also