CBSync Class

Properties   Methods   Events   Config Settings   Errors  

The CBSync class enables seamless synchronization between local files and Cloud Storage or other remote repositories.

Syntax

class cbfssync.CBSync

Remarks

CBSync provides an intuitive way to synchronize local files and folders with a remote storage location. When remote changes are made, use the included methods to notify the local system. The topics below provide information about configuring and operating the class.

Selecting a Synchronization Root

Each instance of the class is capable of synchronizing a local directory with a remote storage location. To begin, first set the sync_root_path property to the location on a local disk where files will be visible. This location is also referred to as the "synchronization root". After calling the install and activate methods, the remote files will be visible at this location.

On Linux, the LinuxIntermediateFolder configuration setting specifies the location on disk where file data is stored. When activate is called, the system FUSE library (version 2.9) is used to project a virtual file system in sync_root_path. The file data actually resides within LinuxIntermediateFolder since all files within sync_root_path are virtual.

Installation and Uninstallation

Before the class can be activated, it must be registered with the system by calling the install method.

During normal operation, files are accessed in the synchronization root (and a temporary directory on Linux). To clean up local placeholder files and unregister from the system, use the uninstall method. After uninstalling, the remote files will no longer be visible at the location specified by sync_root_path. Uninstalling is typically performed only when an application will be removed from the system.

Starting and Stopping Synchronization

Call the activate method to start operations. After this method returns, events will fire as requests for remote files are made. One of the first events to fire is the on_list_items event, which is used to populate the synchronization root with files and folders. The activate method only needs to be called once, and events will continue to fire as needed.

Note that files and subfolders that already exist locally, but are not reported by a on_list_items event handler, are considered newly created items and either on_update_item or on_update_folder will fire for each item.

To stop synchronization but keep the synchronization root registered, call the deactivate method, which will allow users to continue to work with offline files.

Handling Events

While the class is active, handle the class's events to provide information as well as receive notifications about local updates. Note that events are fired on arbitrary threads and not the main thread where the class was created. Multiple events can fire simultaneously, in different threads, and it is the responsibility of the user to implement any necessary synchronization. The following events may fire while the class is active:

When these events fire and communication with the remote storage location is required, there are two supported methods for reporting the completion of the operation:

• The request may be completed within the event. This prevents the event from returning and is suitable for operations that can be completed quickly.
• Alternatively, the ResultCode parameter can be set to CBFSSYNC_PENDING (0x21000001) to allow the event to return without delay, and the work can be completed separately. When the operation with the remote storage location is performed in this manner, the task_complete method must be called to inform the class that the operation has been completed.

Some of these events include one or more parameters intended for use as binary data buffers, which either contain or expect data to be provided to complete the operation. Buffer parameters point to pre-allocated blocks of unmanaged memory in which the size is specified by the parameter immediately following; as such, be sure to write data directly to the pointed-to memory rather than change the value of the buffer parameter itself.

Finally, use caution when accessing files from within events. Performing an action on a file that is within the synchronization root may cause the event to fire again before the first event has returned, resulting in an infinite recursion scenario which may cause a deadlock or undefined behavior.

Synchronizing Local Changes

If changes to a local file or folder in the synchronization root are made, the on_update_item or on_update_folder events will fire on a per-item basis and provide an opportunity to synchronize changes to the remote storage.

Information about the modified file or folder is provided through the on_update_item and on_update_folder events. These events provide information about the following file or folder properties:

• The Path of the file or folder within the synchronization root.
• The Size of the file (not applicable to folders).
• The CreationTime, LastAccessTime, and LastModifiedTime of the file or folder, specified in UTC.
• Attributes including Read-Only, Archived, Hidden, and Pinned statuses.

Please refer to the on_update_item and on_update_folder events for more details.

Synchronizing Remote Changes

If changes in the remote storage location are made, use the create_file, create_folder, update_file or update_folder methods to reflect the corresponding changes in the local filesystem.

These operations require that the following information about the item be provided to the class:

• The Path of the item within the synchronization root.
• The Size of the item (not applicable to folders).
• The CreationTime, LastAccessTime, and LastModifiedTime of the item, specified in UTC.

Optionally, additional attributes may be provided if desired.

If the remote item was deleted, use the delete_file or delete_folder methods to reflect the item deletion in the local filesystem.

File Status Icons

On Windows, the status of files is represented by icons visible in File Explorer. These icons are defined by the operating system and are the same icons used by OneDrive.

Handling Errors

The class communicates errors using the error codes defined in the Error Codes section.

The ResultCode parameter of events can be used to report an error when the operation could not be completed successfully. The ResultCode parameter is set to 0 by default, which indicates the operation was successful.

If an unhandled exception occurs in the event handler, it will be caught by the class and an internal error will be reported.

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

active Property

This property reflects whether the class is active.

Syntax

def get_active() -> bool: ...

active = property(get_active, None)

Default Value

FALSE

Remarks

This property reflects whether the class is currently active and handling OS requests. After activate is called this property returns True.

This property is read-only.

sync_root_icon Property

This property specifies a path to an icon for the folder.

Syntax

def get_sync_root_icon() -> str: ...
def set_sync_root_icon(value: str) -> None: ...

sync_root_icon = property(get_sync_root_icon, set_sync_root_icon)

Default Value

""

Remarks

This property specifies a path to an icon which will be displayed in Windows Explorer.

If set, Windows will use the specified icon for the virtual folder visible in Explorer. The value may contain either a resource path (e.g. SyncProvider.dll,-100) or a full path to an .ico file. For instance:

// Specify the same icon that .txt files use in Windows Explorer. cbsync.SyncRootIcon = @"%SystemRoot%\system32\imageres.dll,-102"; // Specify an .ico file. cbsync.SyncRootIcon = @"C:\somewhere\MyIcon.ico";

Note: This property cannot be changed when active is True, and it cannot be changed within events.

Note: This property is only applicable on Windows. This property has no effect on other platforms.

sync_root_label Property

This property specifies a label for the folder.

Syntax

def get_sync_root_label() -> str: ...
def set_sync_root_label(value: str) -> None: ...

sync_root_label = property(get_sync_root_label, set_sync_root_label)

Default Value

""

Remarks

This property specifies a label for the synchronization root. This property must be set before calling activate.

On Windows, this value is used as the folder name visible in Windows Explorer.

On Linux, this value is used as part of the LinuxIntermediateFolder.

Note: This property cannot be changed when active is True, and it cannot be changed within events.

sync_root_path Property

This property specifies the root directory for synchronized files and folders.

Syntax

def get_sync_root_path() -> str: ...
def set_sync_root_path(value: str) -> None: ...

sync_root_path = property(get_sync_root_path, set_sync_root_path)

Default Value

""

Remarks

This property is used to specify the location on the local disk where files and folders are synchronized. This property must be set before calling install or activate.

On Windows, this must be set to an existing directory.

On Linux, this must be set to an existing empty directory. After activate is called, files will be visible at this location. Although this property specifies where files are visible, file data and metadata are stored at the location specified by the LinuxIntermediateFolder configuration setting.

Note: This property cannot be changed when active is True, and it cannot be changed within events.

activate Method

This method prepares and starts the necessary mechanisms for synchronization.

Syntax

def activate() -> None: ...

Remarks

This method prepares and starts the necessary mechanisms for synchronization of the directory specified by the sync_root_path property.

Before calling this method, invoke the install method to perform system-specific registration procedures if the synchronization root has not previously been registered. If files or folders exist locally in sync_root_path that were not synchronized before, they are treated as newly created files when this method is called and are discovered, meaning events will fire as needed to provide an opportunity for the remote storage to properly reflect the synchronization root.

Note that this method will not return until these events have completed; thus, as a result, it may be desirable to complete them asynchronously by setting the ResultCode parameter of the events to CBFSSYNC_PENDING (0x21000001), allowing this method to return in a timely manner.

