StorageCategory

final public class StorageCategory : Category

extension StorageCategory: Resettable

extension StorageCategory: StorageCategoryBehavior

extension StorageCategory: DefaultLogger

AWS Amplify Storage module provides a simple mechanism for managing user content for your app in public, protected or private storage buckets.

Tag: StorageCategory

categoryType
Declaration
Swift

public let categoryType: CategoryType

Plugin handling


                    
                    
                    add(plugin:)

Adds plugin to the list of Plugins that implement functionality for this category.

Declaration

Swift

public func add(plugin: StorageCategoryPlugin) throws

Parameters


                                plugin

The Plugin to add


                    
                    
                    getPlugin(for:)

Returns the added plugin with the specified key property.

Declaration

Swift

public func getPlugin(for key: PluginKey) throws -> StorageCategoryPlugin

Parameters

key

The PluginKey (String) of the plugin to retrieve

Return Value

The wrapped plugin


                    
                    
                    removePlugin(for:)

Removes the plugin registered for key from the list of Plugins that implement functionality for this category. If no plugin has been added for key, no action is taken, making this method safe to call multiple times.

Declaration

Swift

public func removePlugin(for key: PluginKey)

Parameters

key

The key used to add the plugin

reset() Asynchronous
Declaration
Swift

public func reset() async


                    
                    
                    getURL(key:options:)

Asynchronous

Declaration

Swift

@discardableResult
public func getURL(
    key: String,
    options: StorageGetURLOperation.Request.Options? = nil
) async throws -> URL


                    
                    
                    downloadData(key:options:)

Declaration

Swift

@discardableResult
public func downloadData(
    key: String,
    options: StorageDownloadDataOperation.Request.Options? = nil
) -> StorageDownloadDataTask


                    
                    
                    downloadFile(key:local:options:)

Declaration

Swift

@discardableResult
public func downloadFile(
    key: String,
    local: URL,
    options: StorageDownloadFileOperation.Request.Options? = nil
) -> StorageDownloadFileTask


                    
                    
                    uploadData(key:data:options:)

Declaration

Swift

@discardableResult
public func uploadData(
    key: String,
    data: Data,
    options: StorageUploadDataOperation.Request.Options? = nil
) -> StorageUploadDataTask


                    
                    
                    uploadFile(key:local:options:)

Declaration

Swift

@discardableResult
public func uploadFile(
    key: String,
    local: URL,
    options: StorageUploadFileOperation.Request.Options? = nil
) -> StorageUploadFileTask


                    
                    
                    remove(key:options:)

Asynchronous

Declaration

Swift

@discardableResult
public func remove(
    key: String,
    options: StorageRemoveRequest.Options? = nil
) async throws -> String


                    
                    
                    list(options:)

Asynchronous

Declaration

Swift

@discardableResult
public func list(
    options: StorageListOperation.Request.Options? = nil
) async throws -> StorageListResult


                    
                    
                    handleBackgroundEvents(identifier:)

Asynchronous

Declaration

Swift

public func handleBackgroundEvents(identifier: String) async -> Bool

log
Declaration
Swift

public static var log: Logger { get }
log
Declaration
Swift

public var log: Logger { get }