SwiftKit/data/documentation/swiftkit/keychainitemaccessibility.json

{"seeAlsoSections":[{"title":"Keychain","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainReader","doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainService","doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainWrapper","doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainWriter","doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardKeychainService","doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainAttrRepresentable"],"generated":true}],"schemaVersion":{"major":0,"minor":2,"patch":0},"metadata":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"KeychainItemAccessibility"}],"title":"KeychainItemAccessibility","roleHeading":"Enumeration","role":"symbol","symbolKind":"enum","externalID":"s:8SwiftKit25KeychainItemAccessibilityO","modules":[{"name":"SwiftKit"}],"navigatorTitle":[{"kind":"identifier","text":"KeychainItemAccessibility"}]},"abstract":[{"type":"text","text":"This enum defines the various access scopes that a keychain"},{"type":"text","text":" "},{"type":"text","text":"item can use. The names follow certain conventions that are"},{"type":"text","text":" "},{"type":"text","text":"defined in the list below:"}],"sections":[],"identifier":{"url":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainItemAccessibility","interfaceLanguage":"swift"},"relationshipsSections":[{"identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainAttrRepresentable","doc:\/\/SwiftKit\/SQ","doc:\/\/SwiftKit\/SH"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"hierarchy":{"paths":[["doc:\/\/SwiftKit\/documentation\/SwiftKit"]]},"topicSections":[{"title":"Enumeration Cases","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainItemAccessibility\/afterFirstUnlock","doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainItemAccessibility\/afterFirstUnlockThisDeviceOnly","doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainItemAccessibility\/whenPasscodeSetThisDeviceOnly","doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainItemAccessibility\/whenUnlocked","doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainItemAccessibility\/whenUnlockedThisDeviceOnly"]},{"title":"Default Implementations","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainItemAccessibility\/Equatable-Implementations","doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainItemAccessibility\/KeychainAttrRepresentable-Implementations"],"generated":true}],"variants":[{"paths":["\/documentation\/swiftkit\/keychainitemaccessibility"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"KeychainItemAccessibility"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"anchor":"overview","level":2,"type":"heading","text":"Overview"},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"codeVoice","code":"afterFirstUnlock"},{"type":"text","text":" "},{"type":"text","text":"The attribute cannot be accessed after a restart, until the"},{"type":"text","text":" "},{"type":"text","text":"device has been unlocked once by the user. After this first"},{"type":"text","text":" "},{"type":"text","text":"unlock, the items remains accessible until the next restart."},{"type":"text","text":" "},{"type":"text","text":"This is recommended for items that must be available to any"},{"type":"text","text":" "},{"type":"text","text":"background applications or processes."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"codeVoice","code":"ThisDeviceOnly"},{"type":"text","text":" "},{"type":"text","text":"The attribute will not be included in encrypted backup, and"},{"type":"text","text":" "},{"type":"text","text":"are thus not available after restoring apps from backups on"},{"type":"text","text":" "},{"type":"text","text":"a different device."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"codeVoice","code":"whenPasscodeSet"},{"type":"text","text":" "},{"type":"text","text":"The attribute can only be accessed when the device has been"},{"type":"text","text":" "},{"type":"text","text":"unlocked by the user and a device passcode is set. No items"},{"type":"text","text":" "},{"type":"text","text":"can be stored on device if a passcode is not set. Disabling"},{"type":"text","text":" "},{"type":"text","text":"the passcode will delete all items."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"codeVoice","code":"whenUnlocked"},{"type":"text","text":" "},{"type":"text","text":"The attribute can only be accessed when the device has been"},{"type":"text","text":" "},{"type":"text","text":"unlocked by the user. This is recommended for items that we"},{"type":"text","text":" "},{"type":"text","text":"only mean to use when the application is active."}]}]}]}]}],"references":{"doc://SwiftKit/documentation/SwiftKit/KeychainItemAccessibility/whenPasscodeSetThisDeviceOnly":{"role":"symbol","title":"KeychainItemAccessibility.whenPasscodeSetThisDeviceOnly","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"whenPasscodeSetThisDeviceOnly"}],"abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainItemAccessibility\/whenPasscodeSetThisDeviceOnly","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/keychainitemaccessibility\/whenpasscodesetthisdeviceonly"},"doc://SwiftKit/documentation/SwiftKit/KeychainWrapper":{"role":"symbol","title":"KeychainWrapper","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"KeychainWrapper"}],"abstract":[{"type":"text","text":"This class help make device keychain access easier in Swift."},{"type":"text","text":" "},{"type":"text","text":"It is designed to make accessing the Keychain services more"},{"type":"text","text":" "},{"type":"text","text":"like using "},{"type":"codeVoice","code":"NSUserDefaults"},{"type":"text","text":", which is much more familiar to"},{"type":"text","text":" "},{"type":"text","text":"developers in general."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainWrapper","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"KeychainWrapper"}],"url":"\/documentation\/swiftkit\/keychainwrapper"},"doc://SwiftKit/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/SwiftKit\/SH"},"doc://SwiftKit/documentation/SwiftKit/KeychainItemAccessibility/afterFirstUnlockThisDeviceOnly":{"role":"symbol","title":"KeychainItemAccessibility.afterFirstUnlockThisDeviceOnly","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"afterFirstUnlockThisDeviceOnly"}],"abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainItemAccessibility\/afterFirstUnlockThisDeviceOnly","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/keychainitemaccessibility\/afterfirstunlockthisdeviceonly"},"doc://SwiftKit/documentation/SwiftKit/KeychainItemAccessibility/whenUnlockedThisDeviceOnly":{"role":"symbol","title":"KeychainItemAccessibility.whenUnlockedThisDeviceOnly","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"whenUnlockedThisDeviceOnly"}],"abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainItemAccessibility\/whenUnlockedThisDeviceOnly","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/keychainitemaccessibility\/whenunlockedthisdeviceonly"},"doc://SwiftKit/documentation/SwiftKit/StandardKeychainService":{"role":"symbol","title":"StandardKeychainService","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"StandardKeychainService"}],"abstract":[{"type":"text","text":"This is a standard implementation of "},{"type":"codeVoice","code":"KeychainService"},{"type":"text","text":" that"},{"type":"text","text":" "},{"type":"text","text":"uses a "},{"type":"codeVoice","code":"KeychainWrapper"},{"type":"text","text":" to sync data with the keychain."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardKeychainService","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StandardKeychainService"}],"url":"\/documentation\/swiftkit\/standardkeychainservice"},"doc://SwiftKit/documentation/SwiftKit/KeychainReader":{"role":"symbol","title":"KeychainReader","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"KeychainReader"}],"abstract":[{"type":"text","text":"This protocol can be implemented by keychain-based services"},{"type":"text","text":" "},{"type":"text","text":"that can read from the device keychain."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainReader","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"KeychainReader"}],"url":"\/documentation\/swiftkit\/keychainreader"},"doc://SwiftKit/documentation/SwiftKit":{"role":"collection","title":"SwiftKit","abstract":[{"type":"text","text":"SwiftKit adds extra functionality to the Swift framework, like extensions to native types, utilites, services etc."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit"},"doc://SwiftKit/documentation/SwiftKit/KeychainItemAccessibility/Equatable-Implementations":{"role":"collectionGroup","title":"Equatable Implementations","abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainItemAccessibility\/Equatable-Implementations","kind":"article","type":"topic","url":"\/documentation\/swiftkit\/keychainitemaccessibility\/equatable-implementations"},"doc://SwiftKit/documentation/SwiftKit/KeychainItemAccessibility/whenUnlocked":{"role":"symbol","title":"KeychainItemAccessibility.whenUnlocked","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"whenUnlocked"}],"abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainItemAccessibility\/whenUnlocked","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/keychainitemaccessibility\/whenunlocked"},"doc://SwiftKit/documentation/SwiftKit/KeychainAttrRepresentable":{"role":"symbol","title":"KeychainAttrRepresentable","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"KeychainAttrRepresentable"}],"abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainAttrRepresentable","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"KeychainAttrRepresentable"}],"url":"\/documentation\/swiftkit\/keychainattrrepresentable"},"doc://SwiftKit/documentation/SwiftKit/KeychainItemAccessibility/afterFirstUnlock":{"role":"symbol","title":"KeychainItemAccessibility.afterFirstUnlock","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"afterFirstUnlock"}],"abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainItemAccessibility\/afterFirstUnlock","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/keychainitemaccessibility\/afterfirstunlock"},"doc://SwiftKit/documentation/SwiftKit/KeychainWriter":{"role":"symbol","title":"KeychainWriter","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"KeychainWriter"}],"abstract":[{"type":"text","text":"This protocol can be implemented by keychain-based services"},{"type":"text","text":" "},{"type":"text","text":"that can write to the user’s keychain."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainWriter","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"KeychainWriter"}],"url":"\/documentation\/swiftkit\/keychainwriter"},"doc://SwiftKit/documentation/SwiftKit/KeychainItemAccessibility/KeychainAttrRepresentable-Implementations":{"role":"collectionGroup","title":"KeychainAttrRepresentable Implementations","abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainItemAccessibility\/KeychainAttrRepresentable-Implementations","kind":"article","type":"topic","url":"\/documentation\/swiftkit\/keychainitemaccessibility\/keychainattrrepresentable-implementations"},"doc://SwiftKit/documentation/SwiftKit/KeychainService":{"role":"symbol","title":"KeychainService","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"KeychainService"}],"abstract":[{"type":"text","text":"This protocol can be implemented by keychain-based services"},{"type":"text","text":" "},{"type":"text","text":"that can read from and write to the device keychain."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainService","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"KeychainService"}],"url":"\/documentation\/swiftkit\/keychainservice"},"doc://SwiftKit/documentation/SwiftKit/KeychainItemAccessibility":{"role":"symbol","title":"KeychainItemAccessibility","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"KeychainItemAccessibility"}],"abstract":[{"type":"text","text":"This enum defines the various access scopes that a keychain"},{"type":"text","text":" "},{"type":"text","text":"item can use. The names follow certain conventions that are"},{"type":"text","text":" "},{"type":"text","text":"defined in the list below:"}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainItemAccessibility","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"KeychainItemAccessibility"}],"url":"\/documentation\/swiftkit\/keychainitemaccessibility"},"doc://SwiftKit/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/SwiftKit\/SQ"}}}