After this method returns, the synchronized location is exposed to the system and events will begin firing as operations are performed, including when:

• The local system requests data from the remote storage location, such as when listing the directory or opening a file.
• Local changes have been made that should be synchronized to the remote storage location, such as when a new file is created or an existing file is modified.
• Remote changes have been made that should be synchronized to the local file system via the create_file, create_folder, delete_file, delete_folder, update_file and update_folder methods.

Note: This method cannot be called within events.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

create_file Method

This method creates a local file within a synchronization root.

Syntax

def create_file(path: str, attributes: int, size: int, creation_time: datetime.datetime, last_access_time: datetime.datetime, last_modified_time: datetime.datetime) -> None: ...

Remarks

This method creates a local file in a synchronization root and optionally initiates retrieval of its data from a remote storage. To create a local file and initiate the retrieval of the data, set the CBFSSYNC_ATTR_PINNED attribute.

The Path parameter should be a path that begins with the directory separator and identifies the location of the file or folder within the synchronization root.

The Attributes parameter is used to specify the attributes of the file or folder. The specified attributes replace existing attributes of the file or folder. The special value 0 indicates no modification will be made to the existing attributes. To clear all attributes of a file or folder, set the CBFSSYNC_ATTR_NORMAL attribute. To obtain the current attributes, use the get_file_attributes or get_folder_attributes method. The value passed in this parameter should be a binary OR of the following values:

The Size parameter must be set to the size of the file in bytes.

The CreationTime, LastAccessTime, and LastModifiedTime parameters contain the corresponding time values specified in UTC. To indicate no change in the time when calling update_file or update_folder, use a DateTime value that is less than or equal to the Unix epoch of January 1st, 1970.

// Create a new file placeholder. // "/folder1/folder2/new_file.txt" is the path to the file. // 0 represents the attributes since this is a file with no special attributes. // 0 is the size of the file in bytes. // FileCreationTime is a DateTime (in UTC). // FileLastAccessTime is a DateTime (in UTC). // FileLastWriteTime is a DateTime (in UTC). cbsync.CreateFile("/folder1/folder2/new_file.txt", 0, 0, FileCreationTime, FileLastAccessTime, FileLastWriteTime); // Create a new file and request the data to be downloaded. // "/folder1/folder2/new_file.txt" is the path to the file. // CBFSSYNC_ATTR_PINNED represents the attributes since this is a file that will be pinned. // 100 is the size of the file in bytes. // FileCreationTime is a DateTime (in UTC). // FileLastAccessTime is a DateTime (in UTC). // FileLastWriteTime is a DateTime (in UTC). cbsync.CreateFile("/folder1/folder2/get_data_file.txt", Constants.CBFSSYNC_ATTR_PINNED, 100, FileCreationTime, FileLastAccessTime, FileLastWriteTime);

create_folder Method

This method creates a local folder within a synchronization root.

Syntax

def create_folder(path: str, attributes: int, creation_time: datetime.datetime, last_access_time: datetime.datetime, last_modified_time: datetime.datetime) -> None: ...

Remarks

This method creates a local folder in a synchronization root. If the CBFSSYNC_ATTR_PINNED attribute is set, the class will initiate the retrieval of the items of the directory from the remote storage. If any files or folders are found, they are also pinned.

The Path parameter should be a path that begins with the directory separator and identifies the location of the file or folder within the synchronization root.

The Attributes parameter is used to specify the attributes of the file or folder. The specified attributes replace existing attributes of the file or folder. The special value 0 indicates no modification will be made to the existing attributes. To clear all attributes of a file or folder, set the CBFSSYNC_ATTR_NORMAL attribute. To obtain the current attributes, use the get_file_attributes or get_folder_attributes method. The value passed in this parameter should be a binary OR of the following values:

The CreationTime, LastAccessTime, and LastModifiedTime parameters contain the corresponding time values specified in UTC. To indicate no change in the time when calling update_file or update_folder, use a DateTime value that is less than or equal to the Unix epoch of January 1st, 1970.

// Create a new folder in the synchronization root. // "/folder1/folder2/new_folder" is the path to the folder. // 0 represents the attributes since this is a folder with no special attributes. // FolderCreationTime is a DateTime (in UTC). // FolderLastAccessTime is a DateTime (in UTC). // FolderLastWriteTime is a DateTime (in UTC). cbsync.CreateFolder("/folder1/folder2/new_folder", 0, FolderCreationTime, FolderLastAccessTime, FolderLastWriteTime); // Create a new folder and request the contents are pinned. // "/folder1/folder2/" is the path to the folder. // CBFSSYNC_ATTR_PINNED represents the attributes since this is a folder that will be pinned. // FolderCreationTime is a DateTime (in UTC). // FolderLastAccessTime is a DateTime (in UTC). // FolderLastWriteTime is a DateTime (in UTC). cbsync.CreateFolder("/folder1/folder2/", Constants.CBFSSYNC_ATTR_PINNED, FolderCreationTime, FolderLastAccessTime, FolderLastWriteTime);

deactivate Method

This method stops the synchronization operation.

Syntax

def deactivate() -> None: ...

Remarks

This method stops the synchronization operation previously started by the activate method. After calling this method, events will no longer fire as operations are performed on files within sync_root_path.

Note that the synchronization root will still be registered and accessible after this method is called. Users will continue to be able to perform offline operations, including creating new files or modifying files that have previously been synchronized.

To unregister and remove access to the synchronization root, call the uninstall method instead.

Linux:

To handle requests of the sytem FUSE library, the class uses a dedicated thread. If there exist open handles to items in a synchronization root directory, FUSE doesn't finish its operations, while the class waits for FUSE to finish. The class can forcefully stop FUSE operations, but only in the application that uses the class didn't set a handler for the SIGINT signal. If such a handler is set, the class cannot forcefully stop the operations and has to wait for the handles to be closed and for FUSE to stop.

If a process that uses the class is killed or crashes, there's a hanging FUSE mounting point left visible in the system. To remove it, call one of these commands:

• if a process was run under the same user account that performs the removal operation, call "fusermount -u <mounting_point>", where "mounting_point" is a synchronization root directory as set in the sync_root_path property.
• if a process was run under a different user account, call "sudo umount <mounting_point>" instead. Note that this operation requires that a user either is root or is included in the sodoers group.

Note: This method cannot be called within events.

delete_file Method

This method deletes a local file from a synchronization root.

Syntax

def delete_file(path: str) -> None: ...

Remarks

This method deletes a local file from a synchronization root but does not delete the file from the remote storage. The on_delete_item event fires for the newly deleted file after this method successfully returns.

The Path parameter should be a path that begins with the directory separator and identifies the location of the file or folder within the synchronization root.

// Delete a specific file from the synchronization root. cbsync.DeleteFile("/folder1/folder2/file.txt");

delete_folder Method

This method deletes a local folder from a synchronization root.

Syntax

def delete_folder(path: str, delete_children: bool) -> None: ...

Remarks

This method deletes a local folder from a synchronization root but does not delete it from the remote storage. The on_delete_folder event fires for the newly deleted folder after this method successfully returns.

The Path parameter should be a path that begins with the directory separator and identifies the location of the file or folder within the synchronization root.

When a folder is deleted, a caller may use DeleteChildren to specify that if the folder contains files or subfolders, those should also be removed. If this parameter is not set and the folder contains children, the call will fail.

// Delete the specified folder and all its contents. // DeleteChildren parameter set to true indicates all contained files and subfolders will be deleted. cbsync.DeleteFolder("/folder1/folder2/target_folder", true);

get_file_attributes Method

This method returns the attributes of a local file.

Syntax

def get_file_attributes(path: str) -> int: ...

Remarks

This method returns the attributes of a local file within a synchronization root. It may be used at any time, including from within events, to obtain the attributes of a local file.

The Path parameter should be a path that begins with the directory separator and identifies the location of the file or folder within the synchronization root.

The return value is a binary OR of the following values:

