SwiftKit/data/documentation/swiftkit/localauthenticationservice.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\/CachedAuthenticationService","doc:\/\/SwiftKit\/documentation\/SwiftKit\/CachedAuthenticationServiceProxy"],"generated":true}],"schemaVersion":{"major":0,"minor":2,"patch":0},"metadata":{"fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"LocalAuthenticationService"}],"title":"LocalAuthenticationService","roleHeading":"Class","role":"symbol","symbolKind":"class","externalID":"s:8SwiftKit26LocalAuthenticationServiceC","modules":[{"name":"SwiftKit"}],"navigatorTitle":[{"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."}],"sections":[],"identifier":{"url":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/LocalAuthenticationService","interfaceLanguage":"swift"},"relationshipsSections":[{"identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/BiometricAuthenticationService"],"kind":"relationships","title":"Inherited By","type":"inheritedBy"},{"identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/AuthenticationService"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"hierarchy":{"paths":[["doc:\/\/SwiftKit\/documentation\/SwiftKit"]]},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/LocalAuthenticationService\/init(policy:)"]},{"title":"Instance Methods","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/LocalAuthenticationService\/authenticateUser(for:reason:completion:)","doc:\/\/SwiftKit\/documentation\/SwiftKit\/LocalAuthenticationService\/canAuthenticateUser(for:)","doc:\/\/SwiftKit\/documentation\/SwiftKit\/LocalAuthenticationService\/performAuthentication(for:reason:completion:)"]}],"variants":[{"paths":["\/documentation\/swiftkit\/localauthenticationservice"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"LocalAuthenticationService"}],"languages":["swift"],"platforms":["iOS"]}]}],"references":{"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/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/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/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/LocalAuthenticationService/init(policy:)":{"role":"symbol","title":"init(policy:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"policy"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"LAPolicy","preciseIdentifier":"c:@E@LAPolicy"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Create a service instance."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/LocalAuthenticationService\/init(policy:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/localauthenticationservice\/init(policy:)"},"doc://SwiftKit/documentation/SwiftKit/LocalAuthenticationService/performAuthentication(for:reason:completion:)":{"role":"symbol","title":"performAuthentication(for:reason:completion:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"performAuthentication"},{"kind":"text","text":"("},{"kind":"externalParam","text":"for"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Authentication","preciseIdentifier":"s:8SwiftKit14AuthenticationV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"reason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"completion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"AuthCompletion","preciseIdentifier":"s:8SwiftKit21AuthenticationServiceP14AuthCompletiona"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Authenticate the user for a certain `` authentication type,"},{"type":"text","text":" "},{"type":"text","text":"regardless of if this service can authenticate the user"},{"type":"text","text":" "},{"type":"text","text":"for the provided authentication type or not."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/LocalAuthenticationService\/performAuthentication(for:reason:completion:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/localauthenticationservice\/performauthentication(for:reason:completion:)"},"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/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":{"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/LocalAuthenticationService/canAuthenticateUser(for:)":{"role":"symbol","title":"canAuthenticateUser(for:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"canAuthenticateUser"},{"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 instance can authenticate the user"},{"type":"text","text":" "},{"type":"text","text":"for a certain "},{"type":"reference","isActive":true,"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/Authentication"},{"type":"text","text":"."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/LocalAuthenticationService\/canAuthenticateUser(for:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/localauthenticationservice\/canauthenticateuser(for:)"},"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/LocalAuthenticationService/authenticateUser(for:reason:completion:)":{"role":"symbol","title":"authenticateUser(for:reason:completion:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticateUser"},{"kind":"text","text":"("},{"kind":"externalParam","text":"for"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Authentication","preciseIdentifier":"s:8SwiftKit14AuthenticationV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"reason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"completion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"AuthCompletion","preciseIdentifier":"s:8SwiftKit21AuthenticationServiceP14AuthCompletiona"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Authenticate the user for a certain "},{"type":"reference","isActive":true,"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/Authentication"},{"type":"text","text":"."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/LocalAuthenticationService\/authenticateUser(for:reason:completion:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/localauthenticationservice\/authenticateuser(for:reason:completion:)"}}}