StorageDownloadFileRequest

public struct StorageDownloadFileRequest : AmplifyOperationRequest

Represents a request to download an individual object as a file, initiated by an implementation of the StorageCategoryPlugin protocol.

  • Tag: StorageDownloadFileRequest

  • The path for the object in storage

    • Tag: StorageDownloadFileRequest.path

    Declaration

    Swift

    public let path: (any StoragePath)?
  • key

    The unique identifier for the object in storage

    • Tag: StorageDownloadFileRequest.key

    Declaration

    Swift

    @available(*, deprecated, message: "Use `path` instead of `key`")
public let key: String

  • The local file to download the object to

    • Tag: StorageDownloadFileRequest.local

    Declaration

    Swift

    public let local: URL

  • Options to adjust the behavior of this request, including plugin options

    • Tag: StorageDownloadFileRequest.options

    Declaration

    Swift

    public let options: Options
    • Tag: StorageDownloadFileRequest.init

    Declaration

    Swift

    @available(*, deprecated, message: "Use init(path:local:options﹚")
public init(key: String, local: URL, options: Options)
    • Tag: StorageDownloadFileRequest.init

    Declaration

    Swift

    public init(path: any StoragePath, local: URL, options: Options)

  • Options to adjust the behavior of this request, including plugin-options

    • Tag: StorageDownloadFileRequestOptions
    See more

    Declaration

    Swift

    struct Options