get_file_path Method

This method returns the absolute path to the local file that should be sent to the remote storage.

Syntax

def get_file_path(task_id: int) -> str: ...

Remarks

This method may be used from within the on_create_item and on_update_item events to obtain an absolute path to the local file containing data which was changed and should be sent to the remote storage. This method can be used to return the location of the local file so that it may be read and data can be sent to the remote storage location.

This method returns different values depending on the OS in use:

• In Windows, this returns the equivalent of combining sync_root_path and the Path parameter of the on_create_item or on_update_item event.
• In Linux, this returns the equivalent of combining LinuxIntermediateFolder and the Path parameter of the event.
• In macOS, this returns a URL corresponding to the local file data location.

The TaskId parameter must be set to the same TaskId value provided by the corresponding on_create_item or on_update_item event.

// Call this method from within the CreateItem or UpdateItem event handlers. // 123456789 corresponds to the TaskId parameter of the event. // If the SyncRootPath property is set to "C:\temp" and the "myfile.txt" file was accessed, // then GetFilePath will return "C:\temp\myfile.txt" in Windows. string myLocalPath = cbsync.GetFilePath(123456789); // Use the path returned by this method when determining which local file is to be read and upload to the remote storage.

get_file_status Method

This method returns the download status of a local file.

Syntax

def get_file_status(path: str) -> int: ...

Remarks

This method returns the download status of a local file within a synchronization root. A downloaded file is one that is available on the local system but may be automatically changed to an online-only file by the operating system. Refer to the following table for more information.

The Path parameter should be a path that begins with the directory separator and identifies the location of the file or folder within the synchronization root.

The return value is a binary OR of the following values:

get_folder_attributes Method

This method returns the attributes of a local folder.

Syntax

def get_folder_attributes(path: str) -> int: ...

Remarks

This method returns the attributes of a local folder within a synchronization root. It may be used at any time, including from within events, to obtain the attributes of a local folder.

The Path parameter should be a path that begins with the directory separator and identifies the location of the file or folder within the synchronization root.

The return value is a binary OR of the following values:

get_folder_status Method

This method returns the download status of a local folder.

Syntax

def get_folder_status(path: str) -> int: ...

Remarks

This method returns the download status of a local folder within a synchronization root. A downloaded folder is one for which all the files within it are available on the local system, but it may be automatically changed to an online-only folder by the operating system. Refer to the following table for more information.

The Path parameter should be a path that begins with the directory separator and identifies the location of the file or folder within the synchronization root.

The return value is a binary OR of the following values:

install Method

This method registers the synchronization root with the system.

Syntax

def install() -> None: ...

Remarks

This method registers the synchronization root specified by sync_root_path with the system. After calling this method, invoke the activate method to begin synchronization operations.

In Windows, set the WindowsStorageProviderAccount and WindowsStorageProviderId configuration settings to uniquely identify this synchronization root instance before calling this method, which is important when working with multiple synchronized locations on one system.

This method must be called once for each synchronization root, but it does not need to be called again unless the uninstall method is invoked to remove the registration. Note that the registration performed by this method is persistent and will remain even if the application exits or the class is deactivated as a result of calling the deactivate method.

In Linux, this method checks that FUSE is installed.

Note: This method cannot be called within events.

In Windows, this method requires administrative rights to execute successfully. If the user account of the process that calls this method doesn't have such rights, the call will fail with the CBFSSYNC_ERR_INITIALIZATION_FAILED error and E_ACCESSDENIED HRESULT code reported in the WindowsLastError configuration setting.

list_item Method

This method is used to provide information about an item during directory enumeration.

Syntax

def list_item(task_id: int, item_name: str, is_dir: bool, attributes: int, size: int, creation_time: datetime.datetime, last_access_time: datetime.datetime, last_modified_time: datetime.datetime) -> None: ...

Remarks

This method may be called from within the on_list_items event to provide detailed information about an item contained in the directory or after on_list_items returns to supply it asynchronously.

The TaskId parameter must be set to the same value provided in the on_list_items event.

The ItemName parameter should contain the name of the file or folder without separators.

The IsDir parameter is used to indicate when the item is a folder.

The Attributes parameter is used to specify the attributes of the item. Available attributes are:

The Size parameter must be set to the size of the file in bytes. This parameter is not applicable to folders.

The CreationTime, LastAccessTime, and LastModifiedTime parameters contain the corresponding time values specified in UTC.

Note: This method can be called only within events, and it must be called in the same thread that the event was originally fired on.

// Return information about a file. // 123456789 is the e.TaskId value from the ListItems event. // "myfile.txt" is the name of the file (without separators). // IsDir parameter set to false indicates the item is a file. // 0 represents the attributes since this is a file with no special attributes. // 100 is the size of the file in bytes. // FileCreationTime is a DateTime (in UTC). // FileLastAccessTime is a DateTime (in UTC). // FileLastWriteTime is a DateTime (in UTC). cbsync.ListItem(123456789, "myfile.txt", false, 0, 100, FileCreationTime, FileLastAccessTime, FileLastWriteTime); // Return information about a read-only hidden file. // Constants.CBFSSYNC_ATTR_READONLY | Constants.CBFSSYNC_ATTR_HIDDEN represents the attributes since this is a read-only hidden file. cbsync.ListItem(123456789, "myfile.txt", false, Constants.CBFSSYNC_ATTR_READONLY | Constants.CBFSSYNC_ATTR_HIDDEN, 100, FileCreationTime, FileLastAccessTime, FileLastWriteTime); // Return information about a directory. // IsDir parameter set to true indicates the item is a directory. // 0 represents the file size because size is not applicable to directories. cbsync.ListItem(123456789, "myfolder", true, 0, 0, FileCreationTime, FileLastAccessTime, FileLastWriteTime);

pin_file Method

This method marks the file as pinned so it is always available on the system.

Syntax

def pin_file(path: str) -> None: ...

Remarks

This method pins the file specified by Path. When the file is pinned, a download is initiated if the file data has not previously been downloaded. Once the file data has been downloaded, the file is marked as pinned, meaning the file is always available on the system even when no Internet connection is available. Refer to the following table for more information.

The Path parameter should be a path that begins with the directory separator and identifies the location of the file or folder within the synchronization root.

Calling this method is equivalent to calling set_file_attributes and passing only the CBFSSYNC_ATTR_PINNED attribute. To unpin a file so that the local file data may be freed, call unpin_file.

pin_folder Method

This method marks the folder as pinned so it is always available on the system.

Syntax

def pin_folder(path: str) -> None: ...

Remarks

This method pins the folder specified by Path. When the folder is pinned, a download is initiated if files within the folder have not been downloaded. Once the files within the folder have been downloaded, the folder is marked as pinned, meaning the files within the folder are always available on the system even when no Internet connection is available. Refer to the following table for more information.

The Path parameter should be a path that begins with the directory separator and identifies the location of the file or folder within the synchronization root.

Calling this method is equivalent to calling set_folder_attributes and passing only the CBFSSYNC_ATTR_PINNED attribute. To unpin a folder so that the local files may be freed, call unpin_folder.

put_item_data Method

This method is used to provide the file data that were requested during item retrieval.

Syntax

def put_item_data(task_id: int, buffer: bytes, index: int, count: int) -> None: ...

Remarks

This method may be called from within the on_get_item_data event to immediately provide the requested file data or after on_get_item_data returns to supply it asynchronously.

The TaskId parameter must be set to the same value provided in the on_get_item_data event.

When the OS must retrieve file data, the on_get_item_data event is fired, which specifies the range of remote file data that must be read and passed back by this method. If the data are to be provided asynchronously, the event's ResultCode parameter should be set to CBFSSYNC_PENDING (0x21000001) before returning from the event handler; otherwise, this method should be called from within the handler.

Requested file data can be supplied via the Buffer, where Count bytes of data will be read starting at the given Index. These data may either be supplied all at once or in chunks over multiple calls to this method.

