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
-
Declaration
Swift
public let categoryType: CategoryType
-
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
-
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
-
Removes the plugin registered for
key
from the list of Plugins that implement functionality for this category. If no plugin has been added forkey
, 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()
AsynchronousDeclaration
Swift
public func reset() async
-
getURL(key:
Asynchronousoptions: ) Declaration
Swift
@available(*, deprecated, message: "Use getURL(path:options:﹚") @discardableResult public func getURL( key: String, options: StorageGetURLOperation.Request.Options? = nil ) async throws -> URL
-
getURL(path:
Asynchronousoptions: ) Declaration
Swift
@discardableResult public func getURL( path: any StoragePath, options: StorageGetURLOperation.Request.Options? = nil ) async throws -> URL
-
Declaration
Swift
@available(*, deprecated, message: "Use downloadData(path:options:﹚") @discardableResult public func downloadData( key: String, options: StorageDownloadDataOperation.Request.Options? = nil ) -> StorageDownloadDataTask
-
Declaration
Swift
@discardableResult public func downloadData( path: any StoragePath, options: StorageDownloadDataOperation.Request.Options? = nil ) -> StorageDownloadDataTask
-
Declaration
Swift
@available(*, deprecated, message: "Use downloadFile(path:options:﹚") @discardableResult public func downloadFile( key: String, local: URL, options: StorageDownloadFileOperation.Request.Options? = nil ) -> StorageDownloadFileTask
-
Declaration
Swift
@discardableResult public func downloadFile( path: any StoragePath, local: URL, options: StorageDownloadFileOperation.Request.Options? = nil ) -> StorageDownloadFileTask
-
Declaration
Swift
@available(*, deprecated, message: "Use uploadData(path:options:﹚") @discardableResult public func uploadData( key: String, data: Data, options: StorageUploadDataOperation.Request.Options? = nil ) -> StorageUploadDataTask
-
Declaration
Swift
@discardableResult public func uploadData( path: any StoragePath, data: Data, options: StorageUploadDataOperation.Request.Options? = nil ) -> StorageUploadDataTask
-
Declaration
Swift
@available(*, deprecated, message: "Use uploadFile(path:options:﹚") @discardableResult public func uploadFile( key: String, local: URL, options: StorageUploadFileOperation.Request.Options? = nil ) -> StorageUploadFileTask
-
Declaration
Swift
@discardableResult public func uploadFile( path: any StoragePath, local: URL, options: StorageUploadFileOperation.Request.Options? = nil ) -> StorageUploadFileTask
-
remove(key:
Asynchronousoptions: ) Declaration
Swift
@available(*, deprecated, message: "Use remove(path:options:﹚") @discardableResult public func remove( key: String, options: StorageRemoveRequest.Options? = nil ) async throws -> String
-
remove(path:
Asynchronousoptions: ) Declaration
Swift
@discardableResult public func remove( path: any StoragePath, options: StorageRemoveRequest.Options? = nil ) async throws -> String
-
list(options:
Asynchronous) Declaration
Swift
@available(*, deprecated, message: "Use list(path:options:﹚") @discardableResult public func list( options: StorageListOperation.Request.Options? = nil ) async throws -> StorageListResult
-
list(path:
Asynchronousoptions: ) Declaration
Swift
@discardableResult public func list( path: any StoragePath, options: StorageListOperation.Request.Options? = nil ) async throws -> StorageListResult
-
handleBackgroundEvents(identifier:
Asynchronous) Declaration
Swift
public func handleBackgroundEvents(identifier: String) async -> Bool
-
Declaration
Swift
public static var log: Logger { get }
-
Declaration
Swift
public var log: Logger { get }