SwiftKit/data/documentation/swiftkit/authentication.json

{"seeAlsoSections":[{"title":"Authentication","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/AuthenticationService","doc:\/\/SwiftKit\/documentation\/SwiftKit\/AuthenticationServiceError","doc:\/\/SwiftKit\/documentation\/SwiftKit\/BiometricAuthenticationService","doc:\/\/SwiftKit\/documentation\/SwiftKit\/CachedAuthenticationService","doc:\/\/SwiftKit\/documentation\/SwiftKit\/CachedAuthenticationServiceProxy","doc:\/\/SwiftKit\/documentation\/SwiftKit\/LocalAuthenticationService"],"generated":true}],"schemaVersion":{"major":0,"minor":2,"patch":0},"metadata":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"title":"Authentication","roleHeading":"Structure","role":"symbol","symbolKind":"struct","externalID":"s:8SwiftKit14AuthenticationV","modules":[{"name":"SwiftKit"}],"navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"abstract":[{"type":"text","text":"This struct represents a unique authentication type."}],"sections":[],"identifier":{"url":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/Authentication","interfaceLanguage":"swift"},"relationshipsSections":[{"identifiers":["doc:\/\/SwiftKit\/SQ","doc:\/\/SwiftKit\/s12IdentifiableP"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"hierarchy":{"paths":[["doc:\/\/SwiftKit\/documentation\/SwiftKit"]]},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/Authentication\/init(id:)"]},{"title":"Instance Properties","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/Authentication\/id-87iwg"]},{"title":"Type Properties","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/Authentication\/standard"]},{"title":"Default Implementations","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/Authentication\/Equatable-Implementations","doc:\/\/SwiftKit\/documentation\/SwiftKit\/Authentication\/Identifiable-Implementations"],"generated":true}],"variants":[{"paths":["\/documentation\/swiftkit\/authentication"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"anchor":"overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The struct only has an "},{"type":"codeVoice","code":"id"},{"type":"text","text":", but is still used to improve"},{"type":"text","text":" "},{"type":"text","text":"authentication without having to change any protocols."}]}]}],"references":{"doc://SwiftKit/documentation/SwiftKit/Authentication/id-87iwg":{"role":"symbol","title":"id","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The ID of the authentication."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/Authentication\/id-87iwg","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/authentication\/id-87iwg"},"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/CachedAuthenticationServiceProxy":{"role":"symbol","title":"CachedAuthenticationServiceProxy","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"CachedAuthenticationServiceProxy"}],"abstract":[{"type":"text","text":"This class wraps another "},{"type":"reference","isActive":true,"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/AuthenticationService"},{"type":"text","text":" instance"},{"type":"text","text":" "},{"type":"text","text":"and keeps authentication results in a cache."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/CachedAuthenticationServiceProxy","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CachedAuthenticationServiceProxy"}],"url":"\/documentation\/swiftkit\/cachedauthenticationserviceproxy"},"doc://SwiftKit/documentation/SwiftKit/Authentication":{"role":"symbol","title":"Authentication","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"abstract":[{"type":"text","text":"This struct represents a unique authentication type."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/swiftkit\/authentication"},"doc://SwiftKit/documentation/SwiftKit/Authentication/standard":{"role":"symbol","title":"standard","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"standard"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Authentication","preciseIdentifier":"s:8SwiftKit14AuthenticationV"}],"abstract":[{"type":"text","text":"This standard authentication type can be used if you do"},{"type":"text","text":" "},{"type":"text","text":"not have many different authentications in your app."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/Authentication\/standard","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/authentication\/standard"},"doc://SwiftKit/documentation/SwiftKit/Authentication/init(id:)":{"role":"symbol","title":"init(id:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Create a new authentication type."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/Authentication\/init(id:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/authentication\/init(id:)"},"doc://SwiftKit/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/SwiftKit\/SQ"},"doc://SwiftKit/documentation/SwiftKit/LocalAuthenticationService":{"role":"symbol","title":"LocalAuthenticationService","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"LocalAuthenticationService"}],"abstract":[{"type":"text","text":"This service uses "},{"type":"codeVoice","code":"LocalAuthentication"},{"type":"text","text":" to authenticate the"},{"type":"text","text":" "},{"type":"text","text":"current user."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/LocalAuthenticationService","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"LocalAuthenticationService"}],"url":"\/documentation\/swiftkit\/localauthenticationservice"},"doc://SwiftKit/documentation/SwiftKit/CachedAuthenticationService":{"role":"symbol","title":"CachedAuthenticationService","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"CachedAuthenticationService"}],"abstract":[{"type":"text","text":"This protocol can be implemented by any classes that can be"},{"type":"text","text":" "},{"type":"text","text":"used to authenticate the user and cache the result to avoid"},{"type":"text","text":" "},{"type":"text","text":"having to perform a real authentication if a successful one"},{"type":"text","text":" "},{"type":"text","text":"has already been performed."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/CachedAuthenticationService","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CachedAuthenticationService"}],"url":"\/documentation\/swiftkit\/cachedauthenticationservice"},"doc://SwiftKit/documentation/SwiftKit/BiometricAuthenticationService":{"role":"symbol","title":"BiometricAuthenticationService","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"BiometricAuthenticationService"}],"abstract":[{"type":"text","text":"This authentication service uses "},{"type":"codeVoice","code":"LocalAuthentication"},{"type":"text","text":" such"},{"type":"text","text":" "},{"type":"text","text":"as "},{"type":"codeVoice","code":"FaceID"},{"type":"text","text":" or "},{"type":"codeVoice","code":"TouchID"},{"type":"text","text":" to authenticate the user."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/BiometricAuthenticationService","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"BiometricAuthenticationService"}],"url":"\/documentation\/swiftkit\/biometricauthenticationservice"},"doc://SwiftKit/s12IdentifiableP":{"type":"unresolvable","title":"Swift.Identifiable","identifier":"doc:\/\/SwiftKit\/s12IdentifiableP"},"doc://SwiftKit/documentation/SwiftKit/AuthenticationService":{"role":"symbol","title":"AuthenticationService","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationService"}],"abstract":[{"type":"text","text":"This protocol can be implemented by any classes that can be"},{"type":"text","text":" "},{"type":"text","text":"used to authenticate the user."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/AuthenticationService","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationService"}],"url":"\/documentation\/swiftkit\/authenticationservice"},"doc://SwiftKit/documentation/SwiftKit/Authentication/Equatable-Implementations":{"role":"collectionGroup","title":"Equatable Implementations","abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/Authentication\/Equatable-Implementations","kind":"article","type":"topic","url":"\/documentation\/swiftkit\/authentication\/equatable-implementations"},"doc://SwiftKit/documentation/SwiftKit/Authentication/Identifiable-Implementations":{"role":"collectionGroup","title":"Identifiable Implementations","abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/Authentication\/Identifiable-Implementations","kind":"article","type":"topic","url":"\/documentation\/swiftkit\/authentication\/identifiable-implementations"},"doc://SwiftKit/documentation/SwiftKit/AuthenticationServiceError":{"role":"symbol","title":"AuthenticationServiceError","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationServiceError"}],"abstract":[{"type":"text","text":"This enum represents various authentication errors that can"},{"type":"text","text":" "},{"type":"text","text":"occur while a user is being authenticated."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/AuthenticationServiceError","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationServiceError"}],"url":"\/documentation\/swiftkit\/authenticationserviceerror"}}}