Once all file data has been provided and the transfer is complete, inform the class by calling the task_complete method.

For example, if on_get_item_data fires and requests 1024 bytes of file data, the user can opt to pass these data in one or multiple chunks:

// Pass all 1024 bytes of data at once. cbsync.PutItemData(e.TaskId, buffer, 0, 1024); cbsync.TaskComplete(e.TaskId, 0); // Pass data in three separate chunks totaling 1024 bytes. cbsync.PutItemData(e.TaskId, buffer, 0, 512); cbsync.PutItemData(e.TaskId, buffer, 512, 100); cbsync.PutItemData(e.TaskId, buffer, 612, 412); cbsync.TaskComplete(e.TaskId, 0);

reset_file Method

This method removes the local copy of the data for the specified item.

Syntax

def reset_file(path: str) -> None: ...

Remarks

This method removes the local copy of data for the specified file identified by Path, leaving behind an empty placeholder locally. The on_file_reset event fires after the local data has been purged. The ResetPinnedFiles setting controls whether pinned files are reset or skipped (default).

When files are downloaded, their data is stored both locally and remotely. This method should be used to remove the local copy of data and keep only the empty placeholder files.

The Path parameter should be a path that begins with the directory separator and identifies the location of the file or folder within the synchronization root.

// Reset a specific file. cbsync.ResetFile("/MyFolder/MyFile.txt");

reset_folder Method

This method removes the local copy of the data for the specified folder.

Syntax

def reset_folder(path: str) -> None: ...

Remarks

This method removes the local copy of data for the specified folder identified by Path, leaving behind an empty placeholder locally. the class will recursively reset all files within that folder. The on_file_reset event fires after the local data has been purged. The ResetPinnedFiles setting controls whether pinned files are reset or skipped (default).

When files are downloaded, their data is stored both locally and remotely. This method should be used to remove the local copy of data and keep only the empty placeholder files.

The Path parameter should be a path that begins with the directory separator and identifies the location of the file or folder within the synchronization root.

// Reset all files within "MyFolder" and its subfolders. cbsync.ResetFolder("/MyFolder");

set_file_attributes Method

This method sets the attributes of a local file.

Syntax

def set_file_attributes(path: str, attributes: int) -> None: ...

Remarks

This method sets the attributes of a local file within a synchronization root. It may be used at any time, including from within events, to modify the attributes of a local file.

The Path parameter should be a path that begins with the directory separator and identifies the location of the file or folder within the synchronization root.

The Attributes parameter is used to specify the attributes of the file or folder. The specified attributes replace existing attributes of the file or folder. The special value 0 indicates no modification will be made to the existing attributes. To clear all attributes of a file or folder, set the CBFSSYNC_ATTR_NORMAL attribute. To obtain the current attributes, use the get_file_attributes or get_folder_attributes method. The value passed in this parameter should be a binary OR of the following values:

// Set a specific file's attributes to be read-only and hidden. // "myfile.txt" is the name of the file (without separators). cbsync.SetFileAttributes("/myfile.txt", Constants.CBFSSYNC_ATTR_READONLY | Constants.CBFSSYNC_ATTR_HIDDEN);

set_folder_attributes Method

This method sets the attributes of a local folder.

Syntax

def set_folder_attributes(path: str, attributes: int) -> None: ...

Remarks

This method sets the attributes of a local folder within a synchronization root. It may be used at any time, including from within events, to modify the attributes of a local folder.

The Path parameter should be a path that begins with the directory separator and identifies the location of the file or folder within the synchronization root.

The Attributes parameter is used to specify the attributes of the file or folder. The specified attributes replace existing attributes of the file or folder. The special value 0 indicates no modification will be made to the existing attributes. To clear all attributes of a file or folder, set the CBFSSYNC_ATTR_NORMAL attribute. To obtain the current attributes, use the get_file_attributes or get_folder_attributes method. The value passed in this parameter should be a binary OR of the following values:

// Set a specific folder's attributes to be read-only and hidden. // "myfolder" is the name of the folder (without separators). cbsync.SetFolderAttributes("/myfolder", Constants.CBFSSYNC_ATTR_READONLY | Constants.CBFSSYNC_ATTR_HIDDEN);

sync_file Method

This method initiates synchronization of the specified file.

Syntax

def sync_file(path: str) -> None: ...

Remarks

This method initiates retrieval of the specified file. When this method is called the file data will be downloaded, even if the file has been previously downloaded. After calling this method, the on_get_item_data event will fire. This method may be used to download a local copy of a file at any time, even if the user has not yet opened the file.

The Path parameter should be a path that begins with the directory separator and identifies the location of the file or folder within the synchronization root.

// Synchronize a specific file. cbsync.SyncFile("/folder1/folder2/file.txt");

task_complete Method

This method notifies the class that the asynchronous data transfer operation has been completed.

Syntax

def task_complete(task_id: int, error_code: int) -> None: ...

Remarks

This method must be called to inform the class that the asynchronous transfer of data, initiated in response to any of the following events, has been completed (either successfully or with an error):

• on_list_items
• on_get_item_data
• on_create_item / on_create_folder
• on_delete_item / on_delete_folder
• on_rename_item / on_rename_folder
• on_update_item / on_update_folder

When any of these events fire and data transfer is required, this transfer can take place without blocking the event by setting its ResultCode parameter to CBFSSYNC_PENDING (0x21000001). The event will then return, after which operations to the remote storage location can be performed to synchronize the changes. Once the synchronization operations are complete, this method must be called to indicate that the transfer is complete.

The TaskId parameter should be set to the value originally provided by the event whose operations will be complete asynchronously; thus, it is important to record this value before returning from the event handler.

If the operation completed successfully, the ErrorCode parameter should be set to 0; otherwise, it should be set to an appropriate value to report an error. Please refer to the Error Codes section for the set of possible values.

Note: This method cannot be called within events.

uninstall Method

This method unregisters the synchronization root from the system and performs cleanup operations.

Syntax

def uninstall() -> None: ...

Remarks

This method is used to unregister the synchronization root specified by sync_root_path. In most cases, this method should only be called when the application using the class will be removed from the system. To simply stop the synchronization but leave the class registered, call the deactivate method instead.

When this method is called, the class is unregistered and any online-only files and folders present in sync_root_path are removed; thus, only files which contain data locally remain. For instance, if a file was previously opened in Windows and shows a green check mark in Explorer, that file will remain after calling this method, whereas a file showing a blue cloud icon would not. The folder structure for remaining files is preserved when this method is called, but empty folders are deleted.

When calling this method, the following values must match the values used when install was called:

• sync_root_path
• sync_root_label
• WindowsStorageProviderAccount (Windows only)
• WindowsStorageProviderId (Windows only)
• LinuxIntermediateFolder (Linux only)

Note: This method cannot be called within events.

In Windows, this method requires administrative rights to execute successfully. If the user account of the process that calls this method doesn't have such rights, the call will fail with the CBFSSYNC_ERR_INITIALIZATION_FAILED error and E_ACCESSDENIED HRESULT code reported in the WindowsLastError configuration setting.

unpin_file Method

This method marks the file as unpinned so the local copy of the file data may be freed.

Syntax

def unpin_file(path: str) -> None: ...

Remarks

This method unpins the file specified by Path which has previously been pinned. When the file is unpinned, the local file data may be freed. To explicitly free previously downloaded file data, call reset_file after calling this method. If reset_file is not called, a local copy of the data may still be kept locally until the file system initiates the freeing of file data.

Note that this method only removes CBFSSYNC_ATTR_PINNED from the file's attributes. To set the CBFSSYNC_ATTR_UNPINNED attribute so that the file is converted to an online-only file and local file data is freed, use the set_file_attributes method.

The Path parameter should be a path that begins with the directory separator and identifies the location of the file or folder within the synchronization root.

unpin_folder Method

This method marks the folder as unpinned so the local copy of the files within the folder may be freed.

