GoTrueApi class

Constructors

GoTrueApi(String url, {Map<String, String>? headers, CookieOptions? cookieOptions, Client? httpClient})

Properties

cookieOptions ↔ CookieOptions?

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

headers ↔ Map<String, String>

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

url ↔ String

getter/setter pair

Methods

getUrlForProvider(Provider provider, AuthOptions? options) → String

getUser(String jwt) → Future<GotrueUserResponse>

Gets the user details.

getUserByCookie() → Never

inviteUserByEmail(String email, {AuthOptions? options}) → Future<GotrueJsonResponse>

Sends an invite link to an email address.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

refreshAccessToken(String refreshToken, [String? jwt]) → Future<GotrueSessionResponse>

Generates a new JWT.

resetPasswordForEmail(String email, {AuthOptions? options}) → Future<GotrueJsonResponse>

Sends a reset request to an email address.

sendMagicLinkEmail(String email, {AuthOptions? options}) → Future<GotrueJsonResponse>

Sends a magic login link to an email address.

sendMobileOTP(String phone) → Future<GotrueJsonResponse>

Sends a mobile OTP via SMS. Will register the account if it doesn't already exist

setAuthCookie() → Never

signInWithEmail(String email, String password, {AuthOptions? options}) → Future<GotrueSessionResponse>

Logs in an existing user using their email address.

signInWithOpenIDConnect(OpenIDConnectCredentials oidc) → Future<GotrueSessionResponse>

Logs in an OpenID Connect user using their idToken.

signInWithPhone(String phone, [String? password]) → Future<GotrueSessionResponse>

Logs in an existing user using their phone number and password.

signOut(String jwt) → Future<GotrueResponse>

Removes a logged-in session.

signUpWithEmail(String email, String password, {AuthOptions? options, Map<String, dynamic>? userMetadata}) → Future<GotrueSessionResponse>

Creates a new user using their email address.

signUpWithPhone(String phone, String password, {Map<String, dynamic>? userMetadata}) → Future<GotrueSessionResponse>

Signs up a new user using their phone number and a password.

toString() → String

A string representation of this object.

inherited

updateUser(String jwt, UserAttributes attributes) → Future<GotrueUserResponse>

Updates the user data.

verifyMobileOTP(String phone, String token, {AuthOptions? options}) → Future<GotrueSessionResponse>

Send User supplied Mobile OTP to be verified

Operators

operator ==(Object other) → bool

The equality operator.

inherited