Type-Definitions

The following type definitions are available globally.

  • NSString typedef representing a task listener handle.

    Declaration

    Swift

    typealias StorageHandle = NSString

  • Block typedef typically used when downloading data.

    Declaration

    Swift

    typealias StorageVoidDataError = (Data?, Error?) -> Void

    Parameters

    data

    The data returned by the download, or nil if no data available or download failed.
    error

    The error describing failure, if one occurred.

  • Block typedef typically used when performing binary async operations such as delete, where the operation either succeeds without an error or fails with an error.

    Declaration

    Swift

    typealias StorageVoidError = (Error?) -> Void

    Parameters

    error

    The error describing failure, if one occurred.

  • Block typedef typically used when retrieving metadata.

    Declaration

    Swift

    typealias StorageVoidMetadata = (FIRStorageMetadata?) -> Void

    Parameters

    metadata

    The metadata returned by the operation, if metadata exists.

  • Block typedef typically used when retrieving metadata with the possibility of an error.

    Declaration

    Swift

    typealias StorageVoidMetadataError = (FIRStorageMetadata?, Error?) -> Void

    Parameters

    metadata

    The metadata returned by the operation, if metadata exists.
    error

    The error describing failure, if one occurred.

  • Block typedef typically used to asynchronously return a storage task snapshot.

    Declaration

    Swift

    typealias StorageVoidSnapshot = (FIRStorageTaskSnapshot) -> Void

    Parameters

    snapshot

    The returned task snapshot.

  • Block typedef typically used when retrieving a download URL.

    Declaration

    Swift

    typealias StorageVoidURLError = (URL?, Error?) -> Void

    Parameters

    URL

    The download URL associated with the operation.
    error

    The error describing failure, if one occurred.