Syntax

def unpin_folder(path: str) -> None: ...

Remarks

This method unpins the folder specified by Path which has previously been pinned. When the folder is unpinned, the local data for files within the folder may be freed. To explicitly free previously downloaded files, call reset_folder after calling this method. If reset_folder is not called, a local copy of the file data may still be kept locally until the file system initiates the freeing of file data.

Note that this method only removes CBFSSYNC_ATTR_PINNED from the folder's attributes. To set the CBFSSYNC_ATTR_UNPINNED attribute so that the folder is converted to an online-only folder and local file data is freed, use the set_folder_attributes method.

The Path parameter should be a path that begins with the directory separator and identifies the location of the file or folder within the synchronization root.

update_file Method

This method is used to update a local file within a synchronization root.

Syntax

def update_file(path: str, attributes: int, size: int, creation_time: datetime.datetime, last_access_time: datetime.datetime, modification_time: datetime.datetime) -> None: ...

Remarks

This method allows for the updating of a local file within a synchronization root. The method may be used to update the attributes as well as the creation time, last access time, and modified time of a file. If updating the file's attributes is the only desired operation, the set_file_attributes method may be used instead.

The Path parameter should be a path that begins with the directory separator and identifies the location of the file or folder within the synchronization root.

The Attributes parameter is used to specify the attributes of the file or folder. The specified attributes replace existing attributes of the file or folder. The special value 0 indicates no modification will be made to the existing attributes. To clear all attributes of a file or folder, set the CBFSSYNC_ATTR_NORMAL attribute. To obtain the current attributes, use the get_file_attributes or get_folder_attributes method. The value passed in this parameter should be a binary OR of the following values:

The Size parameter must be set to the size of the file in bytes.

The CreationTime, LastAccessTime, and LastModifiedTime parameters contain the corresponding time values specified in UTC. To indicate no change in the time when calling update_file or update_folder, use a DateTime value that is less than or equal to the Unix epoch of January 1st, 1970.

// Update a file. // "myfile.txt" is the name of the file (without separators). // 0 represents the attributes since this is a file with no special attributes. // 100 is the size of the file in bytes. // FileCreationTime is a DateTime (in UTC). // FileLastAccessTime is a DateTime (in UTC). // FileLastWriteTime is a DateTime (in UTC). cbsync.UpdateFile("/myfile.txt", 0, 100, FileCreationTime, FileLastAccessTime, FileLastWriteTime); // Update a read-only hidden file. cbsync.UpdateFile("/myfile.txt", Constants.CBFSSYNC_ATTR_READONLY | Constants.CBFSSYNC_ATTR_HIDDEN, 100, FileCreationTime, FileLastAccessTime, FileLastWriteTime);

update_folder Method

This method is used to update a local folder within a synchronization root.

Syntax

def update_folder(path: str, attributes: int, creation_time: datetime.datetime, last_access_time: datetime.datetime, modification_time: datetime.datetime) -> None: ...

Remarks

This method allows for the updating of a local folder within a synchronization root. The method may be used to update the attributes as well as the creation time, last access time, and modified time of a folder. If updating the folder's attributes is the only desired operation, the set_folder_attributes method may be used instead.

The Path parameter should be a path that begins with the directory separator and identifies the location of the file or folder within the synchronization root.

The Attributes parameter is used to specify the attributes of the file or folder. The specified attributes replace existing attributes of the file or folder. The special value 0 indicates no modification will be made to the existing attributes. To clear all attributes of a file or folder, set the CBFSSYNC_ATTR_NORMAL attribute. To obtain the current attributes, use the get_file_attributes or get_folder_attributes method. The value passed in this parameter should be a binary OR of the following values:

The CreationTime, LastAccessTime, and LastModifiedTime parameters contain the corresponding time values specified in UTC. To indicate no change in the time when calling update_file or update_folder, use a DateTime value that is less than or equal to the Unix epoch of January 1st, 1970.

// Update a folder. // "myfolder" is the name of the folder (without separators). // 0 represents the attributes since this is a folder with no special attributes. // FolderCreationTime is a DateTime (in UTC). // FolderLastAccessTime is a DateTime (in UTC). // FolderLastWriteTime is a DateTime (in UTC). cbsync.UpdateFolder("/myfolder", 0, FolderCreationTime, FolderLastAccessTime, FolderLastWriteTime);

on_cancel_task Event

This event fires when an ongoing transfer of item data will not be completed and must be canceled.

Syntax

class CBSyncCancelTaskEventParams(object):
  @property
  def task_id() -> int: ...

  @property
  def path() -> str: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBSync:
@property
def on_cancel_task() -> Callable[[CBSyncCancelTaskEventParams], None]: ...
@on_cancel_task.setter
def on_cancel_task(event_hook: Callable[[CBSyncCancelTaskEventParams], None]) -> None: ...

Remarks

This event fires when the class has been notified that the ongoing transfer must be canceled, and can be fired in the same thread in which the transfer is handled or in another thread.

The TaskId parameter identifies the transfer operation to which this event applies. The TaskId value from this event will match the value provided by the event where the operation began.

The Path parameter represents the path of the file relative to the synchronization root; for example, "/MyFolder/MyFile.txt".

When the event is fired, the ResultCode parameter will always be 0. However, if the event cannot be handled successfully due to reasons such as unavailable resources or failed security checks, you can set it to an appropriate value to report an error. Please refer to the Error Codes section for the set of possible values. In case an unhandled exception occurs within the event handler, the class will catch it and report an internal error.

on_create_folder Event

This event fires when a folder is created locally, enabling the creation to be reflected in the corresponding remote folder.

Syntax

class CBSyncCreateFolderEventParams(object):
  @property
  def task_id() -> int: ...

  @property
  def path() -> str: ...

  @property
  def attributes() -> int: ...

  @property
  def creation_time() -> datetime.datetime: ...

  @property
  def last_access_time() -> datetime.datetime: ...

  @property
  def last_modified_time() -> datetime.datetime: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBSync:
@property
def on_create_folder() -> Callable[[CBSyncCreateFolderEventParams], None]: ...
@on_create_folder.setter
def on_create_folder(event_hook: Callable[[CBSyncCreateFolderEventParams], None]) -> None: ...

Remarks

This event fires when the class detects that a new folder has been created at the location specified by Path.

When a new folder is created within the synchronization root, this event allows for the addition of the folder to be acknowledged and replicated in the remote storage location.

When this event fires and communication with the remote storage location is required, there are two supported methods for reporting the completion of the operation:

• If the request can be completed quickly, set the ResultCode parameter to 0 and return from this event. Do not call task_complete in this case.
• If the request cannot be completed quickly, set the ResultCode parameter to CBFSSYNC_PENDING (0x21000001) and return from this event. The communication with the remote storage location may then be completed outside of this event. After the request has been completed call task_complete to inform the class about the completion. When task_complete is called, the value of the TaskId parameter of this event must be passed to task_complete to identify the completed operation.

The TaskId parameter identifies the current operation and is required when calling the task_complete method; thus, it is important to record this value when an operation will be completed after the event handler has returned.

The Path parameter represents the path of the folder relative to the synchronization root; for example, "/MyFolder/MyOtherFolder".

The CreationTime, LastAccessTime, and LastModifiedTime parameters contain the corresponding time value, specified in UTC.

The Attributes parameter is a bitmask defining the attributes of the folder. The possible attributes include:

When the event is fired, the ResultCode parameter will always be 0. However, if the event cannot be handled successfully due to reasons such as unavailable resources or failed security checks, you can set it to an appropriate value to report an error. Please refer to the Error Codes section for the set of possible values. In case an unhandled exception occurs within the event handler, the class will catch it and report an internal error.

on_create_item Event

This event fires when a file is created locally, enabling the creation to be reflected in the corresponding remote item.

Syntax

