SwiftKit/data/documentation/swiftkit/authenticationservice/authenticateuser(for:reason:completion:).json

{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticateUser"},{"kind":"text","text":"("},{"kind":"externalParam","text":"for"},{"kind":"text","text":" "},{"kind":"internalParam","text":"auth"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/Authentication","preciseIdentifier":"s:8SwiftKit14AuthenticationV","text":"Authentication"},{"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":"attribute","text":"@escaping"},{"kind":"text","text":" "},{"kind":"typeIdentifier","identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/AuthenticationService\/AuthCompletion","preciseIdentifier":"s:8SwiftKit21AuthenticationServiceP14AuthCompletiona","text":"AuthCompletion"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"auth","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The authentication type to evaluate."}]}]},{"name":"reason","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The localized reason to show to the user."}]}]},{"name":"completion","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The completion block to call once authentication is done."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftkit\/authenticationservice\/authenticateuser(for:reason:completion:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/AuthenticationService\/authenticateUser(for:reason:completion:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Authenticate the user for a certain "},{"type":"reference","isActive":true,"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/Authentication"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"role":"symbol","title":"authenticateUser(for:reason:completion:)","roleHeading":"Instance Method","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":")"}],"symbolKind":"method","externalID":"s:8SwiftKit21AuthenticationServiceP16authenticateUser3for6reason10completionyAA0C0V_SSys6ResultOyyts5Error_pGctF","required":true,"modules":[{"name":"SwiftKit"}]},"hierarchy":{"paths":[["doc:\/\/SwiftKit\/documentation\/SwiftKit","doc:\/\/SwiftKit\/documentation\/SwiftKit\/AuthenticationService"]]},"references":{"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/AuthenticationService/AuthCompletion":{"role":"symbol","title":"AuthenticationService.AuthCompletion","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthCompletion"}],"abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/AuthenticationService\/AuthCompletion","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthCompletion"}],"url":"\/documentation\/swiftkit\/authenticationservice\/authcompletion"},"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/AuthenticationService/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\/AuthenticationService\/authenticateUser(for:reason:completion:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/swiftkit\/authenticationservice\/authenticateuser(for:reason:completion:)"},"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"}}}