SwiftKit/data/documentation/swiftkit/keychainbaseddeviceidentifier.json

{"seeAlsoSections":[{"title":"Device","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/DeviceIdentifier","doc:\/\/SwiftKit\/documentation\/SwiftKit\/UserDefaultsBasedDeviceIdentifier"],"generated":true}],"schemaVersion":{"major":0,"minor":2,"patch":0},"metadata":{"fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"KeychainBasedDeviceIdentifier"}],"title":"KeychainBasedDeviceIdentifier","roleHeading":"Class","role":"symbol","symbolKind":"class","externalID":"s:8SwiftKit29KeychainBasedDeviceIdentifierC","modules":[{"name":"SwiftKit"}],"navigatorTitle":[{"kind":"identifier","text":"KeychainBasedDeviceIdentifier"}]},"abstract":[{"type":"text","text":"This device identifier generates a unique device identifier"},{"type":"text","text":" "},{"type":"text","text":"and stores it in keychain, to make it possible to reuse the"},{"type":"text","text":" "},{"type":"text","text":"identifier, even if the app is uninstalled."}],"sections":[],"identifier":{"url":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainBasedDeviceIdentifier","interfaceLanguage":"swift"},"relationshipsSections":[{"identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/DeviceIdentifier"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"hierarchy":{"paths":[["doc:\/\/SwiftKit\/documentation\/SwiftKit"]]},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainBasedDeviceIdentifier\/init(keychainService:backupIdentifier:)"]},{"title":"Instance Methods","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainBasedDeviceIdentifier\/getDeviceIdentifier()"]}],"variants":[{"paths":["\/documentation\/swiftkit\/keychainbaseddeviceidentifier"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"KeychainBasedDeviceIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"anchor":"overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The user default fallback maximizes the chance that the app"},{"type":"text","text":" "},{"type":"text","text":"can retrieve the identifier even if the keychain can not be"},{"type":"text","text":" "},{"type":"text","text":"read at the time of retrieval."}]}]}],"references":{"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/KeychainBasedDeviceIdentifier":{"role":"symbol","title":"KeychainBasedDeviceIdentifier","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"KeychainBasedDeviceIdentifier"}],"abstract":[{"type":"text","text":"This device identifier generates a unique device identifier"},{"type":"text","text":" "},{"type":"text","text":"and stores it in keychain, to make it possible to reuse the"},{"type":"text","text":" "},{"type":"text","text":"identifier, even if the app is uninstalled."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainBasedDeviceIdentifier","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"KeychainBasedDeviceIdentifier"}],"url":"\/documentation\/swiftkit\/keychainbaseddeviceidentifier"},"doc://SwiftKit/documentation/SwiftKit/KeychainBasedDeviceIdentifier/init(keychainService:backupIdentifier:)":{"role":"symbol","title":"init(keychainService:backupIdentifier:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keychainService"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"KeychainService","preciseIdentifier":"s:8SwiftKit15KeychainServiceP"},{"kind":"text","text":", "},{"kind":"externalParam","text":"backupIdentifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"DeviceIdentifier","preciseIdentifier":"s:8SwiftKit16DeviceIdentifierP"},{"kind":"text","text":")"}],"abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainBasedDeviceIdentifier\/init(keychainService:backupIdentifier:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/keychainbaseddeviceidentifier\/init(keychainservice:backupidentifier:)"},"doc://SwiftKit/documentation/SwiftKit/KeychainBasedDeviceIdentifier/getDeviceIdentifier()":{"role":"symbol","title":"getDeviceIdentifier()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getDeviceIdentifier"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"Get a unique device identifier from the device keychain."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/KeychainBasedDeviceIdentifier\/getDeviceIdentifier()","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/keychainbaseddeviceidentifier\/getdeviceidentifier()"},"doc://SwiftKit/documentation/SwiftKit/DeviceIdentifier":{"role":"symbol","title":"DeviceIdentifier","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"DeviceIdentifier"}],"abstract":[{"type":"text","text":"This protocol can be implemented by anything that can get a"},{"type":"text","text":" "},{"type":"text","text":"unique device identifier for the current device."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/DeviceIdentifier","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DeviceIdentifier"}],"url":"\/documentation\/swiftkit\/deviceidentifier"},"doc://SwiftKit/documentation/SwiftKit/UserDefaultsBasedDeviceIdentifier":{"role":"symbol","title":"UserDefaultsBasedDeviceIdentifier","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserDefaultsBasedDeviceIdentifier"}],"abstract":[{"type":"text","text":"This device identifier generates a unique device identifier"},{"type":"text","text":" "},{"type":"text","text":"and stores it in user defaults, so that the same identifier"},{"type":"text","text":" "},{"type":"text","text":"is used every time for each app installation."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/UserDefaultsBasedDeviceIdentifier","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserDefaultsBasedDeviceIdentifier"}],"url":"\/documentation\/swiftkit\/userdefaultsbaseddeviceidentifier"}}}