class CBSyncCreateItemEventParams(object):
  @property
  def task_id() -> int: ...

  @property
  def path() -> str: ...

  @property
  def attributes() -> int: ...

  @property
  def size() -> int: ...

  @property
  def creation_time() -> datetime.datetime: ...

  @property
  def last_access_time() -> datetime.datetime: ...

  @property
  def last_modified_time() -> datetime.datetime: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBSync:
@property
def on_create_item() -> Callable[[CBSyncCreateItemEventParams], None]: ...
@on_create_item.setter
def on_create_item(event_hook: Callable[[CBSyncCreateItemEventParams], None]) -> None: ...

Remarks

This event fires when the class detects that a new file has been created at the location specified by Path.

When a new file is created within the synchronization root, this event allows for the addition of the file to be acknowledged and replicated in the remote storage location.

When this event fires and communication with the remote storage location is required, there are two supported methods for reporting the completion of the operation:

• If the request can be completed quickly, set the ResultCode parameter to 0 and return from this event. Do not call task_complete in this case.
• If the request cannot be completed quickly, set the ResultCode parameter to CBFSSYNC_PENDING (0x21000001) and return from this event. The communication with the remote storage location may then be completed outside of this event. After the request has been completed call task_complete to inform the class about the completion. When task_complete is called, the value of the TaskId parameter of this event must be passed to task_complete to identify the completed operation.

The TaskId parameter identifies the current operation and is required when calling the task_complete method; thus, it is important to record this value when an operation will be completed after the event handler has returned.

The Path parameter represents the path of the file relative to the synchronization root; for example, "/MyFolder/MyFile.txt".

The Size parameter specifies the new size of the file.

The CreationTime, LastAccessTime, and LastModifiedTime parameters contain the corresponding time value, specified in UTC.

The Attributes parameter is a bitmask defining the attributes of the file. The possible attributes include:

Use the get_file_path method to obtain the location of the data that should be sent to a remote storage.

When the event is fired, the ResultCode parameter will always be 0. However, if the event cannot be handled successfully due to reasons such as unavailable resources or failed security checks, you can set it to an appropriate value to report an error. Please refer to the Error Codes section for the set of possible values. In case an unhandled exception occurs within the event handler, the class will catch it and report an internal error.

on_delete_folder Event

This event fires when a local folder is deleted, enabling the deletion to be reflected in the corresponding remote folder.

Syntax

class CBSyncDeleteFolderEventParams(object):
  @property
  def task_id() -> int: ...

  @property
  def path() -> str: ...

  @property
  def delete_flags() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBSync:
@property
def on_delete_folder() -> Callable[[CBSyncDeleteFolderEventParams], None]: ...
@on_delete_folder.setter
def on_delete_folder(event_hook: Callable[[CBSyncDeleteFolderEventParams], None]) -> None: ...

Remarks

This event fires when the local folder identified by Path is deleted.

When this event fires and communication with the remote storage location is required, there are two supported methods for reporting the completion of the operation:

• If the request can be completed quickly, set the ResultCode parameter to 0 and return from this event. Do not call task_complete in this case.
• If the request cannot be completed quickly, set the ResultCode parameter to CBFSSYNC_PENDING (0x21000001) and return from this event. The communication with the remote storage location may then be completed outside of this event. After the request has been completed call task_complete to inform the class about the completion. When task_complete is called, the value of the TaskId parameter of this event must be passed to task_complete to identify the completed operation.

The TaskId parameter identifies the current operation and is required when calling the task_complete method; thus, it is important to record this value when an operation will be completed after the event handler has returned.

The Path parameter represents the path of the folder relative to the synchronization root; for example, "/MyFolder/MyOtherFolder".

The DeleteFlags parameter specifies optional parameters of the operation and contains a combination of the following flags:

If the CBFSSYNC_DELETE_TO_BIN flag is set, the event handler should move the folder to some location that acts as a Recycle Bin / Trash. If this flag is not set, the folder is gone, and the event handler should delete the folder on the remote side.

When the event is fired, the ResultCode parameter will always be 0. However, if the event cannot be handled successfully due to reasons such as unavailable resources or failed security checks, you can set it to an appropriate value to report an error. Please refer to the Error Codes section for the set of possible values. In case an unhandled exception occurs within the event handler, the class will catch it and report an internal error.

on_delete_item Event

This event fires when a local file is deleted, enabling the deletion to be reflected in the corresponding remote item.

Syntax

class CBSyncDeleteItemEventParams(object):
  @property
  def task_id() -> int: ...

  @property
  def path() -> str: ...

  @property
  def delete_flags() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBSync:
@property
def on_delete_item() -> Callable[[CBSyncDeleteItemEventParams], None]: ...
@on_delete_item.setter
def on_delete_item(event_hook: Callable[[CBSyncDeleteItemEventParams], None]) -> None: ...

Remarks

This event fires when the local file identified by Path is deleted.

When this event fires and communication with the remote storage location is required, there are two supported methods for reporting the completion of the operation:

• If the request can be completed quickly, set the ResultCode parameter to 0 and return from this event. Do not call task_complete in this case.
• If the request cannot be completed quickly, set the ResultCode parameter to CBFSSYNC_PENDING (0x21000001) and return from this event. The communication with the remote storage location may then be completed outside of this event. After the request has been completed call task_complete to inform the class about the completion. When task_complete is called, the value of the TaskId parameter of this event must be passed to task_complete to identify the completed operation.

The TaskId parameter identifies the current operation and is required when calling the task_complete method; thus, it is important to record this value when an operation will be completed after the event handler has returned.

The Path parameter represents the path of the file relative to the synchronization root; for example, "/MyFolder/MyFile.txt".

The DeleteFlags parameter specifies optional parameters of the operation and contains a combination of the following flags:

If the CBFSSYNC_DELETE_TO_BIN flag is set, the event handler should move the file to some location that acts as a Recycle Bin / Trash. If this flag is not set, the file is gone, and the event handler should delete the file on the remote side.

When the event is fired, the ResultCode parameter will always be 0. However, if the event cannot be handled successfully due to reasons such as unavailable resources or failed security checks, you can set it to an appropriate value to report an error. Please refer to the Error Codes section for the set of possible values. In case an unhandled exception occurs within the event handler, the class will catch it and report an internal error.

on_error Event

This event fires if an unhandled error occurs during an event.

Syntax

class CBSyncErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class CBSync:
@property
def on_error() -> Callable[[CBSyncErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[CBSyncErrorEventParams], None]) -> None: ...

Remarks

This event fires if an unhandled error occurs during another event. Developers can use this information to track down unhandled errors in an application's event handlers.

on_file_reset Event

This event is fired after the local copy of a file's data has been discarded.

Syntax

class CBSyncFileResetEventParams(object):
  @property
  def task_id() -> int: ...

  @property
  def path() -> str: ...

# In class CBSync:
@property
def on_file_reset() -> Callable[[CBSyncFileResetEventParams], None]: ...
@on_file_reset.setter
def on_file_reset(event_hook: Callable[[CBSyncFileResetEventParams], None]) -> None: ...

Remarks

This event is fired when the local copy of a file's data has been discarded. When files are downloaded, their data is stored both locally and remotely. At times, the local copy of the data may be purged while the file placeholder remains.

The local file data can be manually removed by calling the reset_file method, or it may be initiated by the system. In either case, after the local copy of the file data has been purged, this event is fired to notify the user.

Following the firing of this event, the file placeholder will still be present, but no file data will be stored locally.

The Path parameter represents the path of the file relative to the synchronization root; for example, "/MyFolder/MyFile.txt".

The TaskId parameter is reserved for future use.

This event is provided for informational purposes only and does not require any immediate action.

on_get_item_data Event

This event fires when file data are needed from the remote storage.

Syntax

class CBSyncGetItemDataEventParams(object):
  @property
  def task_id() -> int: ...

  @property
  def path() -> str: ...

  @property
  def offset() -> int: ...

  @property
  def length() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBSync:
