Inherits from NSObject
Declared in DBSyncStatus.h

Overview

The current status of background synchronization for a DBFilesystem.

Tasks

  •   active

    Background synchronization is actively processing or waiting for changes. Syncing is active when a DBFilesystem is first created until it completes its first file info sync. After that point it is active whenever there are changes to download or upload, or when there are any files open or path observers registered.

    property
  •   metadata

    Status of synchronizing info about files and folders. Metadata sync is only considered in progress when it is actively processing new changes, not when it is simply watching for changes.

    property
  •   download

    Status of downloading file contents into the cache.

    property
  •   upload

    Status of uploading changes to the server. This includes changes to file contents, as well as creation, deletion, and renames.

    property
  •   anyInProgress

    Convenience property for checking whether any type of operation is in progress.

    property
  •   anyError

    Convenience property for determining whether any operation failed, and getting an appropriate DBError. If there are multiple failures, the DBError returned will be taken from metadata, download, or upload status in that order.

    property

Properties

active

@property (nonatomic, readonly) BOOL active
Discussion

Background synchronization is actively processing or waiting for changes. Syncing is active when a DBFilesystem is first created until it completes its first file info sync. After that point it is active whenever there are changes to download or upload, or when there are any files open or path observers registered.

Declared In

DBSyncStatus.h

anyError

@property (nonatomic, readonly) DBSyncOperationStatus *anyError
Discussion

Convenience property for determining whether any operation failed, and getting an appropriate DBError. If there are multiple failures, the DBError returned will be taken from metadata, download, or upload status in that order.

Declared In

DBSyncStatus.h

anyInProgress

@property (nonatomic, readonly) BOOL anyInProgress
Discussion

Convenience property for checking whether any type of operation is in progress.

Declared In

DBSyncStatus.h

download

@property (nonatomic, readonly) DBSyncOperationStatus *download
Discussion

Status of downloading file contents into the cache.

Declared In

DBSyncStatus.h

metadata

@property (nonatomic, readonly) DBSyncOperationStatus *metadata
Discussion

Status of synchronizing info about files and folders. Metadata sync is only considered in progress when it is actively processing new changes, not when it is simply watching for changes.

Declared In

DBSyncStatus.h

upload

@property (nonatomic, readonly) DBSyncOperationStatus *upload
Discussion

Status of uploading changes to the server. This includes changes to file contents, as well as creation, deletion, and renames.

Declared In

DBSyncStatus.h