Inherits from NSObject
Declared in DBFileStatus.h

Overview

The file status object exposes information about the file’s current sync status, including whether it’s cached, if it’s uploading or downloading, and the progress of an upload or download.

Tasks

Basic information

  •   cached

    Whether the contents of the file are cached locally and can be read without making a network request.

    property

Transfer information

  •   state

    Whether the file is currently uploading, downloading, or neither (idle)

    property
  •   progress

    If the file is transferring, the progress of the transfer, between 0 and 1.

    property
  •   error

    If the file needs to be transferred, but can’t for whatever reason (such as no internet connection), then this property is set to the last error that prevented the transfer.

    property

Properties

cached

@property (nonatomic, readonly) BOOL cached
Discussion

Whether the contents of the file are cached locally and can be read without making a network request.

Declared In

DBFileStatus.h

error

@property (nonatomic, readonly) DBError *error
Discussion

If the file needs to be transferred, but can’t for whatever reason (such as no internet connection), then this property is set to the last error that prevented the transfer.

Declared In

DBFileStatus.h

progress

@property (nonatomic, readonly) float progress
Discussion

If the file is transferring, the progress of the transfer, between 0 and 1.

Declared In

DBFileStatus.h

state

@property (nonatomic, readonly) DBFileState state
Discussion

Whether the file is currently uploading, downloading, or neither (idle)

Declared In

DBFileStatus.h