Options

struct Options

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

  • Tag: StorageUploadFileRequestOptions

  • Access level of the storage system. Defaults to public

    • Tag: StorageUploadFileRequestOptions.accessLevel

    Declaration

    Swift

    @available(*, deprecated, message: "Use `path` in Storage API instead of `Options`")
public let accessLevel: StorageAccessLevel

  • Target user to apply the action on.

    • Tag: StorageUploadFileRequestOptions.targetIdentityId

    Declaration

    Swift

    @available(*, deprecated, message: "Use `path` in Storage API instead of `Options`")
public let targetIdentityId: String?

  • Metadata for the object to store

    • Tag: StorageUploadFileRequestOptions.metadata

    Declaration

    Swift

    public let metadata: [String : String]?

  • A specific Storage Bucket to upload the file. Defaults to nil, in which case the default one will be used.

    • Tag: StorageUploadFileRequestOptions.bucket

    Declaration

    Swift

    public let bucket: (any StorageBucket)?

  • The standard MIME type describing the format of the object to store

    • Tag: StorageUploadFileRequestOptions.contentType

    Declaration

    Swift

    public let contentType: String?

  • Extra plugin specific options, only used in special circumstances when the existing options do not provide a way to utilize the underlying storage system’s functionality. See plugin documentation for expected key/values

    • Tag: StorageUploadFileRequestOptions.pluginOptions

    Declaration

    Swift

    public let pluginOptions: Any?
    • Tag: StorageUploadFileRequestOptions.init

    Declaration

    Swift

    @available(*, deprecated, message: "Use init(metadata:contentType:pluginOptions﹚")
public init(
    accessLevel: StorageAccessLevel = .guest,
    targetIdentityId: String? = nil,
    metadata: [String: String]? = nil,
    contentType: String? = nil,
    pluginOptions: Any? = nil
)
    • Tag: StorageUploadFileRequestOptions.init

    Declaration

    Swift

    public init(
    metadata: [String: String]? = nil,
    contentType: String? = nil,
    pluginOptions: Any? = nil
)
    • Tag: StorageUploadFileRequestOptions.init

    Declaration

    Swift

    public init(
    metadata: [String: String]? = nil,
    bucket: some StorageBucket,
    contentType: String? = nil,
    pluginOptions: Any? = nil
)