SwiftKit/data/documentation/swiftkit/cachedauthenticationservice.json

{"seeAlsoSections":[{"title":"Authentication","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/Authentication","doc:\/\/SwiftKit\/documentation\/SwiftKit\/AuthenticationService","doc:\/\/SwiftKit\/documentation\/SwiftKit\/AuthenticationServiceError","doc:\/\/SwiftKit\/documentation\/SwiftKit\/BiometricAuthenticationService","doc:\/\/SwiftKit\/documentation\/SwiftKit\/CachedAuthenticationServiceProxy","doc:\/\/SwiftKit\/documentation\/SwiftKit\/LocalAuthenticationService"],"generated":true}],"schemaVersion":{"major":0,"minor":2,"patch":0},"metadata":{"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"CachedAuthenticationService"}],"title":"CachedAuthenticationService","roleHeading":"Protocol","role":"symbol","symbolKind":"protocol","externalID":"s:8SwiftKit27CachedAuthenticationServiceP","modules":[{"name":"SwiftKit"}],"navigatorTitle":[{"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."}],"sections":[],"identifier":{"url":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/CachedAuthenticationService","interfaceLanguage":"swift"},"relationshipsSections":[{"identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/AuthenticationService"],"kind":"relationships","title":"Inherits From","type":"inheritsFrom"},{"identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/CachedAuthenticationServiceProxy"],"kind":"relationships","title":"Conforming Types","type":"conformingTypes"}],"hierarchy":{"paths":[["doc:\/\/SwiftKit\/documentation\/SwiftKit"]]},"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/CachedAuthenticationService\/isUserAuthenticated(for:)","doc:\/\/SwiftKit\/documentation\/SwiftKit\/CachedAuthenticationService\/resetUserAuthentication(for:)","doc:\/\/SwiftKit\/documentation\/SwiftKit\/CachedAuthenticationService\/resetUserAuthentications()"]}],"variants":[{"paths":["\/documentation\/swiftkit\/cachedauthenticationservice"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"CachedAuthenticationService"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/AuthenticationService","preciseIdentifier":"s:8SwiftKit21AuthenticationServiceP","text":"AuthenticationService"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"anchor":"overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"For instance, you can reduce the number of times users have"},{"type":"text","text":" "},{"type":"text","text":"to perform biometric authentication to access critical data."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Note that you can’t rely on a cached authentication service"},{"type":"text","text":" "},{"type":"text","text":"to clear its state. Call the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/CachedAuthenticationService\/resetUserAuthentications()"},{"type":"text","text":" "},{"type":"text","text":"or "},{"type":"reference","isActive":true,"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/CachedAuthenticationService\/resetUserAuthentication(for:)"},{"type":"text","text":" function as soon as an"},{"type":"text","text":" "},{"type":"text","text":"authenticated session becomes invalid, e.g. when the app is"},{"type":"text","text":" "},{"type":"text","text":"sent to the background or new users log in."}]}]}],"references":{"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/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"},"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/CachedAuthenticationService/resetUserAuthentication(for:)":{"role":"symbol","title":"resetUserAuthentication(for:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"resetUserAuthentication"},{"kind":"text","text":"("},{"kind":"externalParam","text":"for"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Authentication","preciseIdentifier":"s:8SwiftKit14AuthenticationV"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Reset the service’s cached authentication state for the"},{"type":"text","text":" "},{"type":"text","text":"provided authentication type."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/CachedAuthenticationService\/resetUserAuthentication(for:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/swiftkit\/cachedauthenticationservice\/resetuserauthentication(for:)"},"doc://SwiftKit/documentation/SwiftKit/CachedAuthenticationService/isUserAuthenticated(for:)":{"role":"symbol","title":"isUserAuthenticated(for:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"isUserAuthenticated"},{"kind":"text","text":"("},{"kind":"externalParam","text":"for"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Authentication","preciseIdentifier":"s:8SwiftKit14AuthenticationV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[{"type":"text","text":"Check if the service has already authenticated the user"},{"type":"text","text":" "},{"type":"text","text":"for a certain authentication type."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/CachedAuthenticationService\/isUserAuthenticated(for:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/swiftkit\/cachedauthenticationservice\/isuserauthenticated(for:)"},"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/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":{"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/CachedAuthenticationService/resetUserAuthentications()":{"role":"symbol","title":"resetUserAuthentications()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"resetUserAuthentications"},{"kind":"text","text":"()"}],"abstract":[{"type":"text","text":"Reset the service’s cached authentication state for all"},{"type":"text","text":" "},{"type":"text","text":"authentication types."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/CachedAuthenticationService\/resetUserAuthentications()","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/swiftkit\/cachedauthenticationservice\/resetuserauthentications()"},"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"}}}