DescopeOtp class abstract

Authenticate users using a one time password (OTP) code, sent via a delivery method of choice. The code then needs to be verified using the verify function. It is also possible to add an email or phone to an existing user after validating it via OTP.

Constructors

DescopeOtp()

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
signIn({required DeliveryMethod method, required String loginId, SignInOptions? options}) → Future<String>
Authenticates an existing user using an OTP
signUp({required DeliveryMethod method, required String loginId, SignUpDetails? details}) → Future<String>
Authenticates a new user using an OTP
signUpOrIn({required DeliveryMethod method, required String loginId, SignInOptions? options}) → Future<String>
Authenticates an existing user if one exists, or creates a new user using an OTP
toString() → String
A string representation of this object.
inherited
updateEmail({required String email, required String loginId, required String refreshJwt, UpdateOptions? options}) → Future<String>
Updates an existing user by adding an email address.
updatePhone({required String phone, required DeliveryMethod method, required String loginId, required String refreshJwt, UpdateOptions? options}) → Future<String>
Updates an existing user by adding a phone number.
verify({required DeliveryMethod method, required String loginId, required String code}) → Future<AuthenticationResponse>
Verifies an OTP code sent to the user.

Operators

operator ==(Object other) → bool
The equality operator.
inherited