@property
def on_get_item_data() -> Callable[[CBSyncGetItemDataEventParams], None]: ...
@on_get_item_data.setter
def on_get_item_data(event_hook: Callable[[CBSyncGetItemDataEventParams], None]) -> None: ...

Remarks

This event fires when the class needs to retrieve file data from the remote storage and put them into the local file identified by Path.

To handle the event properly, the data must be passed to the class by calling the put_item_data method one or more times. This can be accomplished in two ways:

• The transfer may be completed within this event. This prevents the event from returning and is suitable for data transfer that can be completed quickly.
• Alternatively, the ResultCode parameter can be set to CBFSSYNC_PENDING (0x21000001) to allow the event to return without delay, and the work can be completed separately.

After the data transfer is finished, the task_complete method must be called to notify the component that the operation has been completed, as long as the event handler will be returned with success (i.e. ResultCode set to 0) or was previously returned with pending status (i.e. ResultCode set to CBFSSYNC_PENDING). In the case of any other error, the task_complete method should not be called.

The TaskId parameter identifies the current operation and is required when calling both the put_item_data method and the task_complete method; thus, it is important to record this value when an operation will be completed after the event handler has returned.

The Path parameter represents the path of the file relative to the synchronization root; for example, "/MyFolder/MyFile.txt".

The Offset and Length parameters specify the starting position of the data to be retrieved and the expected size of the retrieved data, respectively.

It is possible that the retrieval will be canceled, in which case, the on_cancel_task event will fire.

When the event is fired, the ResultCode parameter will always be 0. However, if the event cannot be handled successfully due to reasons such as unavailable resources or failed security checks, you can set it to an appropriate value to report an error. Please refer to the Error Codes section for the set of possible values. In case an unhandled exception occurs within the event handler, the class will catch it and report an internal error.

on_list_items Event

This event is fired when the contents of a remote directory need to be listed locally.

Syntax

class CBSyncListItemsEventParams(object):
  @property
  def task_id() -> int: ...

  @property
  def path() -> str: ...

  @property
  def mask() -> str: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBSync:
@property
def on_list_items() -> Callable[[CBSyncListItemsEventParams], None]: ...
@on_list_items.setter
def on_list_items(event_hook: Callable[[CBSyncListItemsEventParams], None]) -> None: ...

Remarks

This event is fired by the class when it needs to list the contents of the remote directory specified by Path.

It is important to note that the event is triggered at the discretion of the operating system. This means that the directory listings in the Path will not be automatically refreshed upon user action. Instead, updates should be manually reported by calling methods such as create_file, create_folder, update_file, update_folder, delete_file, and delete_folder.

To handle the event properly, items within the directory must be reported by calling the list_item method for each item being reported. This can be accomplished in two ways:

• The transfer may be completed within this event. This prevents the event from returning and is suitable for data transfer that can be completed quickly.
• Alternatively, the ResultCode parameter can be set to CBFSSYNC_PENDING (0x21000001) to allow the event to return without delay, and the work can be completed separately. When the operation with the remote storage location is performed in this manner, the task_complete method must be called to inform the class that the operation has been completed.

The TaskId parameter identifies the current operation and is required when calling both the list_item method and the task_complete method; thus, it is important to record this value when an operation will be completed after the event handler has returned.

The Path parameter represents the path of the file relative to the synchronization root; for example, "/MyFolder/MyFile.txt".

The Mask parameter allows you to specify a filename mask for filtering the results. It can contain any combination of valid filename characters and wildcards such as * and ?. Alternatively, it can be an exact filename without any wildcards if you need to query file information by specifying an exact filename in the enumeration.

When the event is fired, the ResultCode parameter will always be 0. However, if the event cannot be handled successfully due to reasons such as unavailable resources or failed security checks, you can set it to an appropriate value to report an error. Please refer to the Error Codes section for the set of possible values. In case an unhandled exception occurs within the event handler, the class will catch it and report an internal error.

on_log Event

This log reports events that occur in the class.

Syntax

class CBSyncLogEventParams(object):
  @property
  def level() -> int: ...

  @property
  def message() -> str: ...

# In class CBSync:
@property
def on_log() -> Callable[[CBSyncLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[CBSyncLogEventParams], None]) -> None: ...

Remarks

This event fires when the class needs to notify an application or developers about something that happened internally. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of the message. Possible values are as follows:

Message is the log entry.

Note: This event will fire in the context of a dedicated worker thread. Keep handling of this event as quick as possible.

on_rename_folder Event

This event fires when a local folder is about to be renamed or moved, enabling the change to be reflected in the corresponding remote folder.

Syntax

class CBSyncRenameFolderEventParams(object):
  @property
  def task_id() -> int: ...

  @property
  def old_path() -> str: ...

  @property
  def new_path() -> str: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBSync:
@property
def on_rename_folder() -> Callable[[CBSyncRenameFolderEventParams], None]: ...
@on_rename_folder.setter
def on_rename_folder(event_hook: Callable[[CBSyncRenameFolderEventParams], None]) -> None: ...

Remarks

This event fires when the system needs to notify the class that the local folder located at OldPath is about to be renamed or moved.

When this event fires and communication with the remote storage location is required, there are two supported methods for reporting the completion of the operation:

• If the request can be completed quickly, set the ResultCode parameter to 0 and return from this event. Do not call task_complete in this case.
• If the request cannot be completed quickly, set the ResultCode parameter to CBFSSYNC_PENDING (0x21000001) and return from this event. The communication with the remote storage location may then be completed outside of this event. After the request has been completed call task_complete to inform the class about the completion. When task_complete is called, the value of the TaskId parameter of this event must be passed to task_complete to identify the completed operation.

The TaskId parameter identifies the current operation and is required when calling the task_complete method; thus, it is important to record this value when an operation will be completed after the event handler has returned.

The OldPath parameter specifies the current path of the folder.

The NewPath parameter specifies the new path of the folder.

When the event is fired, the ResultCode parameter will always be 0. However, if the event cannot be handled successfully due to reasons such as unavailable resources or failed security checks, you can set it to an appropriate value to report an error. Please refer to the Error Codes section for the set of possible values. In case an unhandled exception occurs within the event handler, the class will catch it and report an internal error.

on_rename_item Event

This event fires when a local file is about to be renamed or moved, enabling the change to be reflected in the corresponding remote item.

Syntax

class CBSyncRenameItemEventParams(object):
  @property
  def task_id() -> int: ...

  @property
  def old_path() -> str: ...

  @property
  def new_path() -> str: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBSync:
@property
def on_rename_item() -> Callable[[CBSyncRenameItemEventParams], None]: ...
@on_rename_item.setter
def on_rename_item(event_hook: Callable[[CBSyncRenameItemEventParams], None]) -> None: ...

Remarks

This event fires when the system needs to notify the class that the local file located at OldPath is about to be renamed or moved.

When this event fires and communication with the remote storage location is required, there are two supported methods for reporting the completion of the operation:

• If the request can be completed quickly, set the ResultCode parameter to 0 and return from this event. Do not call task_complete in this case.
• If the request cannot be completed quickly, set the ResultCode parameter to CBFSSYNC_PENDING (0x21000001) and return from this event. The communication with the remote storage location may then be completed outside of this event. After the request has been completed call task_complete to inform the class about the completion. When task_complete is called, the value of the TaskId parameter of this event must be passed to task_complete to identify the completed operation.

The TaskId parameter identifies the current operation and is required when calling the task_complete method; thus, it is important to record this value when an operation will be completed after the event handler has returned.

The OldPath parameter specifies the current path of the file.

The NewPath parameter specifies the new path of the file.

When the event is fired, the ResultCode parameter will always be 0. However, if the event cannot be handled successfully due to reasons such as unavailable resources or failed security checks, you can set it to an appropriate value to report an error. Please refer to the Error Codes section for the set of possible values. In case an unhandled exception occurs within the event handler, the class will catch it and report an internal error.

