KeychainStorageDelegate Class Reference


                    
                    
                    accessGroup

Access group where StorageData is in.

Declaration

Swift

open var accessGroup: String?

Show on GitHub


                    
                    
                    synchronizable

Whether the StorageData can be synchronized.

Declaration

Swift

open var synchronizable: Bool

Show on GitHub


                    
                    
                    accessible

When StorageData can be accessed in the keychain.

Declaration

Swift

open var accessible: CFString

Show on GitHub


                    
                    
                    init()

Create a KeychainStorageDelegate.

Declaration

Swift

public init()

Show on GitHub


                    
                    
                    data(forKey:)

Get StorageData for StoreKey from the keychain.

Throws

KeychainError.error.

Declaration

Swift

open func data<D>(forKey key: StoreKey) throws -> D? where D : StorageData

Parameters

key

StoreKey to store the StorageData.

Return Value

StorageData for StoreKey.

Show on GitHub


                    
                    
                    set(_:forKey:)

Set StorageData for StoreKey in the keychain.

Throws

KeychainError.error.

Declaration

Swift

open func set<D>(_ data: D?, forKey key: StoreKey) throws where D : StorageData

Parameters

`data`	`StorageData` to store.
`key`	`StoreKey` to store the `StorageData`.

Show on GitHub


                    
                    
                    remove(forKey:)

Remove StorageData for StoreKey from the keychain.

Throws

KeychainError.error.

Declaration

Swift

open func remove(forKey key: StoreKey) throws

Parameters

key

StoreKey to remove.

Show on GitHub


                    
                    
                    store(_:account:accessible:accessGroup:synchronizable:)

Store StorageData for account in the keychain.

Throws

KeychainError.error.

Declaration

Swift

open func store<D: StorageData>(_ value: D,
                                account: String,
                                accessible: CFString,
                                accessGroup: String?,
                                synchronizable: Bool) throws

Parameters

`value`	`StorageData` to store.
`account`	Item’s account name.
`accessible`	When the keychain item is accessible.
`accessGroup`	Access group where `StorageData` is in.
`synchronizable`	Whether the `StorageData` can be synchronized.

Show on GitHub


                    
                    
                    read(account:accessGroup:synchronizable:)

Read StorageData for account from the keychain.

Throws

KeychainError.error.

Declaration

Swift

open func read<D: StorageData>(account: String,
                               accessGroup: String?,
                               synchronizable: Bool) throws -> D?

Parameters

`account`	Item’s account name.
`accessGroup`	Access group where `StorageData` is in.
`synchronizable`	Whether the `StorageData` can be synchronized.

Return Value

StorageData for account.

Show on GitHub


                    
                    
                    delete(account:accessGroup:synchronizable:)

Delete item for account from the keychain.

Throws

KeychainError.error.

Declaration

Swift

open func delete(account: String,
                 accessGroup: String?,
                 synchronizable: Bool) throws

Parameters

`account`	Item’s account name.
`accessGroup`	Access group where `StorageData` is in.
`synchronizable`	Whether the `StorageData` can be synchronized.

Show on GitHub