ReachFive class

ReachFive, class used to call every reachFive native sdk methods

Constructors

ReachFive({required ReachFiveKey reachFiveKey, required List<Provider> providers, required ReachFiveIdentityRepo identityRepo})

ReachFive default constructor

const

Properties

emailApi → EmailApi

EmailApi instance from identityRepo to be given in every reachFive api methods that needs it

no setter

hashCode → int

The hash code for this object.

no setter, inherited

identityRepo → ReachFiveIdentityRepo

ReachFiveIdentityRepo instance, kept in memory here to be create every api linked to it

final

oAuthApi → OAuthApi

OAuthApi instance from identityRepo to be given in every reachFive api methods that needs it

no setter

providers → List<Provider>

ReachFive available providers, kept in memory here to be given in every reachFive native sdk methods that needs providers

final

reachFiveKey → ReachFiveKey

ReachFive instance key, kept in memory here to be given in every reachFive native sdk methods It allows us to select the correct instance in the native part and to have multi-instance of reachFive

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

getProfile({required AuthToken authToken}) → Future<Profile>

Get your user profile information

loginWithPassword({required String password, String? email, String? phoneNumber, List<ScopeValue>? scope}) → Future<AuthToken>

Login an user by providing an identifier (email or phoneNumber) and a password

loginWithProvider({required Provider provider, required String origin, List<ScopeValue>? scope}) → Future<AuthToken>

Login an user by using one of the available providers

logout({AuthToken? authToken, String? clientSecret}) → Future<void>

Logout your user from your session (and every providers)

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

refreshAccessToken(AuthToken authToken) → Future<AuthToken>

Obtain a new AuthToken once your access token has expired.

requestPasswordReset({String? email, String? phoneNumber, String? redirectUrl}) → Future<void>

Make request for password reset You can personnalize the sent mail/SMS in the reachFive console

revokeToken({required AuthToken authToken, required RevokeTokenType revokeTokenType, String? clientSecret, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, bool validateStatus(int?)?, void onSendProgress(int, int)?, void onReceiveProgress(int, int)?}) → Future<void>

Revoke an AuthToken refreshToken or accessToken depending on the revokeTokenType for an user and a clientId

sendEmailVerification({required String accessToken, String? trueClientIP, String? trueClientIPKey, String? redirectUrl, String? returnToAfterEmailConfirmation, Locale? customLocale}) → Future<bool>

Request the verification of the email address of a profile. If there is an email address configured in the profile that was not already verified, sends an email to verify it.

signup({required ProfileSignupRequest profile, String? redirectUrl, List<ScopeValue>? scope}) → Future<AuthToken>

Create and authenticate a new user with the specified data.

toString() → String

A string representation of this object.

inherited

updatePassword(UpdatePasswordRequest updatePasswordRequest) → Future<void>

Make request for password reset

updateProfile({required AuthToken authToken, required Profile profile}) → Future<Profile>

Update your user profile information

Operators

operator ==(Object other) → bool

The equality operator.

inherited