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
AppDelegate.reachfive()
.startPasswordless(.Email(email: "john.doe@gmail.com", redirectUri: "reachfive-${clientId}://callback"))
.onSuccess{ _ in
// Do something
}
.onFailure { error in
// Return a ReachFive error
}
import Reach5
AppDelegate.reachfive()
.startPasswordless(.PhoneNumber(phoneNumber: "+33792244940", redirectUri: "reachfive-${clientId}://callback"))
.onSuccess{ _ in
// Do something
}
.onFailure { error in
// 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
Type: Future<(), 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
: The user cancelled the request or no credential was available in the keychain. -
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[] |
|