Upgrading to the User File System v4

Below we will provide a summary of most significant changes in the Engine v4 compared to v3:

  • The remote storage ID is now stored by the Engine and passed to Engine.GetFileSystemItemAsync() method on every call, including for Microsoft Office and AutoCAD save operations. You do not need to store the remote storage ID externally. See the updated Remote Storage Item ID section for more details.
  • The Engine.StartAsync() method now processes all items created, updated, moved, and deleted when the engine was not running. To do this the StartAsync() method  calls the EngineWindows.ProcessAsync() method internally by default. The StartAsync() method now also provides an optional parameter to avoid processing modified items.
  • You do not need to store any data about new items in your external storage. All data for new, moved, deleted and updated items is automatically managed by the Engine.
  • Custom data of unlimited size can now be stored with each file and folder in the persistent storage managed by the Engine. You do not need to store data externally. See the Storing Custom Data Associated with Items section for more details.
  • To sync content from the user file system to the remote storage you will now call the EngineWindows.ProcessAsync() method. It will automatically find and sync all items to the server by calling IFile and IFolder interface methods. See the User File System to Remote Storage Synchronization section for more details.
  • All IFile, IFolder and ILock methods now provide a cancellation token parameter. The cancellation is triggered when the Engine.StopAsync() is called or if the method is terminated by the platform because of the time timeout for folder listing or file content hydration.
  • The MoveToCompletionAsync() was called for the item in the target path. Now, this method is called for the item in the source path.