on_update_folder Event

This event fires when a folder is updated locally, enabling the update to be reflected in the corresponding remote folder.

Syntax

class CBSyncUpdateFolderEventParams(object):
  @property
  def task_id() -> int: ...

  @property
  def path() -> str: ...

  @property
  def update_flags() -> int: ...

  @property
  def attributes() -> int: ...

  @property
  def creation_time() -> datetime.datetime: ...

  @property
  def last_access_time() -> datetime.datetime: ...

  @property
  def last_modified_time() -> datetime.datetime: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBSync:
@property
def on_update_folder() -> Callable[[CBSyncUpdateFolderEventParams], None]: ...
@on_update_folder.setter
def on_update_folder(event_hook: Callable[[CBSyncUpdateFolderEventParams], None]) -> None: ...

Remarks

This event fires when the class detects a change in the metadata of the local folder identified by Path.

When changes are made to a folder's attributes, such as permissions, ownership, timestamps, or other metadata, the event enables the corresponding attributes in the remote storage to be updated to match the local changes.

When this event fires and communication with the remote storage location is required, there are two supported methods for reporting the completion of the operation:

• If the request can be completed quickly, set the ResultCode parameter to 0 and return from this event. Do not call task_complete in this case.
• If the request cannot be completed quickly, set the ResultCode parameter to CBFSSYNC_PENDING (0x21000001) and return from this event. The communication with the remote storage location may then be completed outside of this event. After the request has been completed call task_complete to inform the class about the completion. When task_complete is called, the value of the TaskId parameter of this event must be passed to task_complete to identify the completed operation.

The TaskId parameter identifies the current operation and is required when calling the task_complete method; thus, it is important to record this value when an operation will be completed after the event handler has returned.

The Path parameter represents the path of the folder relative to the synchronization root; for example, "/MyFolder/MyOtherFolder".

The CreationTime, LastAccessTime, and LastModifiedTime parameters contain the corresponding time value, specified in UTC.

The Attributes parameter is a bitmask defining the attributes of the folder. The possible attributes include:

The UpdateFlags parameter indicates which information has been updated. This value is a combination of the following flags:

When the event is fired, the ResultCode parameter will always be 0. However, if the event cannot be handled successfully due to reasons such as unavailable resources or failed security checks, you can set it to an appropriate value to report an error. Please refer to the Error Codes section for the set of possible values. In case an unhandled exception occurs within the event handler, the class will catch it and report an internal error.

on_update_item Event

This event fires when a file is updated locally, enabling the update to be reflected in the corresponding remote item.

Syntax

class CBSyncUpdateItemEventParams(object):
  @property
  def task_id() -> int: ...

  @property
  def path() -> str: ...

  @property
  def update_flags() -> int: ...

  @property
  def attributes() -> int: ...

  @property
  def size() -> int: ...

  @property
  def creation_time() -> datetime.datetime: ...

  @property
  def last_access_time() -> datetime.datetime: ...

  @property
  def last_modified_time() -> datetime.datetime: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBSync:
@property
def on_update_item() -> Callable[[CBSyncUpdateItemEventParams], None]: ...
@on_update_item.setter
def on_update_item(event_hook: Callable[[CBSyncUpdateItemEventParams], None]) -> None: ...

Remarks

This event fires when the class detects a change in the metadata or data of the local file identified by Path. Scenarios in which this event is fired include:

• Modification of file content: The event captures changes to the content of a file, such as appending or removing data within a file. This ensures that the modified content can be synchronized between the local and remote storage locations.
• Modification of file attributes: When changes are made to a file's attributes, such as permissions, ownership, timestamps, or other metadata, the event enables the corresponding attributes in the remote storage to be updated to match the local changes.

When this event fires and communication with the remote storage location is required, there are two supported methods for reporting the completion of the operation:

• If the request can be completed quickly, set the ResultCode parameter to 0 and return from this event. Do not call task_complete in this case.
• If the request cannot be completed quickly, set the ResultCode parameter to CBFSSYNC_PENDING (0x21000001) and return from this event. The communication with the remote storage location may then be completed outside of this event. After the request has been completed call task_complete to inform the class about the completion. When task_complete is called, the value of the TaskId parameter of this event must be passed to task_complete to identify the completed operation.

The TaskId parameter identifies the current operation and is required when calling the task_complete method; thus, it is important to record this value when an operation will be completed after the event handler has returned.

The Path parameter represents the path of the file relative to the synchronization root; for example, "/MyFolder/MyFile.txt".

The Size parameter specifies the new size of the file.

The CreationTime, LastAccessTime, and LastModifiedTime parameters contain the corresponding time value, specified in UTC.

The Attributes parameter is a bitmask defining the attributes of the file. The possible attributes include:

The UpdateFlags parameter indicates which information has been updated. This value is a combination of the following flags:

When file contents are updated, use the get_file_path method to obtain the location of the data that should be sent to a remote storage.

When the event is fired, the ResultCode parameter will always be 0. However, if the event cannot be handled successfully due to reasons such as unavailable resources or failed security checks, you can set it to an appropriate value to report an error. Please refer to the Error Codes section for the set of possible values. In case an unhandled exception occurs within the event handler, the class will catch it and report an internal error.

CBSync Config Settings

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

CBSync Config Settings

Base Config Settings

CBSync Errors

The class uses the error codes listed below. They are also available as constants for applications' convenience. On Linux, the class uses the FUSE component error codes, i.e. Unix/Linux system error codes.

Events that include a ResultCode or ErrorCode parameter expect the value to be one of the codes listed below.

CBSync Errors

	0x21000001   CBFSSYNC_PENDING: Operation will be completed later.
	0x21000002   CBFSSYNC_ERR_SYNC_NOT_ACTIVE: Component is not active.
	0x21000003   CBFSSYNC_ERR_SYNC_IS_ACTIVE: Component is active.
	0x21000004   CBFSSYNC_ERR_INVALID_PARAMETER: Invalid parameter.
	0x21000005   CBFSSYNC_ERR_INVALID_HANDLE: Invalid handle.
	0x21000006   CBFSSYNC_ERR_OPERATION_DENIED: Operation denied.
	0x21000007   CBFSSYNC_ERR_INITIALIZATION_FAILED: Component initialization failed.
	0x21000008   CBFSSYNC_ERR_NOT_INSTALLED: The Install method must be called before performing this operation.
	0x21000010   CBFSSYNC_ERR_TOO_MANY_ITEMS: Too many items returned during enumeration.
	0x21000011   CBFSSYNC_ERR_ITEM_INFO_NOT_PROVIDED: Requested file or folder information was not provided.
	0x21000012   CBFSSYNC_ERR_ITEM_NOT_FOUND: Requested file or folder was not found.
	0x21000013   CBFSSYNC_ERR_FILE_ALREADY_EXISTS: File already exists.
	0x21000014   CBFSSYNC_ERR_INVALID_ITEM_NAME: Invalid item name returned during enumeration.
	0x21000015   CBFSSYNC_ERR_INVALID_ITEM_ID: Invalid item Id returned during enumeration.
	0x21000016   CBFSSYNC_ERR_INVALID_ATTRIBUTES: Invalid item attributes returned during enumeration.
	0x21000017   CBFSSYNC_ERR_INVALID_ITEM_PROPERTY: Invalid item property value returned during enumeration.
	0x21000030   CBFSSYNC_ERR_READ_OPERATION_ERROR: Read operation failed.
	0x21000031   CBFSSYNC_ERR_READ_OPERATION_CANCELED: Read operation canceled.
	0x21000041   CBFSSYNC_ERR_OS_ERROR: Operating system API error.

Special Use Errors

	614   ERROR_NO_CALLBACK_ACTIVE: Reported by any method that can only be called within event handlers if it is called outside an event handler.
	1314   ERROR_PRIVILEGE_NOT_HELD: Reported by any method that requires elevated permissions if it is called without such permissions.