startPasswordless
AppDelegate.reachfive().startPasswordless(
// Optional arguments
email,
phoneNumber,
redirectUri
)
Description
Starts passwordless flow by sending an email or an SMS to the user with a single-use auth code.
Examples
import Reach5
do {
try await AppDelegate.reachfive().startPasswordless(.Email(
email: "john.doe@gmail.com",
redirectUri: URL(string: "reachfive-${clientId}://callback")!
))
// Do something
} catch {
// Return a ReachFive error
}
import Reach5
do {
try await AppDelegate.reachfive().startPasswordless(.PhoneNumber(
phoneNumber: "+33792244940",
redirectUri: URL(string: "reachfive-${clientId}://callback")!
))
// Do something
} catch {
// Return a ReachFive error
}
Parameters
| Parameter | Description |
|---|---|
The email address of the profile. |
|
The phone number of the profile. Both the international format and the national conventions of the account’s country are accepted if configured in account settings. |
|
The URL where the user will be redirected after the passwordless success. Default value is |
Response
Error: ReachFiveError
The profile will receive an email or an SMS. If the parameters are invalid, the promise will be rejected and will return a ReachFiveError.
ReachFiveError
Based on the problem, the ReachFiveError will be:
-
AuthCanceled: Nothing happened, and nothing is expected of you — ignoring it is a valid way to handle it.
This can happen for any of the following reasons:-
The user canceled the request.
-
No passkey was saved for your app.
-
A web login was dropped because another one was already in progress. See webviewLogin.
-
The app is not associated with the host of an
WebProvider.universalLinkcallback. See guides/apple-app-site-association.adoc#webcredentials.
-
-
RequestError(apiError: ApiError)for a Bad Request (status 400) error. -
AuthFailure(reason: String, apiError: ApiError?)mainly for Unauthorized (status 401) error. -
TechnicalError(reason: String, apiError: ApiError?)if it’s an Internal Server Error (status 500) or other internal errors.
ApiError
error |
The main error message. |
||||||
errorId |
The identifier of the error. |
||||||
errorUserMsg |
The user-friendly error message.
|
||||||
errorMessageKey |
The error message key. |
||||||
errorDescription |
The technical error message. |
||||||
errorDetails FieldError[] |
|