AGSKeychainItem.h

Go to the documentation of this file.

/*
 COPYRIGHT 1995-2020 ESRI
 
 TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
 Unpublished material - all rights reserved under the
 Copyright Laws of the United States and applicable international
 laws, treaties, and conventions.
 
 For additional information, contact:
 Environmental Systems Research Institute, Inc.
 Attn: Contracts and Legal Services Department
 380 New York Street
 Redlands, California, 92373
 USA
 
 email: contracts@esri.com
 */
 //Required for Globals API doc

#import <Foundation/Foundation.h>



typedef NS_ENUM(NSInteger, AGSKeychainItemAccessible) {
    AGSKeychainItemAccessibleAfterFirstUnlock = 0,
    AGSKeychainItemAccessibleAfterFirstUnlockThisDeviceOnly,
    AGSKeychainItemAccessibleAlways API_DEPRECATED("Use an accessibility level that provides some user protection, such as AGSKeychainItemAccessibleAfterFirstUnlock", macos(10.9, 10.14), ios(4.0, 12.0)),
    AGSKeychainItemAccessibleWhenPasscodeSetThisDeviceOnly,
    AGSKeychainItemAccessibleAlwaysThisDeviceOnly API_DEPRECATED("Use an accessibility level that provides some user protection, such as AGSKeychainItemAccessibleAfterFirstUnlockThisDeviceOnly", macos(10.9, 10.14), ios(4.0, 12.0)),
    AGSKeychainItemAccessibleWhenUnlocked,
    AGSKeychainItemAccessibleWhenUnlockedThisDeviceOnly
};

@interface AGSKeychainItem : NSObject

#pragma mark -
#pragma mark initializers



-(instancetype)initWithIdentifier:(NSString*)identifier accessGroup:(nullable NSString*)accessGroup acrossDevices:(BOOL)acrossDevices;

+(instancetype)keychainItemWithIdentifier:(NSString*)identifier accessGroup:(nullable NSString*)accessGroup acrossDevices:(BOOL)acrossDevices;

-(instancetype)initWithIdentifier:(NSString*)identifier accessGroup:(nullable NSString*)accessGroup acrossDevices:(BOOL)acrossDevices accessible:(AGSKeychainItemAccessible)accessible;

+(instancetype)keychainItemWithIdentifier:(NSString*)identifier accessGroup:(nullable NSString*)accessGroup acrossDevices:(BOOL)acrossDevices accessible:(AGSKeychainItemAccessible)accessible;

#pragma mark -
#pragma mark properties

@property (nonatomic, copy, readonly) NSString *identifier;

@property (nullable, nonatomic, copy, readonly) NSString *accessGroup;

@property (nonatomic, assign, readonly) BOOL sharedAcrossDevices;

#pragma mark -
#pragma mark methods

-(void)writeObjectToKeychain:(id<NSCoding>)object completion:(nullable void(^)(NSError * __nullable error))completion;

-(nullable id<NSCoding>)readObjectFromKeychain;

-(void)removeObjectFromKeychainWithCompletion:(nullable void(^)(NSError * __nullable error))completion;

@end