Options

struct Options

Options available to callers of StorageCategoryBehavior.list.

Tag: StorageListRequestOptions

  • Access level of the storage system. Defaults to public

    • Tag: StorageListRequestOptions.accessLevel

    Declaration

    Swift

    public let accessLevel: StorageAccessLevel

  • Target user to apply the action on

    • Tag: StorageListRequestOptions.targetIdentityId

    Declaration

    Swift

    public let targetIdentityId: String?

  • Path to the keys

    • Tag: StorageListRequestOptions.path

    Declaration

    Swift

    public let path: String?

  • Number between 1 and 1,000 that indicates the limit of how many entries to fetch when retreiving file lists from the server.

    NOTE: Plugins may decide to throw or perform normalization when encoutering vaues outside the specified range.

    See also

    StorageListRequestOptions.nextToken StorageListResult.nextToken

    • Tag: StorageListRequestOptions.pageSize

    Declaration

    Swift

    public let pageSize: UInt

  • Opaque string indicating the page offset at which to resume a listing. This is usually a copy of the value from StorageListResult.nextToken.

    See also

    StorageListRequestOptions.pageSize StorageListResult.nextToken

    • Tag: StorageListRequestOptions.nextToken

    Declaration

    Swift

    public let nextToken: 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: StorageListRequestOptions.pluginOptions

    Declaration

    Swift

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

    Declaration

    Swift

    public init(accessLevel: StorageAccessLevel = .guest,
            targetIdentityId: String? = nil,
            path: String? = nil,
            pageSize: UInt = 1000,
            nextToken: String? = nil,
            pluginOptions: Any? = nil)