ORKKeychainWrapper Class Reference

Inherits from	NSObject
Declared in	ORKKeychainWrapper.h

The ORKKeychainWrapper class is an abstraction layer for the iOS keychain communication.

Sets the given object in the keychain for the provided key.

+ (BOOL)setObject:(id<NSSecureCoding>)object forKey:(NSString *)key error:(NSError *_Nullable *)error

`object`	The data to be stored in the keychain.
`key`	The key used to set the data in the keychain.
`error`	If failure occurred, an `NSError` object indicating the reason for the failure. The value of this parameter is `nil` if `result` does not indicate failure.

A boolean with a value YES if the object was saved; otherwise `NO'.

ORKKeychainWrapper.h

Returns the object in the keychain for the provided key.

+ (nullable id<NSSecureCoding>)objectForKey:(nonnull NSString *)key error:(NSError *__autoreleasing _Nullable *)error

`key`	The key used to set the data in the keychain.
`error`	If failure occurred, an `NSError` object indicating the reason for the failure. The value of this parameter is `nil` if `result` does not indicate failure.

An object or nil if key is not valid.

ORKKeychainWrapper.h

Removes the object in the keychain for the provided key.

+ (BOOL)removeObjectForKey:(NSString *)key error:(NSError *_Nullable *)error

`key`	The key used to set the value in the keychain.
`error`	If failure occurred, an `NSError` object indicating the reason for the failure. The value of this parameter is `nil` if `result` does not indicate failure.

A boolean with a value YES if the object was removed; otherwise `NO'.

ORKKeychainWrapper.h

Removes all values stored in the keychain for the app.

+ (BOOL)resetKeychainWithError:(NSError *_Nullable *)error

`error`	If failure occurred, an `NSError` object indicating the reason for the failure. The value of this parameter is `nil` if `result` does not indicate failure.

A boolean with a value YES if the keychain was reset; otherwise `NO'.

ORKKeychainWrapper.h