From a545f39e47474c4f4b9554b85c1346de525cc653 Mon Sep 17 00:00:00 2001 From: acupofjose <9093699+acupofjose@users.noreply.github.com> Date: Tue, 11 Jun 2024 13:51:26 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20supabase?= =?UTF-8?q?-community/gotrue-csharp@bf72eaec8809652e3b30bb87aa909d592c90de?= =?UTF-8?q?22=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- api/Supabase.Gotrue.AdminClient.html | 32 ++-- api/Supabase.Gotrue.AdminUserAttributes.html | 14 +- api/Supabase.Gotrue.Api.html | 86 +++++----- api/Supabase.Gotrue.Client.html | 116 +++++++------ api/Supabase.Gotrue.ClientOptions.html | 18 +- api/Supabase.Gotrue.Constants.AuthState.html | 6 +- ...upabase.Gotrue.Constants.EmailOtpType.html | 6 +- ...pabase.Gotrue.Constants.MobileOtpType.html | 6 +- ...pabase.Gotrue.Constants.OAuthFlowType.html | 6 +- api/Supabase.Gotrue.Constants.Provider.html | 6 +- api/Supabase.Gotrue.Constants.SignInType.html | 6 +- ...upabase.Gotrue.Constants.SignOutScope.html | 156 ++++++++++++++++++ api/Supabase.Gotrue.Constants.SignUpType.html | 6 +- api/Supabase.Gotrue.Constants.SortOrder.html | 6 +- api/Supabase.Gotrue.Constants.html | 16 +- api/Supabase.Gotrue.DebugNotification.html | 10 +- ....Gotrue.Exceptions.FailureHint.Reason.html | 6 +- ...upabase.Gotrue.Exceptions.FailureHint.html | 8 +- ...ase.Gotrue.Exceptions.GotrueException.html | 24 +-- ...GenerateLinkEmailChangeCurrentOptions.html | 8 +- ...rue.GenerateLinkEmailChangeNewOptions.html | 8 +- ...e.Gotrue.GenerateLinkOptions.LinkType.html | 6 +- api/Supabase.Gotrue.GenerateLinkOptions.html | 20 +-- ...base.Gotrue.GenerateLinkSignupOptions.html | 8 +- api/Supabase.Gotrue.Helpers.html | 12 +- ...otrue.Interfaces.IGotrueAdminClient-1.html | 26 +-- ...pabase.Gotrue.Interfaces.IGotrueApi-2.html | 80 ++++----- ...aces.IGotrueClient-2.AuthEventHandler.html | 6 +- ...ase.Gotrue.Interfaces.IGotrueClient-2.html | 108 ++++++------ ...terfaces.IGotruePersistenceListener-1.html | 10 +- ...nterfaces.IGotrueSessionPersistence-1.html | 12 +- ...e.Interfaces.IGotrueStatelessClient-2.html | 54 +++--- ...abase.Gotrue.InviteUserByEmailOptions.html | 10 +- ....Gotrue.NetworkStatus.NetworkListener.html | 6 +- api/Supabase.Gotrue.NetworkStatus.html | 20 +-- ...pabase.Gotrue.PasswordlessSignInState.html | 8 +- api/Supabase.Gotrue.PersistenceListener.html | 12 +- api/Supabase.Gotrue.ProviderAuthState.html | 12 +- ...e.Gotrue.ResetPasswordForEmailOptions.html | 18 +- ...ase.Gotrue.ResetPasswordForEmailState.html | 8 +- ...upabase.Gotrue.Responses.BaseResponse.html | 10 +- ...Gotrue.Responses.GenerateLinkResponse.html | 16 +- api/Supabase.Gotrue.SSOResponse.html | 8 +- api/Supabase.Gotrue.Session.html | 26 +-- api/Supabase.Gotrue.Settings.html | 20 +-- ...abase.Gotrue.SignInAnonymouslyOptions.html | 10 +- api/Supabase.Gotrue.SignInOptions.html | 14 +- ...ue.SignInWithPasswordlessEmailOptions.html | 14 +- ....Gotrue.SignInWithPasswordlessOptions.html | 12 +- ...wordlessPhoneOptions.MessagingChannel.html | 6 +- ...ue.SignInWithPasswordlessPhoneOptions.html | 12 +- api/Supabase.Gotrue.SignInWithSSOOptions.html | 8 +- api/Supabase.Gotrue.SignUpOptions.html | 8 +- ...tatelessClient.StatelessClientOptions.html | 12 +- api/Supabase.Gotrue.StatelessClient.html | 54 +++--- api/Supabase.Gotrue.TokenRefresh.html | 12 +- api/Supabase.Gotrue.User.html | 42 ++--- api/Supabase.Gotrue.UserAttributes.html | 18 +- api/Supabase.Gotrue.UserIdentity.html | 22 +-- api/Supabase.Gotrue.UserList-1.html | 10 +- api/Supabase.Gotrue.VerifyOTPParams.html | 14 +- api/Supabase.Gotrue.html | 4 + api/toc.html | 3 + api/toc.json | 2 +- index.html | 4 +- index.json | 15 +- manifest.json | 10 ++ xrefmap.yml | 88 ++++++---- 68 files changed, 839 insertions(+), 621 deletions(-) create mode 100644 api/Supabase.Gotrue.Constants.SignOutScope.html diff --git a/api/Supabase.Gotrue.AdminClient.html b/api/Supabase.Gotrue.AdminClient.html index 37faff6..a8ffbdf 100644 --- a/api/Supabase.Gotrue.AdminClient.html +++ b/api/Supabase.Gotrue.AdminClient.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class AdminClient +Class AdminClient

@@ -166,7 +166,7 @@

Constructors

AdminClient(string, ClientOptions?) - +

Initialize the client with a service key.

@@ -205,7 +205,7 @@

Properties

GetHeaders - +

Headers sent to the API on every request.

@@ -237,7 +237,7 @@

Property Value

Options - +

The initialized client options.

@@ -273,7 +273,7 @@

Methods

CreateUser(AdminUserAttributes) - +

Creates a user using the admin key (not the anonymous key). @@ -311,7 +311,7 @@

Returns

CreateUser(string, string, AdminUserAttributes?) - +

Creates a user using the admin key (not the anonymous key). @@ -353,7 +353,7 @@

Returns

DeleteUser(string) - +

Creates a user using the admin key (not the anonymous key). @@ -391,7 +391,7 @@

Returns

Generates email links and OTPs to be sent via a custom email provider.

@@ -429,7 +429,7 @@

Returns

GetUser(string) - +

Gets a user from a user's JWT. This is using the GoTrue server to validate a user's JWT.

@@ -466,7 +466,7 @@

Returns

GetUserById(string) - +

Gets a user by ID from the server using the admin key (not the anonymous key).

@@ -503,7 +503,7 @@

Returns

InviteUserByEmail(string, InviteUserByEmailOptions?) - +

Sends an email to the user.

@@ -542,7 +542,7 @@

Returns

ListUsers(string?, string?, SortOrder, int?, int?) - +

Lists users

@@ -592,7 +592,7 @@

Returns

Update(UserAttributes) - +

Updates a User using the service key

@@ -629,7 +629,7 @@

Returns

UpdateUserById(string, AdminUserAttributes) - +

Update user by Id

@@ -668,7 +668,7 @@

Returns

diff --git a/api/Supabase.Gotrue.AdminUserAttributes.html b/api/Supabase.Gotrue.AdminUserAttributes.html index 3ce2cc0..3854d80 100644 --- a/api/Supabase.Gotrue.AdminUserAttributes.html +++ b/api/Supabase.Gotrue.AdminUserAttributes.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class AdminUserAttributes +Class AdminUserAttributes

@@ -176,7 +176,7 @@

Properties

AppMetadata - +

A custom data object for app_metadata that. Can be any JSON serializable data. @@ -212,7 +212,7 @@

Property Value

EmailConfirm - +

Sets if a user has confirmed their email address. @@ -246,7 +246,7 @@

Property Value

PhoneConfirm - +

Sets if a user has confirmed their phone number. @@ -280,7 +280,7 @@

Property Value

UserMetadata - +

A custom data object for user_metadata. Can be any JSON serializable data. @@ -314,7 +314,7 @@

Property Value

diff --git a/api/Supabase.Gotrue.Api.html b/api/Supabase.Gotrue.Api.html index b806223..7f03f55 100644 --- a/api/Supabase.Gotrue.Api.html +++ b/api/Supabase.Gotrue.Api.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class Api +Class Api

@@ -164,7 +164,7 @@

Constructors

Api(string, Dictionary<string, string>?) - +

Creates a new API client

@@ -202,7 +202,7 @@

Properties

GetHeaders - +

Function that can be set to return dynamic headers. @@ -235,7 +235,7 @@

Property Value

Headers - +

Headers to be sent with every request. These will be merged with any headers returned by GetHeaders.

@@ -271,7 +271,7 @@

Methods

CreateUser(string, AdminUserAttributes?) - +

Create a user

@@ -312,7 +312,7 @@

Returns

DeleteUser(string, string) - +

Delete a user

@@ -353,7 +353,7 @@

Returns

ExchangeCodeForSession(string, string) - +

Log in an existing user via code from third-party provider.

@@ -394,7 +394,7 @@

Returns

Generates email links and OTPs to be sent via a custom email provider.

@@ -433,7 +433,7 @@

Returns

GetUriForProvider(Provider, SignInOptions?) - +

@@ -471,7 +471,7 @@

Returns

GetUser(string) - +

Gets User Details

@@ -508,7 +508,7 @@

Returns

GetUserById(string, string) - +

Get User details by Id

@@ -549,7 +549,7 @@

Returns

InviteUserByEmail(string, string, InviteUserByEmailOptions?) - +

Sends an invite link to an email address.

@@ -591,7 +591,7 @@

Returns

LinkIdentity(string, Provider, SignInOptions) - +

Links an oauth identity to an existing user.

@@ -635,7 +635,7 @@

Returns

ListUsers(string, string?, string?, SortOrder, int?, int?) - +

Lists users

@@ -688,7 +688,7 @@

Returns

Reauthenticate(string) - +

Sends a re-authentication request, used for password changes.

@@ -727,7 +727,7 @@

Returns

RefreshAccessToken(string, string) - +

Generates a new Session given a user's access token and refresh token.

@@ -766,7 +766,7 @@

Returns

ResetPasswordForEmail(ResetPasswordForEmailOptions) - +

Sends a password reset request to an email address.

@@ -804,7 +804,7 @@

Returns

ResetPasswordForEmail(string) - +

Sends a reset request to an email address.

@@ -841,7 +841,7 @@

Returns

SendMagicLinkEmail(string, SignInOptions?) - +

Sends a magic login link to an email address.

@@ -880,7 +880,7 @@

Returns

SendMobileOTP(string) - +

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

@@ -918,7 +918,7 @@

Returns

Settings() - +

Calls the GoTrue server to get the settings (for example, if email auto confirmation is turned on)

@@ -951,7 +951,7 @@

Returns

SignInAnonymously(SignInAnonymouslyOptions?) - +

Creates a new anonymous user.

@@ -989,7 +989,7 @@

Returns

SignInWithEmail(string, string) - +

Logs in an existing user using their email address.

@@ -1028,7 +1028,7 @@

Returns

SignInWithIdToken(Provider, string, string?, string?, string?) - +

Allows signing in with an ID token issued by certain supported providers. @@ -1080,7 +1080,7 @@

Returns

SignInWithOtp(SignInWithPasswordlessEmailOptions) - +

Log in a user using magiclink or a one-time password (OTP).

@@ -1126,7 +1126,7 @@

Returns

SignInWithOtp(SignInWithPasswordlessPhoneOptions) - +

Log in a user using magiclink or a one-time password (OTP).

@@ -1172,7 +1172,7 @@

Returns

SignInWithPhone(string, string) - +

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

@@ -1213,7 +1213,7 @@

Returns

SignInWithSSO(Guid, SignInWithSSOOptions?) - +

@@ -1251,7 +1251,7 @@

Returns

SignInWithSSO(string, SignInWithSSOOptions?) - +

@@ -1287,9 +1287,9 @@

Returns

-

- SignOut(string) - +

+ SignOut(string, SignOutScope) +

Removes a logged-in session.

@@ -1297,13 +1297,15 @@

-
public Task<BaseResponse> SignOut(string jwt)
+
public Task<BaseResponse> SignOut(string jwt, Constants.SignOutScope scope = SignOutScope.Global)

Parameters

jwt string
+
scope Constants.SignOutScope
+

Returns

@@ -1326,7 +1328,7 @@

Returns

SignUpWithEmail(string, string, SignUpOptions?) - +

Signs a user up using an email address and password.

@@ -1368,7 +1370,7 @@

Returns

SignUpWithPhone(string, string, SignUpOptions?) - +

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

@@ -1412,7 +1414,7 @@

Returns

UnlinkIdentity(string, UserIdentity) - +

Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked.

@@ -1453,7 +1455,7 @@

Returns

UpdateUser(string, UserAttributes) - +

Updates the User data

@@ -1492,7 +1494,7 @@

Returns

UpdateUserById(string, string, UserAttributes) - +

Update user by Id

@@ -1536,7 +1538,7 @@

Returns

VerifyEmailOTP(string, string, EmailOtpType) - +

Send User supplied Email OTP to be verified

@@ -1580,7 +1582,7 @@

Returns

VerifyMobileOTP(string, string, MobileOtpType) - +

Send User supplied Mobile OTP to be verified

@@ -1624,7 +1626,7 @@

Returns

diff --git a/api/Supabase.Gotrue.Client.html b/api/Supabase.Gotrue.Client.html index 1c1d581..a5e675e 100644 --- a/api/Supabase.Gotrue.Client.html +++ b/api/Supabase.Gotrue.Client.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class Client +Class Client

@@ -163,7 +163,7 @@

Constructors

Client(ClientOptions?) - +

Initializes the GoTrue stateful client.

@@ -212,7 +212,7 @@

Properties

CurrentSession - +

The current Session as managed by this client. Does not refresh tokens or have any other side effects.

@@ -246,7 +246,7 @@

Property Value

CurrentUser - +

The currently logged in User. This is a local cache of the current session User. @@ -280,7 +280,7 @@

Property Value

GetHeaders - +

Headers sent to the API on every request.

@@ -312,7 +312,7 @@

Property Value

Online - +

Indicates if the client should be considered online or offline.

@@ -347,7 +347,7 @@

Property Value

Options - +

Returns the client options.

@@ -379,7 +379,7 @@

Property Value

TokenRefresh - +

Get the TokenRefresh object, if it exists

@@ -415,7 +415,7 @@

Methods

AddDebugListener(Action<string, Exception?>) - +

Add a listener to get errors that occur outside of a typical Exception flow. @@ -450,7 +450,7 @@

Parameters

AddStateChangedListener(AuthEventHandler) - +

Adds a listener to be notified when the user state changes (e.g. the user logs in, logs out, @@ -484,7 +484,7 @@

Parameters

ClearStateChangedListeners() - +

Clears all of the listeners from receiving event state changes.

@@ -513,7 +513,7 @@

Debug(string, Exception?) - +

Posts messages and exceptions to the debug listener. This is particularly useful for sorting @@ -548,7 +548,7 @@

Parameters

ExchangeCodeForSession(string, string) - +

Logs in an existing user via a third-party provider.

@@ -587,7 +587,7 @@

Returns

GetSessionFromUrl(Uri, bool) - +

Parses a Session out of a Uri's Query parameters.

@@ -626,7 +626,7 @@

Returns

GetUser(string) - +

Get User details by JWT. Can be used to validate a JWT.

@@ -664,7 +664,7 @@

Returns

LinkIdentity(Provider, SignInOptions) - +

Links an oauth identity to an existing user.

@@ -705,7 +705,7 @@

Returns

LoadSession() - +

Loads the session from the persistence layer.

@@ -732,7 +732,7 @@

NotifyAuthStateChange(AuthState) - +

Notifies all listeners that the current user auth state has changed.

@@ -765,7 +765,7 @@

Parameters

Reauthenticate() - +

Used for re-authenticating a user in password changes.

@@ -803,7 +803,7 @@

Exceptions

RefreshSession() - +

Refreshes the currently logged in User's Session.

@@ -835,7 +835,7 @@

Returns

RefreshToken() - +

Refreshes a Token using the current session.

@@ -867,7 +867,7 @@

Returns

RefreshToken(string, string) - +

@@ -905,7 +905,7 @@

Returns

RemoveStateChangedListener(AuthEventHandler) - +

Removes a specified listener from event state changes.

@@ -937,7 +937,7 @@

Parameters

ResetPasswordForEmail(ResetPasswordForEmailOptions) - +

Sends a password reset request to an email address.

@@ -975,7 +975,7 @@

Returns

ResetPasswordForEmail(string) - +

Sends a reset request to an email address.

@@ -1012,7 +1012,7 @@

Returns

RetrieveSessionAsync() - +

Typically called as part of the startup process for the client.

@@ -1047,7 +1047,7 @@

Returns

Sends a Magic email login link to the specified email.

@@ -1088,7 +1088,7 @@

Returns

SetPersistence(IGotrueSessionPersistence<Session>) - +

Sets the persistence implementation for the client (e.g. file system, local storage, etc).

@@ -1120,7 +1120,7 @@

Parameters

SetSession(string, string, bool) - +

Sets a new session given a user's access token and their refresh token.

@@ -1175,7 +1175,7 @@

Exceptions

Settings() - +

Retrieves the settings from the server

@@ -1207,7 +1207,7 @@

Returns

Shutdown() - +

Let all of the listeners know that the stateless client is being shutdown.

@@ -1235,7 +1235,7 @@

SignIn(Provider, SignInOptions?) - +

Retrieves a ProviderAuthState to redirect to for signing in with a Constants.Provider.

@@ -1276,7 +1276,7 @@

Returns

SignIn(SignInType, string, string?, string?) - +

Log in an existing user, or login via a third-party provider.

@@ -1323,7 +1323,7 @@

Returns

SignIn(string, SignInOptions?) - +

Sends a magic link login email to the specified email.

@@ -1362,7 +1362,7 @@

Returns

SignIn(string, string) - +

Signs in a User.

@@ -1401,7 +1401,7 @@

Returns

SignInAnonymously(SignInAnonymouslyOptions?) - +

Creates a new anonymous user.

@@ -1439,7 +1439,7 @@

Returns

SignInWithIdToken(Provider, string, string?, string?, string?) - +

Allows signing in with an ID token issued by certain supported providers. @@ -1494,7 +1494,7 @@

SignInWithOtp(SignInWithPasswordlessEmailOptions) - +

Log in a user using magiclink or a one-time password (OTP).

@@ -1543,7 +1543,7 @@

SignInWithOtp(SignInWithPasswordlessPhoneOptions) - +

Log in a user using magiclink or a one-time password (OTP).

@@ -1592,7 +1592,7 @@

SignInWithPassword(string, string) - +

Log in an existing user with an email and password or phone and password.

@@ -1631,7 +1631,7 @@

Returns

SignInWithSSO(Guid, SignInWithSSOOptions?) - +

Sign in using single sign on (SSO) as supported by supabase @@ -1675,7 +1675,7 @@

Returns

SignInWithSSO(string, SignInWithSSOOptions?) - +

Sign in using single sign on (SSO) as supported by supabase @@ -1718,19 +1718,25 @@

Returns

-

- SignOut() - +

+ SignOut(SignOutScope) +

-

Signs out a user and invalidates the current token.

+

Signs out and invalidates all sessions for a user.

-
public Task SignOut()
+
public Task SignOut(Constants.SignOutScope scope = SignOutScope.Global)
+

Parameters

+
+
scope Constants.SignOutScope
+

Determines which sessions should be invalidated. By default, it will invalidate all session for a user

+
+

Returns

@@ -1752,7 +1758,7 @@

Returns

SignUp(SignUpType, string, string, SignUpOptions?) - +

Signs up a user

@@ -1808,7 +1814,7 @@

SignUp(string, string, SignUpOptions?) - +

Signs up a user by email address.

@@ -1862,7 +1868,7 @@

UnlinkIdentity(UserIdentity) - +

Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked.

@@ -1900,7 +1906,7 @@

Returns

Update(UserAttributes) - +

Updates a User.

@@ -1937,7 +1943,7 @@

Returns

VerifyOTP(string, string, EmailOtpType) - +

Log in a user give a user supplied OTP received via email.

@@ -1979,7 +1985,7 @@

Returns

VerifyOTP(string, string, MobileOtpType) - +

Log in a user given a User supplied OTP received via mobile.

@@ -2023,7 +2029,7 @@

Returns

diff --git a/api/Supabase.Gotrue.ClientOptions.html b/api/Supabase.Gotrue.ClientOptions.html index ace7a3b..c73e86f 100644 --- a/api/Supabase.Gotrue.ClientOptions.html +++ b/api/Supabase.Gotrue.ClientOptions.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class ClientOptions +Class ClientOptions

@@ -156,7 +156,7 @@

Fields

Headers - +

Headers to be sent with subsequent requests.

@@ -192,7 +192,7 @@

Properties

AllowUnconfirmedUserSessions - +

Very unlikely this flag needs to be changed except in very specific contexts.

@@ -226,7 +226,7 @@

Property Value

AutoRefreshToken - +

Should the Client automatically handle refreshing the User's Token?

@@ -258,7 +258,7 @@

Property Value

DebugRefreshToken - +

Ask the TokenRefresh system to log extra debug info

@@ -290,7 +290,7 @@

Property Value

MaximumRefreshWaitTime - +

By default, the Client will attempt to refresh the token when roughly 1/5 of the @@ -332,7 +332,7 @@

Property Value

Url - +

Gotrue Endpoint

@@ -364,7 +364,7 @@

Property Value

diff --git a/api/Supabase.Gotrue.Constants.AuthState.html b/api/Supabase.Gotrue.Constants.AuthState.html index 0689ec0..27bd929 100644 --- a/api/Supabase.Gotrue.Constants.AuthState.html +++ b/api/Supabase.Gotrue.Constants.AuthState.html @@ -16,7 +16,7 @@ - + @@ -90,7 +90,7 @@
Table of Contents

-Enum Constants.AuthState +Enum Constants.AuthState

@@ -136,7 +136,7 @@

Fields diff --git a/api/Supabase.Gotrue.Constants.EmailOtpType.html b/api/Supabase.Gotrue.Constants.EmailOtpType.html index 8126282..154ddbd 100644 --- a/api/Supabase.Gotrue.Constants.EmailOtpType.html +++ b/api/Supabase.Gotrue.Constants.EmailOtpType.html @@ -16,7 +16,7 @@ - + @@ -90,7 +90,7 @@

Table of Contents

-Enum Constants.EmailOtpType +Enum Constants.EmailOtpType

@@ -138,7 +138,7 @@

Fields diff --git a/api/Supabase.Gotrue.Constants.MobileOtpType.html b/api/Supabase.Gotrue.Constants.MobileOtpType.html index 6906ce9..52a7c02 100644 --- a/api/Supabase.Gotrue.Constants.MobileOtpType.html +++ b/api/Supabase.Gotrue.Constants.MobileOtpType.html @@ -16,7 +16,7 @@ - + @@ -90,7 +90,7 @@

Table of Contents

-Enum Constants.MobileOtpType +Enum Constants.MobileOtpType

@@ -129,7 +129,7 @@

Fields diff --git a/api/Supabase.Gotrue.Constants.OAuthFlowType.html b/api/Supabase.Gotrue.Constants.OAuthFlowType.html index 8d2b71a..5e2e978 100644 --- a/api/Supabase.Gotrue.Constants.OAuthFlowType.html +++ b/api/Supabase.Gotrue.Constants.OAuthFlowType.html @@ -16,7 +16,7 @@ - + @@ -90,7 +90,7 @@

Table of Contents

-Enum Constants.OAuthFlowType +Enum Constants.OAuthFlowType

@@ -130,7 +130,7 @@

Fields diff --git a/api/Supabase.Gotrue.Constants.Provider.html b/api/Supabase.Gotrue.Constants.Provider.html index 2316fe6..fad6e45 100644 --- a/api/Supabase.Gotrue.Constants.Provider.html +++ b/api/Supabase.Gotrue.Constants.Provider.html @@ -16,7 +16,7 @@ - + @@ -90,7 +90,7 @@

Table of Contents

-Enum Constants.Provider +Enum Constants.Provider

@@ -191,7 +191,7 @@

Fields diff --git a/api/Supabase.Gotrue.Constants.SignInType.html b/api/Supabase.Gotrue.Constants.SignInType.html index fceb41b..26f51df 100644 --- a/api/Supabase.Gotrue.Constants.SignInType.html +++ b/api/Supabase.Gotrue.Constants.SignInType.html @@ -16,7 +16,7 @@ - + @@ -90,7 +90,7 @@

Table of Contents

-Enum Constants.SignInType +Enum Constants.SignInType

@@ -130,7 +130,7 @@

Fields diff --git a/api/Supabase.Gotrue.Constants.SignOutScope.html b/api/Supabase.Gotrue.Constants.SignOutScope.html new file mode 100644 index 0000000..9619640 --- /dev/null +++ b/api/Supabase.Gotrue.Constants.SignOutScope.html @@ -0,0 +1,156 @@ + + + + + Enum Constants.SignOutScope | gotrue-csharp + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + + +

+Enum Constants.SignOutScope +

+ +
+
Namespace
Supabase.Gotrue
+
Assembly
Supabase.Gotrue.dll
+
+ +
+
+ +
+
public enum Constants.SignOutScope
+
+ + + + + + + + + +

Fields +

+
+
[MapTo("global", null)] +Global = 0
+
+
[MapTo("local", null)] +Local = 1
+
+
[MapTo("others", null)] +Others = 2
+
+
+ + + +
+ + + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/api/Supabase.Gotrue.Constants.SignUpType.html b/api/Supabase.Gotrue.Constants.SignUpType.html index 592d186..5c601d1 100644 --- a/api/Supabase.Gotrue.Constants.SignUpType.html +++ b/api/Supabase.Gotrue.Constants.SignUpType.html @@ -16,7 +16,7 @@ - + @@ -90,7 +90,7 @@

Table of Contents

-Enum Constants.SignUpType +Enum Constants.SignUpType

@@ -128,7 +128,7 @@

Fields diff --git a/api/Supabase.Gotrue.Constants.SortOrder.html b/api/Supabase.Gotrue.Constants.SortOrder.html index eaedd3b..b6668df 100644 --- a/api/Supabase.Gotrue.Constants.SortOrder.html +++ b/api/Supabase.Gotrue.Constants.SortOrder.html @@ -16,7 +16,7 @@ - + @@ -90,7 +90,7 @@

Table of Contents

-Enum Constants.SortOrder +Enum Constants.SortOrder

@@ -129,7 +129,7 @@

Fields diff --git a/api/Supabase.Gotrue.Constants.html b/api/Supabase.Gotrue.Constants.html index 9a5e02d..99fe4a8 100644 --- a/api/Supabase.Gotrue.Constants.html +++ b/api/Supabase.Gotrue.Constants.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@

Table of Contents

-Class Constants +Class Constants

@@ -156,7 +156,7 @@

Fields

AUDIENCE - +

@@ -186,7 +186,7 @@

Field Value

CookieOptions - +

@@ -216,7 +216,7 @@

Field Value

EXPIRY_MARGIN - +

@@ -246,7 +246,7 @@

Field Value

GOTRUE_URL - +

URL for the Gotrue server. Defaults to localhost:9999.

@@ -277,7 +277,7 @@

Field Value

STORAGE_KEY - +

@@ -308,7 +308,7 @@

Field Value

diff --git a/api/Supabase.Gotrue.DebugNotification.html b/api/Supabase.Gotrue.DebugNotification.html index c2599c8..eb62269 100644 --- a/api/Supabase.Gotrue.DebugNotification.html +++ b/api/Supabase.Gotrue.DebugNotification.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class DebugNotification +Class DebugNotification

@@ -158,7 +158,7 @@

Methods

AddDebugListener(Action<string, Exception?>) - +

Add a debug listener to the Gotrue Client. This will be called with debug information

@@ -190,7 +190,7 @@

Parameters

Log(string, Exception?) - +

Send a debug message to all debug listeners

@@ -224,7 +224,7 @@

Parameters

diff --git a/api/Supabase.Gotrue.Exceptions.FailureHint.Reason.html b/api/Supabase.Gotrue.Exceptions.FailureHint.Reason.html index 26525ac..6b684c7 100644 --- a/api/Supabase.Gotrue.Exceptions.FailureHint.Reason.html +++ b/api/Supabase.Gotrue.Exceptions.FailureHint.Reason.html @@ -16,7 +16,7 @@ - + @@ -90,7 +90,7 @@
Table of Contents

-Enum FailureHint.Reason +Enum FailureHint.Reason

@@ -181,7 +181,7 @@

Fields diff --git a/api/Supabase.Gotrue.Exceptions.FailureHint.html b/api/Supabase.Gotrue.Exceptions.FailureHint.html index 8f980df..ee5a929 100644 --- a/api/Supabase.Gotrue.Exceptions.FailureHint.html +++ b/api/Supabase.Gotrue.Exceptions.FailureHint.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@

Table of Contents

-Class FailureHint +Class FailureHint

@@ -157,7 +157,7 @@

Methods

DetectReason(GotrueException) - +

Detects the reason for the error based on the status code and the contents of the error message.

@@ -194,7 +194,7 @@

Returns

diff --git a/api/Supabase.Gotrue.Exceptions.GotrueException.html b/api/Supabase.Gotrue.Exceptions.GotrueException.html index 55eedbb..6085cdb 100644 --- a/api/Supabase.Gotrue.Exceptions.GotrueException.html +++ b/api/Supabase.Gotrue.Exceptions.GotrueException.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class GotrueException +Class GotrueException

@@ -197,7 +197,7 @@

Constructors

GotrueException(string?) - +

Something with wrong with Gotrue / Auth

@@ -230,7 +230,7 @@

Parameters

GotrueException(string?, Reason) - +

Something with wrong with Gotrue / Auth

@@ -266,7 +266,7 @@

Parameters

GotrueException(string, Reason, Exception?) - +

Something with wrong with Gotrue / Auth

@@ -304,7 +304,7 @@

Parameters

GotrueException(string?, Exception?) - +

Something with wrong with Gotrue / Auth

@@ -344,7 +344,7 @@

Properties

Content - +

The content of the HTTP response from the server

@@ -376,7 +376,7 @@

Property Value

Reason - +

Best guess at what caused the error from the server, see FailureHint.Reason

@@ -408,7 +408,7 @@

Property Value

Response - +

The HTTP response from the server

@@ -440,7 +440,7 @@

Property Value

StatusCode - +

The HTTP status code from the server

@@ -476,7 +476,7 @@

Methods

AddReason() - +

Adds the best-effort reason for the failure

@@ -503,7 +503,7 @@

- Edit this page + Edit this page

diff --git a/api/Supabase.Gotrue.GenerateLinkEmailChangeCurrentOptions.html b/api/Supabase.Gotrue.GenerateLinkEmailChangeCurrentOptions.html index a713e1b..458dad7 100644 --- a/api/Supabase.Gotrue.GenerateLinkEmailChangeCurrentOptions.html +++ b/api/Supabase.Gotrue.GenerateLinkEmailChangeCurrentOptions.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class GenerateLinkEmailChangeCurrentOptions +Class GenerateLinkEmailChangeCurrentOptions

@@ -176,7 +176,7 @@

Constructors

GenerateLinkEmailChangeCurrentOptions(string, string) - +

Constructs options for EmailChangeCurrent

@@ -210,7 +210,7 @@

Parameters

diff --git a/api/Supabase.Gotrue.GenerateLinkEmailChangeNewOptions.html b/api/Supabase.Gotrue.GenerateLinkEmailChangeNewOptions.html index 3710f74..bc208ee 100644 --- a/api/Supabase.Gotrue.GenerateLinkEmailChangeNewOptions.html +++ b/api/Supabase.Gotrue.GenerateLinkEmailChangeNewOptions.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class GenerateLinkEmailChangeNewOptions +Class GenerateLinkEmailChangeNewOptions

@@ -176,7 +176,7 @@

Constructors

GenerateLinkEmailChangeNewOptions(string, string) - +

Constructs options for EmailChangeNew

@@ -210,7 +210,7 @@

Parameters

diff --git a/api/Supabase.Gotrue.GenerateLinkOptions.LinkType.html b/api/Supabase.Gotrue.GenerateLinkOptions.LinkType.html index b9f6b5f..f5f2a7c 100644 --- a/api/Supabase.Gotrue.GenerateLinkOptions.LinkType.html +++ b/api/Supabase.Gotrue.GenerateLinkOptions.LinkType.html @@ -16,7 +16,7 @@ - + @@ -90,7 +90,7 @@
Table of Contents

-Enum GenerateLinkOptions.LinkType +Enum GenerateLinkOptions.LinkType

@@ -148,7 +148,7 @@

Fields diff --git a/api/Supabase.Gotrue.GenerateLinkOptions.html b/api/Supabase.Gotrue.GenerateLinkOptions.html index a8fcb57..f30259c 100644 --- a/api/Supabase.Gotrue.GenerateLinkOptions.html +++ b/api/Supabase.Gotrue.GenerateLinkOptions.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@

Table of Contents

-Class GenerateLinkOptions +Class GenerateLinkOptions

@@ -165,7 +165,7 @@

Constructors

GenerateLinkOptions(LinkType, string) - +

Constructs options, additional properties may need to be assigned depending on GenerateLinkOptions.LinkType

@@ -208,7 +208,7 @@

Properties

Data - +

A custom data object to store the user's metadata. This maps to the auth.users.user_metadata column.

@@ -242,7 +242,7 @@

Property Value

Email - +

The User's Email

@@ -275,7 +275,7 @@

Property Value

NewEmail - +

The user's new email. Only required if type is 'email_change_current' or 'email_change_new'.

@@ -308,7 +308,7 @@

Property Value

Password - +

Only required if generating a signup link.

@@ -341,7 +341,7 @@

Property Value

RedirectTo - +

The URL which will be appended to the email link generated.

@@ -374,7 +374,7 @@

Property Value

Type - +

The type of link being generated

@@ -407,7 +407,7 @@

Property Value

diff --git a/api/Supabase.Gotrue.GenerateLinkSignupOptions.html b/api/Supabase.Gotrue.GenerateLinkSignupOptions.html index 3488c85..2927074 100644 --- a/api/Supabase.Gotrue.GenerateLinkSignupOptions.html +++ b/api/Supabase.Gotrue.GenerateLinkSignupOptions.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class GenerateLinkSignupOptions +Class GenerateLinkSignupOptions

@@ -176,7 +176,7 @@

Constructors

GenerateLinkSignupOptions(string, string) - +

Constructs options for SignUp

@@ -213,7 +213,7 @@

- Edit this page + Edit this page

diff --git a/api/Supabase.Gotrue.Helpers.html b/api/Supabase.Gotrue.Helpers.html index 98b563e..937a4f1 100644 --- a/api/Supabase.Gotrue.Helpers.html +++ b/api/Supabase.Gotrue.Helpers.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class Helpers +Class Helpers

@@ -157,7 +157,7 @@

Methods

GenerateNonce() - +

Generates a nonce (code verifier) @@ -192,7 +192,7 @@

Returns

GeneratePKCENonceVerifier(string) - +

Generates a PKCE SHA256 code challenge given a nonce (code verifier)

@@ -231,7 +231,7 @@

Returns

GenerateSHA256NonceFromRawNonce(string) - +

Generates a SHA256 nonce given a rawNonce, used Apple/Google Sign in.

@@ -268,7 +268,7 @@

Returns

diff --git a/api/Supabase.Gotrue.Interfaces.IGotrueAdminClient-1.html b/api/Supabase.Gotrue.Interfaces.IGotrueAdminClient-1.html index 0f4c56e..0bdc461 100644 --- a/api/Supabase.Gotrue.Interfaces.IGotrueAdminClient-1.html +++ b/api/Supabase.Gotrue.Interfaces.IGotrueAdminClient-1.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Interface IGotrueAdminClient<TUser> +Interface IGotrueAdminClient<TUser>

@@ -137,7 +137,7 @@

Methods

CreateUser(AdminUserAttributes) - +

Creates a user using the admin key (not the anonymous key). @@ -175,7 +175,7 @@

Returns

CreateUser(string, string, AdminUserAttributes?) - +

Creates a user using the admin key (not the anonymous key). @@ -217,7 +217,7 @@

Returns

DeleteUser(string) - +

Creates a user using the admin key (not the anonymous key). @@ -255,7 +255,7 @@

Returns

Generates email links and OTPs to be sent via a custom email provider.

@@ -293,7 +293,7 @@

Returns

GetUser(string) - +

Gets a user from a user's JWT. This is using the GoTrue server to validate a user's JWT.

@@ -330,7 +330,7 @@

Returns

GetUserById(string) - +

Gets a user by ID from the server using the admin key (not the anonymous key).

@@ -367,7 +367,7 @@

Returns

InviteUserByEmail(string, InviteUserByEmailOptions?) - +

Sends an email to the user.

@@ -406,7 +406,7 @@

Returns

ListUsers(string?, string?, SortOrder, int?, int?) - +

Lists users

@@ -456,7 +456,7 @@

Returns

Update(UserAttributes) - +

Updates a User using the service key

@@ -493,7 +493,7 @@

Returns

UpdateUserById(string, AdminUserAttributes) - +

Update user by Id

@@ -532,7 +532,7 @@

Returns

diff --git a/api/Supabase.Gotrue.Interfaces.IGotrueApi-2.html b/api/Supabase.Gotrue.Interfaces.IGotrueApi-2.html index 37a8224..36090e6 100644 --- a/api/Supabase.Gotrue.Interfaces.IGotrueApi-2.html +++ b/api/Supabase.Gotrue.Interfaces.IGotrueApi-2.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Interface IGotrueApi<TUser, TSession> +Interface IGotrueApi<TUser, TSession>

@@ -138,7 +138,7 @@

Methods

CreateUser(string, AdminUserAttributes?) - +

@@ -176,7 +176,7 @@

Returns

DeleteUser(string, string) - +

@@ -214,7 +214,7 @@

Returns

ExchangeCodeForSession(string, string) - +

@@ -252,7 +252,7 @@

Returns

@@ -290,7 +290,7 @@

Returns

GetUriForProvider(Provider, SignInOptions?) - +

@@ -328,7 +328,7 @@

Returns

GetUser(string) - +

@@ -364,7 +364,7 @@

Returns

GetUserById(string, string) - +

@@ -402,7 +402,7 @@

Returns

InviteUserByEmail(string, string, InviteUserByEmailOptions?) - +

@@ -442,7 +442,7 @@

Returns

LinkIdentity(string, Provider, SignInOptions) - +

Links an oauth identity to an existing user.

@@ -486,7 +486,7 @@

Returns

ListUsers(string, string?, string?, SortOrder, int?, int?) - +

@@ -532,7 +532,7 @@

Returns

Reauthenticate(string) - +

@@ -568,7 +568,7 @@

Returns

RefreshAccessToken(string, string) - +

@@ -606,7 +606,7 @@

Returns

ResetPasswordForEmail(ResetPasswordForEmailOptions) - +

@@ -642,7 +642,7 @@

Returns

ResetPasswordForEmail(string) - +

@@ -678,7 +678,7 @@

Returns

SendMagicLinkEmail(string, SignInOptions?) - +

@@ -716,7 +716,7 @@

Returns

SendMobileOTP(string) - +

@@ -752,7 +752,7 @@

Returns

Settings() - +

@@ -783,7 +783,7 @@

Returns

SignInAnonymously(SignInAnonymouslyOptions?) - +

@@ -819,7 +819,7 @@

Returns

SignInWithEmail(string, string) - +

@@ -857,7 +857,7 @@

Returns

SignInWithIdToken(Provider, string, string?, string?, string?) - +

@@ -901,7 +901,7 @@

Returns

SignInWithOtp(SignInWithPasswordlessEmailOptions) - +

@@ -937,7 +937,7 @@

Returns

SignInWithOtp(SignInWithPasswordlessPhoneOptions) - +

@@ -973,7 +973,7 @@

Returns

SignInWithPhone(string, string) - +

@@ -1011,7 +1011,7 @@

Returns

SignInWithSSO(Guid, SignInWithSSOOptions?) - +

@@ -1049,7 +1049,7 @@

Returns

SignInWithSSO(string, SignInWithSSOOptions?) - +

@@ -1085,22 +1085,24 @@

Returns

-

- SignOut(string) - +

+ SignOut(string, SignOutScope) +

-
Task<BaseResponse> SignOut(string jwt)
+
Task<BaseResponse> SignOut(string jwt, Constants.SignOutScope scope = SignOutScope.Global)

Parameters

jwt string
+
scope Constants.SignOutScope
+

Returns

@@ -1123,7 +1125,7 @@

Returns

SignUpWithEmail(string, string, SignUpOptions?) - +

@@ -1163,7 +1165,7 @@

Returns

SignUpWithPhone(string, string, SignUpOptions?) - +

@@ -1203,7 +1205,7 @@

Returns

UnlinkIdentity(string, UserIdentity) - +

Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked.

@@ -1244,7 +1246,7 @@

Returns

UpdateUser(string, UserAttributes) - +

@@ -1282,7 +1284,7 @@

Returns

UpdateUserById(string, string, UserAttributes) - +

@@ -1322,7 +1324,7 @@

Returns

VerifyEmailOTP(string, string, EmailOtpType) - +

@@ -1362,7 +1364,7 @@

Returns

VerifyMobileOTP(string, string, MobileOtpType) - +

@@ -1402,7 +1404,7 @@

Returns

diff --git a/api/Supabase.Gotrue.Interfaces.IGotrueClient-2.AuthEventHandler.html b/api/Supabase.Gotrue.Interfaces.IGotrueClient-2.AuthEventHandler.html index acabf9c..c161308 100644 --- a/api/Supabase.Gotrue.Interfaces.IGotrueClient-2.AuthEventHandler.html +++ b/api/Supabase.Gotrue.Interfaces.IGotrueClient-2.AuthEventHandler.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Delegate IGotrueClient<TUser, TSession>.AuthEventHandler +Delegate IGotrueClient<TUser, TSession>.AuthEventHandler

@@ -128,7 +128,7 @@

Parameters

diff --git a/api/Supabase.Gotrue.Interfaces.IGotrueClient-2.html b/api/Supabase.Gotrue.Interfaces.IGotrueClient-2.html index 6718673..e8fb23e 100644 --- a/api/Supabase.Gotrue.Interfaces.IGotrueClient-2.html +++ b/api/Supabase.Gotrue.Interfaces.IGotrueClient-2.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Interface IGotrueClient<TUser, TSession> +Interface IGotrueClient<TUser, TSession>

@@ -148,7 +148,7 @@

Properties

CurrentSession - +

The current Session as managed by this client. Does not refresh tokens or have any other side effects.

@@ -182,7 +182,7 @@

Property Value

CurrentUser - +

The currently logged in User. This is a local cache of the current session User. @@ -216,7 +216,7 @@

Property Value

Online - +

Indicates if the client should be considered online or offline.

@@ -251,7 +251,7 @@

Property Value

Options - +

Returns the client options.

@@ -287,7 +287,7 @@

Methods

AddDebugListener(Action<string, Exception?>) - +

Add a listener to get errors that occur outside of a typical Exception flow. @@ -322,7 +322,7 @@

Parameters

AddStateChangedListener(AuthEventHandler) - +

Adds a listener to be notified when the user state changes (e.g. the user logs in, logs out, @@ -356,7 +356,7 @@

Parameters

ClearStateChangedListeners() - +

Clears all of the listeners from receiving event state changes.

@@ -385,7 +385,7 @@

Debug(string, Exception?) - +

Posts messages and exceptions to the debug listener. This is particularly useful for sorting @@ -420,7 +420,7 @@

Parameters

ExchangeCodeForSession(string, string) - +

Logs in an existing user via a third-party provider.

@@ -459,7 +459,7 @@

Returns

GetSessionFromUrl(Uri, bool) - +

Converts a URL to a session. For client apps, this probably requires setting up URL handlers.

@@ -498,7 +498,7 @@

Returns

GetUser(string) - +

Get User details by JWT. Can be used to validate a JWT.

@@ -536,7 +536,7 @@

Returns

LinkIdentity(Provider, SignInOptions) - +

Links an oauth identity to an existing user.

@@ -577,7 +577,7 @@

Returns

LoadSession() - +

Loads the session from the persistence layer.

@@ -604,7 +604,7 @@

NotifyAuthStateChange(AuthState) - +

Notifies all listeners that the current user auth state has changed.

@@ -637,7 +637,7 @@

Parameters

Reauthenticate() - +

Used for re-authenticating a user in password changes.

@@ -675,7 +675,7 @@

Exceptions

RefreshSession() - +

Refreshes the currently logged in User's Session.

@@ -707,7 +707,7 @@

Returns

RefreshToken() - +

Refreshes a Token using the current session.

@@ -739,7 +739,7 @@

Returns

RemoveStateChangedListener(AuthEventHandler) - +

Removes a specified listener from event state changes.

@@ -771,7 +771,7 @@

Parameters

ResetPasswordForEmail(ResetPasswordForEmailOptions) - +

Sends a password reset request to an email address.

@@ -809,7 +809,7 @@

Returns

ResetPasswordForEmail(string) - +

Sends a reset request to an email address.

@@ -846,7 +846,7 @@

Returns

RetrieveSessionAsync() - +

Typically called as part of the startup process for the client.

@@ -881,7 +881,7 @@

Returns

Sends a Magic email login link to the specified email.

@@ -922,7 +922,7 @@

Returns

SetPersistence(IGotrueSessionPersistence<TSession>) - +

Sets the persistence implementation for the client (e.g. file system, local storage, etc).

@@ -954,7 +954,7 @@

Parameters

SetSession(string, string, bool) - +

Sets a new session given a user's access token and their refresh token.

@@ -1009,7 +1009,7 @@

Exceptions

Settings() - +

Retrieves the settings from the server

@@ -1041,7 +1041,7 @@

Returns

Shutdown() - +

Let all of the listeners know that the stateless client is being shutdown.

@@ -1069,7 +1069,7 @@

SignIn(Provider, SignInOptions?) - +

Retrieves a ProviderAuthState to redirect to for signing in with a Constants.Provider.

@@ -1110,7 +1110,7 @@

Returns

SignIn(SignInType, string, string?, string?) - +

Log in an existing user, or login via a third-party provider.

@@ -1157,7 +1157,7 @@

Returns

SignIn(string, SignInOptions?) - +

Sends a magic link login email to the specified email.

@@ -1196,7 +1196,7 @@

Returns

SignIn(string, string) - +

Signs in a User.

@@ -1235,7 +1235,7 @@

Returns

SignInAnonymously(SignInAnonymouslyOptions?) - +

Creates a new anonymous user.

@@ -1273,7 +1273,7 @@

Returns

SignInWithIdToken(Provider, string, string?, string?, string?) - +

Allows signing in with an ID token issued by certain supported providers. @@ -1328,7 +1328,7 @@

SignInWithOtp(SignInWithPasswordlessEmailOptions) - +

Log in a user using magiclink or a one-time password (OTP).

@@ -1377,7 +1377,7 @@

SignInWithOtp(SignInWithPasswordlessPhoneOptions) - +

Log in a user using magiclink or a one-time password (OTP).

@@ -1426,7 +1426,7 @@

SignInWithPassword(string, string) - +

Log in an existing user with an email and password or phone and password.

@@ -1465,7 +1465,7 @@

Returns

SignInWithSSO(Guid, SignInWithSSOOptions?) - +

Sign in using single sign on (SSO) as supported by supabase @@ -1509,7 +1509,7 @@

Returns

SignInWithSSO(string, SignInWithSSOOptions?) - +

Sign in using single sign on (SSO) as supported by supabase @@ -1552,19 +1552,25 @@

Returns

-

- SignOut() - +

+ SignOut(SignOutScope) +

-

Signs out a user and invalidates the current token.

+

Signs out and invalidates all sessions for a user.

-
Task SignOut()
+
Task SignOut(Constants.SignOutScope scope = SignOutScope.Global)
+

Parameters

+
+
scope Constants.SignOutScope
+

Determines which sessions should be invalidated. By default, it will invalidate all session for a user

+
+

Returns

@@ -1586,7 +1592,7 @@

Returns

SignUp(SignUpType, string, string, SignUpOptions?) - +

Signs up a user

@@ -1642,7 +1648,7 @@

SignUp(string, string, SignUpOptions?) - +

Signs up a user by email address.

@@ -1696,7 +1702,7 @@

UnlinkIdentity(UserIdentity) - +

Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked.

@@ -1734,7 +1740,7 @@

Returns

Update(UserAttributes) - +

Updates a User.

@@ -1771,7 +1777,7 @@

Returns

VerifyOTP(string, string, EmailOtpType) - +

Log in a user give a user supplied OTP received via email.

@@ -1813,7 +1819,7 @@

Returns

VerifyOTP(string, string, MobileOtpType) - +

Log in a user given a User supplied OTP received via mobile.

@@ -1857,7 +1863,7 @@

Returns

diff --git a/api/Supabase.Gotrue.Interfaces.IGotruePersistenceListener-1.html b/api/Supabase.Gotrue.Interfaces.IGotruePersistenceListener-1.html index 1ec060d..228b7e4 100644 --- a/api/Supabase.Gotrue.Interfaces.IGotruePersistenceListener-1.html +++ b/api/Supabase.Gotrue.Interfaces.IGotruePersistenceListener-1.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Interface IGotruePersistenceListener<TSession> +Interface IGotruePersistenceListener<TSession>

@@ -130,7 +130,7 @@

Properties

Persistence - +

The persistence implementation for the client (e.g. file system, local storage, etc).

@@ -166,7 +166,7 @@

Methods

EventHandler(IGotrueClient<User, TSession>, AuthState) - +

Routes auth state changes to the persistence implementation.

@@ -200,7 +200,7 @@

Parameters

diff --git a/api/Supabase.Gotrue.Interfaces.IGotrueSessionPersistence-1.html b/api/Supabase.Gotrue.Interfaces.IGotrueSessionPersistence-1.html index 31cbfc9..a1c8c52 100644 --- a/api/Supabase.Gotrue.Interfaces.IGotrueSessionPersistence-1.html +++ b/api/Supabase.Gotrue.Interfaces.IGotrueSessionPersistence-1.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Interface IGotrueSessionPersistence<TSession> +Interface IGotrueSessionPersistence<TSession>

@@ -131,7 +131,7 @@

Methods

DestroySession() - +

Destroys the session in the persistence implementation. Usually this means @@ -159,7 +159,7 @@

LoadSession() - +

Loads the session from the persistence implementation. Returns null if there is no session.

@@ -191,7 +191,7 @@

Returns

SaveSession(TSession) - +

Saves the session to the persistence implementation.

@@ -223,7 +223,7 @@

Parameters

diff --git a/api/Supabase.Gotrue.Interfaces.IGotrueStatelessClient-2.html b/api/Supabase.Gotrue.Interfaces.IGotrueStatelessClient-2.html index 194b60e..b862933 100644 --- a/api/Supabase.Gotrue.Interfaces.IGotrueStatelessClient-2.html +++ b/api/Supabase.Gotrue.Interfaces.IGotrueStatelessClient-2.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Interface IGotrueStatelessClient<TUser, TSession> +Interface IGotrueStatelessClient<TUser, TSession>

@@ -136,7 +136,7 @@

Methods

CreateUser(string, StatelessClientOptions, AdminUserAttributes) - +

Create a user

@@ -178,7 +178,7 @@

Returns

CreateUser(string, StatelessClientOptions, string, string, AdminUserAttributes?) - +

Create a user

@@ -224,7 +224,7 @@

Returns

DeleteUser(string, string, StatelessClientOptions) - +

Deletes a User.

@@ -266,7 +266,7 @@

Returns

GetApi(StatelessClientOptions) - +

Initialize/retrieve the underlying API for this client

@@ -303,7 +303,7 @@

Returns

GetSessionFromUrl(Uri, StatelessClientOptions) - +

Parses a Session out of a Uri's Query parameters.

@@ -342,7 +342,7 @@

Returns

GetUser(string, StatelessClientOptions) - +

Get User details by JWT. Can be used to validate a JWT.

@@ -382,7 +382,7 @@

Returns

GetUserById(string, StatelessClientOptions, string) - +

Get User details by Id

@@ -424,7 +424,7 @@

Returns

InviteUserByEmail(string, string, StatelessClientOptions, InviteUserByEmailOptions?) - +

Sends an invite email link to the specified email.

@@ -468,7 +468,7 @@

Returns

ListUsers(string, StatelessClientOptions, string?, string?, SortOrder, int?, int?) - +

Lists users

@@ -523,7 +523,7 @@

Returns

RefreshToken(string, string, StatelessClientOptions) - +

Refreshes a Token

@@ -564,7 +564,7 @@

Returns

ResetPasswordForEmail(string, StatelessClientOptions) - +

Sends a reset request to an email address.

@@ -608,7 +608,7 @@

Exceptions

Sends a Magic email login link to the specified email.

@@ -649,7 +649,7 @@

Returns

Settings(StatelessClientOptions) - +

Retrieve the current settings for the Gotrue instance.

@@ -686,7 +686,7 @@

Returns

SignIn(Provider, StatelessClientOptions, SignInOptions?) - +

Retrieves a Url to redirect to for signing in with a Constants.Provider.

@@ -738,7 +738,7 @@

SignIn(SignInType, string, string?, StatelessClientOptions?) - +

Log in an existing user, or login via a third-party provider.

@@ -784,7 +784,7 @@

Returns

SignIn(string, StatelessClientOptions, SignInOptions?) - +

Sends a Magic email login link to the specified email.

@@ -825,7 +825,7 @@

Returns

SignIn(string, string, StatelessClientOptions) - +

Signs in a User with an email address and password.

@@ -866,7 +866,7 @@

Returns

SignOut(string, StatelessClientOptions) - +

Logout a User @@ -907,7 +907,7 @@

Returns

SignUp(SignUpType, string, string, StatelessClientOptions, SignUpOptions?) - +

Signs up a user

@@ -955,7 +955,7 @@

Returns

SignUp(string, string, StatelessClientOptions, SignUpOptions?) - +

Signs up a user by email address

@@ -999,7 +999,7 @@

Returns

Update(string, UserAttributes, StatelessClientOptions) - +

Updates a User's attributes

@@ -1040,7 +1040,7 @@

Returns

UpdateUserById(string, StatelessClientOptions, string, AdminUserAttributes) - +

Update user by Id

@@ -1084,7 +1084,7 @@

Returns

VerifyOTP(string, string, StatelessClientOptions, EmailOtpType) - +

Log in a user give a user supplied OTP received via email.

@@ -1127,7 +1127,7 @@

Returns

VerifyOTP(string, string, StatelessClientOptions, MobileOtpType) - +

Log in a user given a User supplied OTP received via mobile.

@@ -1172,7 +1172,7 @@

Returns

diff --git a/api/Supabase.Gotrue.InviteUserByEmailOptions.html b/api/Supabase.Gotrue.InviteUserByEmailOptions.html index ef4a7d7..9ad0918 100644 --- a/api/Supabase.Gotrue.InviteUserByEmailOptions.html +++ b/api/Supabase.Gotrue.InviteUserByEmailOptions.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class InviteUserByEmailOptions +Class InviteUserByEmailOptions

@@ -157,7 +157,7 @@

Properties

Data - +

A custom data object to store additional metadata about the user. This maps to the auth.users.user_metadata column.

@@ -189,7 +189,7 @@

Property Value

RedirectTo - +

The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL.

@@ -221,7 +221,7 @@

Property Value

diff --git a/api/Supabase.Gotrue.NetworkStatus.NetworkListener.html b/api/Supabase.Gotrue.NetworkStatus.NetworkListener.html index 61ca1a0..b848ad9 100644 --- a/api/Supabase.Gotrue.NetworkStatus.NetworkListener.html +++ b/api/Supabase.Gotrue.NetworkStatus.NetworkListener.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Delegate NetworkStatus.NetworkListener +Delegate NetworkStatus.NetworkListener

@@ -126,7 +126,7 @@

Parameters

diff --git a/api/Supabase.Gotrue.NetworkStatus.html b/api/Supabase.Gotrue.NetworkStatus.html index 14fb905..9c48782 100644 --- a/api/Supabase.Gotrue.NetworkStatus.html +++ b/api/Supabase.Gotrue.NetworkStatus.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class NetworkStatus +Class NetworkStatus

@@ -157,7 +157,7 @@

Fields

Ready - +

True if the network has been checked.

@@ -193,7 +193,7 @@

Properties

Client - +

The Client that this network status system is attached to.

@@ -229,7 +229,7 @@

Methods

AddListener(NetworkListener) - +

Adds a listener to the network status system.

@@ -261,7 +261,7 @@

Parameters

~NetworkStatus() - +

Removes the network status system checker from the OS.

@@ -288,7 +288,7 @@

PingCheck(string) - +

Pings the URL in the Options to check if the network is online.

@@ -326,7 +326,7 @@

Returns

RemoveListener(NetworkListener) - +

Removes a listener from the network status system.

@@ -358,7 +358,7 @@

Parameters

StartAsync(string) - +

Starts the network status system. This will listen to the OS for network changes, @@ -396,7 +396,7 @@

Returns

diff --git a/api/Supabase.Gotrue.PasswordlessSignInState.html b/api/Supabase.Gotrue.PasswordlessSignInState.html index f64f4a4..3072417 100644 --- a/api/Supabase.Gotrue.PasswordlessSignInState.html +++ b/api/Supabase.Gotrue.PasswordlessSignInState.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class PasswordlessSignInState +Class PasswordlessSignInState

@@ -158,7 +158,7 @@

Properties

PKCEVerifier - +

PKCE Verifier generated if using the PKCE flow type.

@@ -190,7 +190,7 @@

Property Value

diff --git a/api/Supabase.Gotrue.PersistenceListener.html b/api/Supabase.Gotrue.PersistenceListener.html index 4b47e67..8f9e464 100644 --- a/api/Supabase.Gotrue.PersistenceListener.html +++ b/api/Supabase.Gotrue.PersistenceListener.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class PersistenceListener +Class PersistenceListener

@@ -164,7 +164,7 @@

Constructors

PersistenceListener(IGotrueSessionPersistence<Session>) - +

Create a new persistence listener

@@ -200,7 +200,7 @@

Properties

Persistence - +

The persistence implementation for the client (e.g. file system, local storage, etc).

@@ -236,7 +236,7 @@

Methods

EventHandler(IGotrueClient<User, Session>, AuthState) - +

If you install a persistence listener, it will be called when the user signs in and signs out.

@@ -277,7 +277,7 @@

Exceptions

diff --git a/api/Supabase.Gotrue.ProviderAuthState.html b/api/Supabase.Gotrue.ProviderAuthState.html index e499385..cca7d06 100644 --- a/api/Supabase.Gotrue.ProviderAuthState.html +++ b/api/Supabase.Gotrue.ProviderAuthState.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class ProviderAuthState +Class ProviderAuthState

@@ -164,7 +164,7 @@

Constructors

ProviderAuthState(Uri) - +

Constructor

@@ -200,7 +200,7 @@

Properties

PKCEVerifier - +

The PKCE Verifier nonce, only set during a PKCE auth flow.

@@ -232,7 +232,7 @@

Property Value

Uri - +

The Generated Provider's URI

@@ -264,7 +264,7 @@

Property Value

diff --git a/api/Supabase.Gotrue.ResetPasswordForEmailOptions.html b/api/Supabase.Gotrue.ResetPasswordForEmailOptions.html index 50a2810..68d1708 100644 --- a/api/Supabase.Gotrue.ResetPasswordForEmailOptions.html +++ b/api/Supabase.Gotrue.ResetPasswordForEmailOptions.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class ResetPasswordForEmailOptions +Class ResetPasswordForEmailOptions

@@ -157,7 +157,7 @@

Constructors

ResetPasswordForEmailOptions(string) - +

Initializes a new instance of the ResetPasswordForEmailOptions class with the provided email.

@@ -194,7 +194,7 @@

Properties

CaptchaToken - +

Verification token received when the user completes the captcha on the site.

@@ -226,7 +226,7 @@

Property Value

Email - +

The Email representing the user's account whose password is being reset.

@@ -258,7 +258,7 @@

Property Value

FlowType - +

The OAuth Flow Type.

@@ -290,7 +290,7 @@

Property Value

PKCEVerifier - +

PKCE Verifier generated if using the PKCE flow type.

@@ -322,7 +322,7 @@

Property Value

RedirectTo - +

The URL to send the user to after they click the password reset link.

@@ -354,7 +354,7 @@

Property Value

diff --git a/api/Supabase.Gotrue.ResetPasswordForEmailState.html b/api/Supabase.Gotrue.ResetPasswordForEmailState.html index cc88c0d..7dca096 100644 --- a/api/Supabase.Gotrue.ResetPasswordForEmailState.html +++ b/api/Supabase.Gotrue.ResetPasswordForEmailState.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class ResetPasswordForEmailState +Class ResetPasswordForEmailState

@@ -157,7 +157,7 @@

Properties

PKCEVerifier - +

PKCE Verifier generated if using the PKCE flow type.

@@ -189,7 +189,7 @@

Property Value

diff --git a/api/Supabase.Gotrue.Responses.BaseResponse.html b/api/Supabase.Gotrue.Responses.BaseResponse.html index 5b5c6a1..086aef5 100644 --- a/api/Supabase.Gotrue.Responses.BaseResponse.html +++ b/api/Supabase.Gotrue.Responses.BaseResponse.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class BaseResponse +Class BaseResponse

@@ -157,7 +157,7 @@

Properties

Content - +

The HTTP response content as a string.

@@ -190,7 +190,7 @@

Property Value

ResponseMessage - +

The HTTP response message.

@@ -223,7 +223,7 @@

Property Value

diff --git a/api/Supabase.Gotrue.Responses.GenerateLinkResponse.html b/api/Supabase.Gotrue.Responses.GenerateLinkResponse.html index 902fbc1..c7966d9 100644 --- a/api/Supabase.Gotrue.Responses.GenerateLinkResponse.html +++ b/api/Supabase.Gotrue.Responses.GenerateLinkResponse.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class GenerateLinkResponse +Class GenerateLinkResponse

@@ -212,7 +212,7 @@

Properties

The email link to send to the user. @@ -246,7 +246,7 @@

Property Value

EmailOtp - +

The raw email OTP. @@ -280,7 +280,7 @@

Property Value

HashedToken - +

The hashed token appended to the action link.

@@ -313,7 +313,7 @@

Property Value

RedirectTo - +

The URL appended to the action link.

@@ -346,7 +346,7 @@

Property Value

VerificationType - +

The verification type that the email link is associated to.

@@ -379,7 +379,7 @@

Property Value

diff --git a/api/Supabase.Gotrue.SSOResponse.html b/api/Supabase.Gotrue.SSOResponse.html index ace055c..9404ec3 100644 --- a/api/Supabase.Gotrue.SSOResponse.html +++ b/api/Supabase.Gotrue.SSOResponse.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class SSOResponse +Class SSOResponse

@@ -164,7 +164,7 @@

Constructors

SSOResponse(Uri) - +

Deserialized response from {supabaseAuthUrl}/sso

@@ -197,7 +197,7 @@

Parameters

diff --git a/api/Supabase.Gotrue.Session.html b/api/Supabase.Gotrue.Session.html index 00877a5..383a095 100644 --- a/api/Supabase.Gotrue.Session.html +++ b/api/Supabase.Gotrue.Session.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class Session +Class Session

@@ -157,7 +157,7 @@

Properties

AccessToken - +

The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value.

@@ -190,7 +190,7 @@

Property Value

CreatedAt - +

@@ -222,7 +222,7 @@

Property Value

ExpiresIn - +

The number of seconds until the token expires (since it was issued). Returned when a login is confirmed.

@@ -255,7 +255,7 @@

Property Value

ProviderRefreshToken - +

The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API. @@ -289,7 +289,7 @@

Property Value

ProviderToken - +

The oauth provider token. If present, this can be used to make external API requests to the oauth provider used.

@@ -322,7 +322,7 @@

Property Value

RefreshToken - +

A one-time used refresh token that never expires.

@@ -355,7 +355,7 @@

Property Value

TokenType - +

@@ -387,7 +387,7 @@

Property Value

User - +

@@ -423,7 +423,7 @@

Methods

Expired() - +

Returns true if the session has expired

@@ -455,7 +455,7 @@

Returns

ExpiresAt() - +

The expiration date of this session, in UTC time.

@@ -487,7 +487,7 @@

Returns

diff --git a/api/Supabase.Gotrue.Settings.html b/api/Supabase.Gotrue.Settings.html index c94a983..8959d7f 100644 --- a/api/Supabase.Gotrue.Settings.html +++ b/api/Supabase.Gotrue.Settings.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class Settings +Class Settings

@@ -157,7 +157,7 @@

Properties

DisableSignup - +

@@ -189,7 +189,7 @@

Property Value

ExternalProviders - +

@@ -221,7 +221,7 @@

Property Value

MFAEnabled - +

@@ -253,7 +253,7 @@

Property Value

MailerAutoConfirm - +

@@ -285,7 +285,7 @@

Property Value

PhoneAutoConfirm - +

@@ -317,7 +317,7 @@

Property Value

SAMLEnabled - +

@@ -349,7 +349,7 @@

Property Value

SmsProvider - +

@@ -381,7 +381,7 @@

Property Value

diff --git a/api/Supabase.Gotrue.SignInAnonymouslyOptions.html b/api/Supabase.Gotrue.SignInAnonymouslyOptions.html index 87940af..067afc1 100644 --- a/api/Supabase.Gotrue.SignInAnonymouslyOptions.html +++ b/api/Supabase.Gotrue.SignInAnonymouslyOptions.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class SignInAnonymouslyOptions +Class SignInAnonymouslyOptions

@@ -157,7 +157,7 @@

Properties

CaptchaToken - +

Verification token received when the user completes the captcha on the site.

@@ -190,7 +190,7 @@

Property Value

Data - +

A custom data object to store the user's metadata. This maps to the auth.users.raw_user_meta_data column.

@@ -224,7 +224,7 @@

Property Value

diff --git a/api/Supabase.Gotrue.SignInOptions.html b/api/Supabase.Gotrue.SignInOptions.html index cd4fe83..9dbe75a 100644 --- a/api/Supabase.Gotrue.SignInOptions.html +++ b/api/Supabase.Gotrue.SignInOptions.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class SignInOptions +Class SignInOptions

@@ -164,7 +164,7 @@

Properties

FlowType - +

Represents an OAuth Flow type, defaults to Implicit

@@ -197,7 +197,7 @@

Property Value

QueryParams - +

An object of key-value pairs containing query parameters granted to the OAuth application.

@@ -229,7 +229,7 @@

Property Value

RedirectTo - +

A URL or mobile address to send the user to after they are confirmed.

@@ -261,7 +261,7 @@

Property Value

Scopes - +

A space-separated list of scopes granted to the OAuth application.

@@ -293,7 +293,7 @@

Property Value

diff --git a/api/Supabase.Gotrue.SignInWithPasswordlessEmailOptions.html b/api/Supabase.Gotrue.SignInWithPasswordlessEmailOptions.html index f875bdd..09c88b9 100644 --- a/api/Supabase.Gotrue.SignInWithPasswordlessEmailOptions.html +++ b/api/Supabase.Gotrue.SignInWithPasswordlessEmailOptions.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class SignInWithPasswordlessEmailOptions +Class SignInWithPasswordlessEmailOptions

@@ -167,7 +167,7 @@

Constructors

SignInWithPasswordlessEmailOptions(string) - +

@@ -203,7 +203,7 @@

Properties

Email - +

The user's email address.

@@ -235,7 +235,7 @@

Property Value

EmailRedirectTo - +

The redirect url embedded in the email link.

@@ -267,7 +267,7 @@

Property Value

FlowType - +

Represents an OAuth Flow type, defaults to Implicit

@@ -300,7 +300,7 @@

Property Value

diff --git a/api/Supabase.Gotrue.SignInWithPasswordlessOptions.html b/api/Supabase.Gotrue.SignInWithPasswordlessOptions.html index ce2f230..f0d58f5 100644 --- a/api/Supabase.Gotrue.SignInWithPasswordlessOptions.html +++ b/api/Supabase.Gotrue.SignInWithPasswordlessOptions.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class SignInWithPasswordlessOptions +Class SignInWithPasswordlessOptions

@@ -163,7 +163,7 @@

Fields

Data - +

A custom data object to store the user's metadata. This maps to the auth.users.user_metadata column.

@@ -200,7 +200,7 @@

Properties

CaptchaToken - +

Verification token received when the user completes the captcha on the site.

@@ -232,7 +232,7 @@

Property Value

ShouldCreateUser - +

If set to false, this method will not create a new user. Defaults to true.

@@ -264,7 +264,7 @@

Property Value

diff --git a/api/Supabase.Gotrue.SignInWithPasswordlessPhoneOptions.MessagingChannel.html b/api/Supabase.Gotrue.SignInWithPasswordlessPhoneOptions.MessagingChannel.html index f6fda57..75f22cf 100644 --- a/api/Supabase.Gotrue.SignInWithPasswordlessPhoneOptions.MessagingChannel.html +++ b/api/Supabase.Gotrue.SignInWithPasswordlessPhoneOptions.MessagingChannel.html @@ -16,7 +16,7 @@ - + @@ -90,7 +90,7 @@
Table of Contents

-Enum SignInWithPasswordlessPhoneOptions.MessagingChannel +Enum SignInWithPasswordlessPhoneOptions.MessagingChannel

@@ -131,7 +131,7 @@

Fields diff --git a/api/Supabase.Gotrue.SignInWithPasswordlessPhoneOptions.html b/api/Supabase.Gotrue.SignInWithPasswordlessPhoneOptions.html index 152c3f1..00a5128 100644 --- a/api/Supabase.Gotrue.SignInWithPasswordlessPhoneOptions.html +++ b/api/Supabase.Gotrue.SignInWithPasswordlessPhoneOptions.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@

Table of Contents

-Class SignInWithPasswordlessPhoneOptions +Class SignInWithPasswordlessPhoneOptions

@@ -167,7 +167,7 @@

Constructors

SignInWithPasswordlessPhoneOptions(string) - +

@@ -203,7 +203,7 @@

Properties

Channel - +

Messaging channel to use (e.g. whatsapp or sms), Defaults to SMS.

@@ -235,7 +235,7 @@

Property Value

Phone - +

The user's phone number

@@ -267,7 +267,7 @@

Property Value

diff --git a/api/Supabase.Gotrue.SignInWithSSOOptions.html b/api/Supabase.Gotrue.SignInWithSSOOptions.html index 39d8a20..221e15c 100644 --- a/api/Supabase.Gotrue.SignInWithSSOOptions.html +++ b/api/Supabase.Gotrue.SignInWithSSOOptions.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class SignInWithSSOOptions +Class SignInWithSSOOptions

@@ -170,7 +170,7 @@

Properties

CaptchaToken - +

Verification token received when the user completes the captcha on the site.

@@ -203,7 +203,7 @@

Property Value

diff --git a/api/Supabase.Gotrue.SignUpOptions.html b/api/Supabase.Gotrue.SignUpOptions.html index f1f1161..bd3dfa5 100644 --- a/api/Supabase.Gotrue.SignUpOptions.html +++ b/api/Supabase.Gotrue.SignUpOptions.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class SignUpOptions +Class SignUpOptions

@@ -170,7 +170,7 @@

Properties

Data - +

Optional user metadata.

@@ -202,7 +202,7 @@

Property Value

diff --git a/api/Supabase.Gotrue.StatelessClient.StatelessClientOptions.html b/api/Supabase.Gotrue.StatelessClient.StatelessClientOptions.html index 66f5566..40ee522 100644 --- a/api/Supabase.Gotrue.StatelessClient.StatelessClientOptions.html +++ b/api/Supabase.Gotrue.StatelessClient.StatelessClientOptions.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class StatelessClient.StatelessClientOptions +Class StatelessClient.StatelessClientOptions

@@ -156,7 +156,7 @@

Fields

Headers - +

Headers to be sent with subsequent requests.

@@ -192,7 +192,7 @@

Properties

AllowUnconfirmedUserSessions - +

Very unlikely this flag needs to be changed except in very specific contexts.

@@ -226,7 +226,7 @@

Property Value

Url - +

Gotrue Endpoint

@@ -258,7 +258,7 @@

Property Value

diff --git a/api/Supabase.Gotrue.StatelessClient.html b/api/Supabase.Gotrue.StatelessClient.html index ab3d13c..e00ed5a 100644 --- a/api/Supabase.Gotrue.StatelessClient.html +++ b/api/Supabase.Gotrue.StatelessClient.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class StatelessClient +Class StatelessClient

@@ -162,7 +162,7 @@

Methods

CreateUser(string, StatelessClientOptions, AdminUserAttributes) - +

Create a user

@@ -204,7 +204,7 @@

Returns

CreateUser(string, StatelessClientOptions, string, string, AdminUserAttributes?) - +

Create a user

@@ -250,7 +250,7 @@

Returns

DeleteUser(string, string, StatelessClientOptions) - +

Deletes a User.

@@ -292,7 +292,7 @@

Returns

GetApi(StatelessClientOptions) - +

Initialize/retrieve the underlying API for this client

@@ -329,7 +329,7 @@

Returns

GetSessionFromUrl(Uri, StatelessClientOptions) - +

Parses a Session out of a Uri's Query parameters.

@@ -368,7 +368,7 @@

Returns

GetUser(string, StatelessClientOptions) - +

Get User details by JWT. Can be used to validate a JWT.

@@ -408,7 +408,7 @@

Returns

GetUserById(string, StatelessClientOptions, string) - +

Get User details by Id

@@ -450,7 +450,7 @@

Returns

InviteUserByEmail(string, string, StatelessClientOptions, InviteUserByEmailOptions?) - +

Sends an invite email link to the specified email.

@@ -494,7 +494,7 @@

Returns

ListUsers(string, StatelessClientOptions, string?, string?, SortOrder, int?, int?) - +

Lists users

@@ -549,7 +549,7 @@

Returns

RefreshToken(string, string, StatelessClientOptions) - +

Refreshes a Token

@@ -590,7 +590,7 @@

Returns

ResetPasswordForEmail(string, StatelessClientOptions) - +

Sends a reset request to an email address.

@@ -634,7 +634,7 @@

Exceptions

Sends a Magic email login link to the specified email.

@@ -675,7 +675,7 @@

Returns

Settings(StatelessClientOptions) - +

Retrieve the current settings for the Gotrue instance.

@@ -712,7 +712,7 @@

Returns

SignIn(Provider, StatelessClientOptions, SignInOptions?) - +

Retrieves a Url to redirect to for signing in with a Constants.Provider.

@@ -764,7 +764,7 @@

SignIn(SignInType, string, string?, StatelessClientOptions?) - +

Log in an existing user, or login via a third-party provider.

@@ -810,7 +810,7 @@

Returns

SignIn(string, StatelessClientOptions, SignInOptions?) - +

Sends a Magic email login link to the specified email.

@@ -851,7 +851,7 @@

Returns

SignIn(string, string, StatelessClientOptions) - +

Signs in a User with an email address and password.

@@ -892,7 +892,7 @@

Returns

SignOut(string, StatelessClientOptions) - +

Logout a User @@ -933,7 +933,7 @@

Returns

SignUp(SignUpType, string, string, StatelessClientOptions, SignUpOptions?) - +

Signs up a user

@@ -981,7 +981,7 @@

Returns

SignUp(string, string, StatelessClientOptions, SignUpOptions?) - +

Signs up a user by email address

@@ -1025,7 +1025,7 @@

Returns

Update(string, UserAttributes, StatelessClientOptions) - +

Updates a User's attributes

@@ -1066,7 +1066,7 @@

Returns

UpdateUserById(string, StatelessClientOptions, string, AdminUserAttributes) - +

Update user by Id

@@ -1110,7 +1110,7 @@

Returns

VerifyOTP(string, string, StatelessClientOptions, EmailOtpType) - +

Log in a user give a user supplied OTP received via email.

@@ -1153,7 +1153,7 @@

Returns

VerifyOTP(string, string, StatelessClientOptions, MobileOtpType) - +

Log in a user given a User supplied OTP received via mobile.

@@ -1198,7 +1198,7 @@

Returns

diff --git a/api/Supabase.Gotrue.TokenRefresh.html b/api/Supabase.Gotrue.TokenRefresh.html index 5db5494..bae5616 100644 --- a/api/Supabase.Gotrue.TokenRefresh.html +++ b/api/Supabase.Gotrue.TokenRefresh.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class TokenRefresh +Class TokenRefresh

@@ -157,7 +157,7 @@

Constructors

TokenRefresh(Client) - +

Sets up the TokenRefresh class, bound to a specific client

@@ -192,7 +192,7 @@

Fields

Debug - +

Turn on debug logging for the TokenRefresh

@@ -228,7 +228,7 @@

Methods

ManageAutoRefresh(IGotrueClient<User, Session>, AuthState) - +

Turns the auto-refresh timer on or off based on the current auth state

@@ -268,7 +268,7 @@

Exceptions

diff --git a/api/Supabase.Gotrue.User.html b/api/Supabase.Gotrue.User.html index f6ece49..c42e306 100644 --- a/api/Supabase.Gotrue.User.html +++ b/api/Supabase.Gotrue.User.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class User +Class User

@@ -164,7 +164,7 @@

Properties

AppMetadata - +

@@ -196,7 +196,7 @@

Property Value

Aud - +

@@ -228,7 +228,7 @@

Property Value

ConfirmationSentAt - +

@@ -260,7 +260,7 @@

Property Value

ConfirmedAt - +

@@ -292,7 +292,7 @@

Property Value

CreatedAt - +

@@ -324,7 +324,7 @@

Property Value

Email - +

@@ -356,7 +356,7 @@

Property Value

EmailConfirmedAt - +

@@ -388,7 +388,7 @@

Property Value

Id - +

@@ -420,7 +420,7 @@

Property Value

Identities - +

@@ -452,7 +452,7 @@

Property Value

InvitedAt - +

@@ -484,7 +484,7 @@

Property Value

IsAnonymous - +

@@ -516,7 +516,7 @@

Property Value

LastSignInAt - +

@@ -548,7 +548,7 @@

Property Value

Phone - +

@@ -580,7 +580,7 @@

Property Value

PhoneConfirmedAt - +

@@ -612,7 +612,7 @@

Property Value

RecoverySentAt - +

@@ -644,7 +644,7 @@

Property Value

Role - +

@@ -676,7 +676,7 @@

Property Value

UpdatedAt - +

@@ -708,7 +708,7 @@

Property Value

UserMetadata - +

@@ -740,7 +740,7 @@

Property Value

diff --git a/api/Supabase.Gotrue.UserAttributes.html b/api/Supabase.Gotrue.UserAttributes.html index 0e830c3..0e6255e 100644 --- a/api/Supabase.Gotrue.UserAttributes.html +++ b/api/Supabase.Gotrue.UserAttributes.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class UserAttributes +Class UserAttributes

@@ -163,7 +163,7 @@

Properties

Data - +

A custom data object for user_metadata that a user can modify.Can be any JSON.

@@ -196,7 +196,7 @@

Property Value

Email - +

@@ -228,7 +228,7 @@

Property Value

EmailChangeToken - +

@@ -260,7 +260,7 @@

Property Value

Nonce - +

@@ -292,7 +292,7 @@

Property Value

Password - +

@@ -324,7 +324,7 @@

Property Value

Phone - +

@@ -356,7 +356,7 @@

Property Value

diff --git a/api/Supabase.Gotrue.UserIdentity.html b/api/Supabase.Gotrue.UserIdentity.html index 0a1c294..d209baf 100644 --- a/api/Supabase.Gotrue.UserIdentity.html +++ b/api/Supabase.Gotrue.UserIdentity.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class UserIdentity +Class UserIdentity

@@ -157,7 +157,7 @@

Properties

CreatedAt - +

@@ -189,7 +189,7 @@

Property Value

Id - +

@@ -221,7 +221,7 @@

Property Value

IdentityData - +

@@ -253,7 +253,7 @@

Property Value

IdentityId - +

@@ -285,7 +285,7 @@

Property Value

LastSignInAt - +

@@ -317,7 +317,7 @@

Property Value

Provider - +

@@ -349,7 +349,7 @@

Property Value

UpdatedAt - +

@@ -381,7 +381,7 @@

Property Value

UserId - +

@@ -413,7 +413,7 @@

Property Value

diff --git a/api/Supabase.Gotrue.UserList-1.html b/api/Supabase.Gotrue.UserList-1.html index 3191082..6464011 100644 --- a/api/Supabase.Gotrue.UserList-1.html +++ b/api/Supabase.Gotrue.UserList-1.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class UserList<TUser> +Class UserList<TUser>

@@ -161,7 +161,7 @@

Properties

Aud - +

@@ -193,7 +193,7 @@

Property Value

Users - +

@@ -225,7 +225,7 @@

Property Value

diff --git a/api/Supabase.Gotrue.VerifyOTPParams.html b/api/Supabase.Gotrue.VerifyOTPParams.html index e1b730f..556f62e 100644 --- a/api/Supabase.Gotrue.VerifyOTPParams.html +++ b/api/Supabase.Gotrue.VerifyOTPParams.html @@ -16,7 +16,7 @@ - + @@ -89,7 +89,7 @@
Table of Contents

-Class VerifyOTPParams +Class VerifyOTPParams

@@ -157,7 +157,7 @@

Properties

Email - +

@@ -189,7 +189,7 @@

Property Value

Phone - +

@@ -221,7 +221,7 @@

Property Value

Token - +

@@ -253,7 +253,7 @@

Property Value

Type - +

@@ -285,7 +285,7 @@

Property Value

diff --git a/api/Supabase.Gotrue.html b/api/Supabase.Gotrue.html index 6cceb18..fdff693 100644 --- a/api/Supabase.Gotrue.html +++ b/api/Supabase.Gotrue.html @@ -316,6 +316,10 @@

Specifies the functionality expected from the SignIn method

+
+
Constants.SignOutScope
+
+
Constants.SignUpType

Specifies the functionality expected from the SignUp method

diff --git a/api/toc.html b/api/toc.html index 47fe1a9..968a654 100644 --- a/api/toc.html +++ b/api/toc.html @@ -53,6 +53,9 @@
  • Constants.SignInType
  • +
  • + Constants.SignOutScope +
  • Constants.SignUpType
  • diff --git a/api/toc.json b/api/toc.json index 0421fb3..a003dc9 100644 --- a/api/toc.json +++ b/api/toc.json @@ -1,2 +1,2 @@ -{"items":[{"name":"Supabase.Gotrue","href":"Supabase.Gotrue.html","topicHref":"Supabase.Gotrue.html","topicUid":"Supabase.Gotrue","items":[{"name":"AdminClient","href":"Supabase.Gotrue.AdminClient.html","topicHref":"Supabase.Gotrue.AdminClient.html","topicUid":"Supabase.Gotrue.AdminClient"},{"name":"AdminUserAttributes","href":"Supabase.Gotrue.AdminUserAttributes.html","topicHref":"Supabase.Gotrue.AdminUserAttributes.html","topicUid":"Supabase.Gotrue.AdminUserAttributes"},{"name":"Api","href":"Supabase.Gotrue.Api.html","topicHref":"Supabase.Gotrue.Api.html","topicUid":"Supabase.Gotrue.Api"},{"name":"Client","href":"Supabase.Gotrue.Client.html","topicHref":"Supabase.Gotrue.Client.html","topicUid":"Supabase.Gotrue.Client"},{"name":"ClientOptions","href":"Supabase.Gotrue.ClientOptions.html","topicHref":"Supabase.Gotrue.ClientOptions.html","topicUid":"Supabase.Gotrue.ClientOptions"},{"name":"Constants","href":"Supabase.Gotrue.Constants.html","topicHref":"Supabase.Gotrue.Constants.html","topicUid":"Supabase.Gotrue.Constants"},{"name":"Constants.AuthState","href":"Supabase.Gotrue.Constants.AuthState.html","topicHref":"Supabase.Gotrue.Constants.AuthState.html","topicUid":"Supabase.Gotrue.Constants.AuthState"},{"name":"Constants.EmailOtpType","href":"Supabase.Gotrue.Constants.EmailOtpType.html","topicHref":"Supabase.Gotrue.Constants.EmailOtpType.html","topicUid":"Supabase.Gotrue.Constants.EmailOtpType"},{"name":"Constants.MobileOtpType","href":"Supabase.Gotrue.Constants.MobileOtpType.html","topicHref":"Supabase.Gotrue.Constants.MobileOtpType.html","topicUid":"Supabase.Gotrue.Constants.MobileOtpType"},{"name":"Constants.OAuthFlowType","href":"Supabase.Gotrue.Constants.OAuthFlowType.html","topicHref":"Supabase.Gotrue.Constants.OAuthFlowType.html","topicUid":"Supabase.Gotrue.Constants.OAuthFlowType"},{"name":"Constants.Provider","href":"Supabase.Gotrue.Constants.Provider.html","topicHref":"Supabase.Gotrue.Constants.Provider.html","topicUid":"Supabase.Gotrue.Constants.Provider"},{"name":"Constants.SignInType","href":"Supabase.Gotrue.Constants.SignInType.html","topicHref":"Supabase.Gotrue.Constants.SignInType.html","topicUid":"Supabase.Gotrue.Constants.SignInType"},{"name":"Constants.SignUpType","href":"Supabase.Gotrue.Constants.SignUpType.html","topicHref":"Supabase.Gotrue.Constants.SignUpType.html","topicUid":"Supabase.Gotrue.Constants.SignUpType"},{"name":"Constants.SortOrder","href":"Supabase.Gotrue.Constants.SortOrder.html","topicHref":"Supabase.Gotrue.Constants.SortOrder.html","topicUid":"Supabase.Gotrue.Constants.SortOrder"},{"name":"DebugNotification","href":"Supabase.Gotrue.DebugNotification.html","topicHref":"Supabase.Gotrue.DebugNotification.html","topicUid":"Supabase.Gotrue.DebugNotification"},{"name":"GenerateLinkEmailChangeCurrentOptions","href":"Supabase.Gotrue.GenerateLinkEmailChangeCurrentOptions.html","topicHref":"Supabase.Gotrue.GenerateLinkEmailChangeCurrentOptions.html","topicUid":"Supabase.Gotrue.GenerateLinkEmailChangeCurrentOptions"},{"name":"GenerateLinkEmailChangeNewOptions","href":"Supabase.Gotrue.GenerateLinkEmailChangeNewOptions.html","topicHref":"Supabase.Gotrue.GenerateLinkEmailChangeNewOptions.html","topicUid":"Supabase.Gotrue.GenerateLinkEmailChangeNewOptions"},{"name":"GenerateLinkOptions","href":"Supabase.Gotrue.GenerateLinkOptions.html","topicHref":"Supabase.Gotrue.GenerateLinkOptions.html","topicUid":"Supabase.Gotrue.GenerateLinkOptions"},{"name":"GenerateLinkOptions.LinkType","href":"Supabase.Gotrue.GenerateLinkOptions.LinkType.html","topicHref":"Supabase.Gotrue.GenerateLinkOptions.LinkType.html","topicUid":"Supabase.Gotrue.GenerateLinkOptions.LinkType"},{"name":"GenerateLinkSignupOptions","href":"Supabase.Gotrue.GenerateLinkSignupOptions.html","topicHref":"Supabase.Gotrue.GenerateLinkSignupOptions.html","topicUid":"Supabase.Gotrue.GenerateLinkSignupOptions"},{"name":"Helpers","href":"Supabase.Gotrue.Helpers.html","topicHref":"Supabase.Gotrue.Helpers.html","topicUid":"Supabase.Gotrue.Helpers"},{"name":"InviteUserByEmailOptions","href":"Supabase.Gotrue.InviteUserByEmailOptions.html","topicHref":"Supabase.Gotrue.InviteUserByEmailOptions.html","topicUid":"Supabase.Gotrue.InviteUserByEmailOptions"},{"name":"NetworkStatus","href":"Supabase.Gotrue.NetworkStatus.html","topicHref":"Supabase.Gotrue.NetworkStatus.html","topicUid":"Supabase.Gotrue.NetworkStatus"},{"name":"NetworkStatus.NetworkListener","href":"Supabase.Gotrue.NetworkStatus.NetworkListener.html","topicHref":"Supabase.Gotrue.NetworkStatus.NetworkListener.html","topicUid":"Supabase.Gotrue.NetworkStatus.NetworkListener"},{"name":"PasswordlessSignInState","href":"Supabase.Gotrue.PasswordlessSignInState.html","topicHref":"Supabase.Gotrue.PasswordlessSignInState.html","topicUid":"Supabase.Gotrue.PasswordlessSignInState"},{"name":"PersistenceListener","href":"Supabase.Gotrue.PersistenceListener.html","topicHref":"Supabase.Gotrue.PersistenceListener.html","topicUid":"Supabase.Gotrue.PersistenceListener"},{"name":"ProviderAuthState","href":"Supabase.Gotrue.ProviderAuthState.html","topicHref":"Supabase.Gotrue.ProviderAuthState.html","topicUid":"Supabase.Gotrue.ProviderAuthState"},{"name":"ResetPasswordForEmailOptions","href":"Supabase.Gotrue.ResetPasswordForEmailOptions.html","topicHref":"Supabase.Gotrue.ResetPasswordForEmailOptions.html","topicUid":"Supabase.Gotrue.ResetPasswordForEmailOptions"},{"name":"ResetPasswordForEmailState","href":"Supabase.Gotrue.ResetPasswordForEmailState.html","topicHref":"Supabase.Gotrue.ResetPasswordForEmailState.html","topicUid":"Supabase.Gotrue.ResetPasswordForEmailState"},{"name":"SSOResponse","href":"Supabase.Gotrue.SSOResponse.html","topicHref":"Supabase.Gotrue.SSOResponse.html","topicUid":"Supabase.Gotrue.SSOResponse"},{"name":"Session","href":"Supabase.Gotrue.Session.html","topicHref":"Supabase.Gotrue.Session.html","topicUid":"Supabase.Gotrue.Session"},{"name":"Settings","href":"Supabase.Gotrue.Settings.html","topicHref":"Supabase.Gotrue.Settings.html","topicUid":"Supabase.Gotrue.Settings"},{"name":"SignInAnonymouslyOptions","href":"Supabase.Gotrue.SignInAnonymouslyOptions.html","topicHref":"Supabase.Gotrue.SignInAnonymouslyOptions.html","topicUid":"Supabase.Gotrue.SignInAnonymouslyOptions"},{"name":"SignInOptions","href":"Supabase.Gotrue.SignInOptions.html","topicHref":"Supabase.Gotrue.SignInOptions.html","topicUid":"Supabase.Gotrue.SignInOptions"},{"name":"SignInWithPasswordlessEmailOptions","href":"Supabase.Gotrue.SignInWithPasswordlessEmailOptions.html","topicHref":"Supabase.Gotrue.SignInWithPasswordlessEmailOptions.html","topicUid":"Supabase.Gotrue.SignInWithPasswordlessEmailOptions"},{"name":"SignInWithPasswordlessOptions","href":"Supabase.Gotrue.SignInWithPasswordlessOptions.html","topicHref":"Supabase.Gotrue.SignInWithPasswordlessOptions.html","topicUid":"Supabase.Gotrue.SignInWithPasswordlessOptions"},{"name":"SignInWithPasswordlessPhoneOptions","href":"Supabase.Gotrue.SignInWithPasswordlessPhoneOptions.html","topicHref":"Supabase.Gotrue.SignInWithPasswordlessPhoneOptions.html","topicUid":"Supabase.Gotrue.SignInWithPasswordlessPhoneOptions"},{"name":"SignInWithPasswordlessPhoneOptions.MessagingChannel","href":"Supabase.Gotrue.SignInWithPasswordlessPhoneOptions.MessagingChannel.html","topicHref":"Supabase.Gotrue.SignInWithPasswordlessPhoneOptions.MessagingChannel.html","topicUid":"Supabase.Gotrue.SignInWithPasswordlessPhoneOptions.MessagingChannel"},{"name":"SignInWithSSOOptions","href":"Supabase.Gotrue.SignInWithSSOOptions.html","topicHref":"Supabase.Gotrue.SignInWithSSOOptions.html","topicUid":"Supabase.Gotrue.SignInWithSSOOptions"},{"name":"SignUpOptions","href":"Supabase.Gotrue.SignUpOptions.html","topicHref":"Supabase.Gotrue.SignUpOptions.html","topicUid":"Supabase.Gotrue.SignUpOptions"},{"name":"StatelessClient","href":"Supabase.Gotrue.StatelessClient.html","topicHref":"Supabase.Gotrue.StatelessClient.html","topicUid":"Supabase.Gotrue.StatelessClient"},{"name":"StatelessClient.StatelessClientOptions","href":"Supabase.Gotrue.StatelessClient.StatelessClientOptions.html","topicHref":"Supabase.Gotrue.StatelessClient.StatelessClientOptions.html","topicUid":"Supabase.Gotrue.StatelessClient.StatelessClientOptions"},{"name":"TokenRefresh","href":"Supabase.Gotrue.TokenRefresh.html","topicHref":"Supabase.Gotrue.TokenRefresh.html","topicUid":"Supabase.Gotrue.TokenRefresh"},{"name":"User","href":"Supabase.Gotrue.User.html","topicHref":"Supabase.Gotrue.User.html","topicUid":"Supabase.Gotrue.User"},{"name":"UserAttributes","href":"Supabase.Gotrue.UserAttributes.html","topicHref":"Supabase.Gotrue.UserAttributes.html","topicUid":"Supabase.Gotrue.UserAttributes"},{"name":"UserIdentity","href":"Supabase.Gotrue.UserIdentity.html","topicHref":"Supabase.Gotrue.UserIdentity.html","topicUid":"Supabase.Gotrue.UserIdentity"},{"name":"UserList","href":"Supabase.Gotrue.UserList-1.html","topicHref":"Supabase.Gotrue.UserList-1.html","topicUid":"Supabase.Gotrue.UserList`1"},{"name":"VerifyOTPParams","href":"Supabase.Gotrue.VerifyOTPParams.html","topicHref":"Supabase.Gotrue.VerifyOTPParams.html","topicUid":"Supabase.Gotrue.VerifyOTPParams"}]},{"name":"Supabase.Gotrue.Exceptions","href":"Supabase.Gotrue.Exceptions.html","topicHref":"Supabase.Gotrue.Exceptions.html","topicUid":"Supabase.Gotrue.Exceptions","items":[{"name":"FailureHint","href":"Supabase.Gotrue.Exceptions.FailureHint.html","topicHref":"Supabase.Gotrue.Exceptions.FailureHint.html","topicUid":"Supabase.Gotrue.Exceptions.FailureHint"},{"name":"FailureHint.Reason","href":"Supabase.Gotrue.Exceptions.FailureHint.Reason.html","topicHref":"Supabase.Gotrue.Exceptions.FailureHint.Reason.html","topicUid":"Supabase.Gotrue.Exceptions.FailureHint.Reason"},{"name":"GotrueException","href":"Supabase.Gotrue.Exceptions.GotrueException.html","topicHref":"Supabase.Gotrue.Exceptions.GotrueException.html","topicUid":"Supabase.Gotrue.Exceptions.GotrueException"}]},{"name":"Supabase.Gotrue.Interfaces","href":"Supabase.Gotrue.Interfaces.html","topicHref":"Supabase.Gotrue.Interfaces.html","topicUid":"Supabase.Gotrue.Interfaces","items":[{"name":"IGotrueAdminClient","href":"Supabase.Gotrue.Interfaces.IGotrueAdminClient-1.html","topicHref":"Supabase.Gotrue.Interfaces.IGotrueAdminClient-1.html","topicUid":"Supabase.Gotrue.Interfaces.IGotrueAdminClient`1"},{"name":"IGotrueApi","href":"Supabase.Gotrue.Interfaces.IGotrueApi-2.html","topicHref":"Supabase.Gotrue.Interfaces.IGotrueApi-2.html","topicUid":"Supabase.Gotrue.Interfaces.IGotrueApi`2"},{"name":"IGotrueClient","href":"Supabase.Gotrue.Interfaces.IGotrueClient-2.html","topicHref":"Supabase.Gotrue.Interfaces.IGotrueClient-2.html","topicUid":"Supabase.Gotrue.Interfaces.IGotrueClient`2"},{"name":"IGotrueClient.AuthEventHandler","href":"Supabase.Gotrue.Interfaces.IGotrueClient-2.AuthEventHandler.html","topicHref":"Supabase.Gotrue.Interfaces.IGotrueClient-2.AuthEventHandler.html","topicUid":"Supabase.Gotrue.Interfaces.IGotrueClient`2.AuthEventHandler"},{"name":"IGotruePersistenceListener","href":"Supabase.Gotrue.Interfaces.IGotruePersistenceListener-1.html","topicHref":"Supabase.Gotrue.Interfaces.IGotruePersistenceListener-1.html","topicUid":"Supabase.Gotrue.Interfaces.IGotruePersistenceListener`1"},{"name":"IGotrueSessionPersistence","href":"Supabase.Gotrue.Interfaces.IGotrueSessionPersistence-1.html","topicHref":"Supabase.Gotrue.Interfaces.IGotrueSessionPersistence-1.html","topicUid":"Supabase.Gotrue.Interfaces.IGotrueSessionPersistence`1"},{"name":"IGotrueStatelessClient","href":"Supabase.Gotrue.Interfaces.IGotrueStatelessClient-2.html","topicHref":"Supabase.Gotrue.Interfaces.IGotrueStatelessClient-2.html","topicUid":"Supabase.Gotrue.Interfaces.IGotrueStatelessClient`2"}]},{"name":"Supabase.Gotrue.Responses","href":"Supabase.Gotrue.Responses.html","topicHref":"Supabase.Gotrue.Responses.html","topicUid":"Supabase.Gotrue.Responses","items":[{"name":"BaseResponse","href":"Supabase.Gotrue.Responses.BaseResponse.html","topicHref":"Supabase.Gotrue.Responses.BaseResponse.html","topicUid":"Supabase.Gotrue.Responses.BaseResponse"},{"name":"GenerateLinkResponse","href":"Supabase.Gotrue.Responses.GenerateLinkResponse.html","topicHref":"Supabase.Gotrue.Responses.GenerateLinkResponse.html","topicUid":"Supabase.Gotrue.Responses.GenerateLinkResponse"}]}],"memberLayout":"SamePage"} +{"items":[{"name":"Supabase.Gotrue","href":"Supabase.Gotrue.html","topicHref":"Supabase.Gotrue.html","topicUid":"Supabase.Gotrue","items":[{"name":"AdminClient","href":"Supabase.Gotrue.AdminClient.html","topicHref":"Supabase.Gotrue.AdminClient.html","topicUid":"Supabase.Gotrue.AdminClient"},{"name":"AdminUserAttributes","href":"Supabase.Gotrue.AdminUserAttributes.html","topicHref":"Supabase.Gotrue.AdminUserAttributes.html","topicUid":"Supabase.Gotrue.AdminUserAttributes"},{"name":"Api","href":"Supabase.Gotrue.Api.html","topicHref":"Supabase.Gotrue.Api.html","topicUid":"Supabase.Gotrue.Api"},{"name":"Client","href":"Supabase.Gotrue.Client.html","topicHref":"Supabase.Gotrue.Client.html","topicUid":"Supabase.Gotrue.Client"},{"name":"ClientOptions","href":"Supabase.Gotrue.ClientOptions.html","topicHref":"Supabase.Gotrue.ClientOptions.html","topicUid":"Supabase.Gotrue.ClientOptions"},{"name":"Constants","href":"Supabase.Gotrue.Constants.html","topicHref":"Supabase.Gotrue.Constants.html","topicUid":"Supabase.Gotrue.Constants"},{"name":"Constants.AuthState","href":"Supabase.Gotrue.Constants.AuthState.html","topicHref":"Supabase.Gotrue.Constants.AuthState.html","topicUid":"Supabase.Gotrue.Constants.AuthState"},{"name":"Constants.EmailOtpType","href":"Supabase.Gotrue.Constants.EmailOtpType.html","topicHref":"Supabase.Gotrue.Constants.EmailOtpType.html","topicUid":"Supabase.Gotrue.Constants.EmailOtpType"},{"name":"Constants.MobileOtpType","href":"Supabase.Gotrue.Constants.MobileOtpType.html","topicHref":"Supabase.Gotrue.Constants.MobileOtpType.html","topicUid":"Supabase.Gotrue.Constants.MobileOtpType"},{"name":"Constants.OAuthFlowType","href":"Supabase.Gotrue.Constants.OAuthFlowType.html","topicHref":"Supabase.Gotrue.Constants.OAuthFlowType.html","topicUid":"Supabase.Gotrue.Constants.OAuthFlowType"},{"name":"Constants.Provider","href":"Supabase.Gotrue.Constants.Provider.html","topicHref":"Supabase.Gotrue.Constants.Provider.html","topicUid":"Supabase.Gotrue.Constants.Provider"},{"name":"Constants.SignInType","href":"Supabase.Gotrue.Constants.SignInType.html","topicHref":"Supabase.Gotrue.Constants.SignInType.html","topicUid":"Supabase.Gotrue.Constants.SignInType"},{"name":"Constants.SignOutScope","href":"Supabase.Gotrue.Constants.SignOutScope.html","topicHref":"Supabase.Gotrue.Constants.SignOutScope.html","topicUid":"Supabase.Gotrue.Constants.SignOutScope"},{"name":"Constants.SignUpType","href":"Supabase.Gotrue.Constants.SignUpType.html","topicHref":"Supabase.Gotrue.Constants.SignUpType.html","topicUid":"Supabase.Gotrue.Constants.SignUpType"},{"name":"Constants.SortOrder","href":"Supabase.Gotrue.Constants.SortOrder.html","topicHref":"Supabase.Gotrue.Constants.SortOrder.html","topicUid":"Supabase.Gotrue.Constants.SortOrder"},{"name":"DebugNotification","href":"Supabase.Gotrue.DebugNotification.html","topicHref":"Supabase.Gotrue.DebugNotification.html","topicUid":"Supabase.Gotrue.DebugNotification"},{"name":"GenerateLinkEmailChangeCurrentOptions","href":"Supabase.Gotrue.GenerateLinkEmailChangeCurrentOptions.html","topicHref":"Supabase.Gotrue.GenerateLinkEmailChangeCurrentOptions.html","topicUid":"Supabase.Gotrue.GenerateLinkEmailChangeCurrentOptions"},{"name":"GenerateLinkEmailChangeNewOptions","href":"Supabase.Gotrue.GenerateLinkEmailChangeNewOptions.html","topicHref":"Supabase.Gotrue.GenerateLinkEmailChangeNewOptions.html","topicUid":"Supabase.Gotrue.GenerateLinkEmailChangeNewOptions"},{"name":"GenerateLinkOptions","href":"Supabase.Gotrue.GenerateLinkOptions.html","topicHref":"Supabase.Gotrue.GenerateLinkOptions.html","topicUid":"Supabase.Gotrue.GenerateLinkOptions"},{"name":"GenerateLinkOptions.LinkType","href":"Supabase.Gotrue.GenerateLinkOptions.LinkType.html","topicHref":"Supabase.Gotrue.GenerateLinkOptions.LinkType.html","topicUid":"Supabase.Gotrue.GenerateLinkOptions.LinkType"},{"name":"GenerateLinkSignupOptions","href":"Supabase.Gotrue.GenerateLinkSignupOptions.html","topicHref":"Supabase.Gotrue.GenerateLinkSignupOptions.html","topicUid":"Supabase.Gotrue.GenerateLinkSignupOptions"},{"name":"Helpers","href":"Supabase.Gotrue.Helpers.html","topicHref":"Supabase.Gotrue.Helpers.html","topicUid":"Supabase.Gotrue.Helpers"},{"name":"InviteUserByEmailOptions","href":"Supabase.Gotrue.InviteUserByEmailOptions.html","topicHref":"Supabase.Gotrue.InviteUserByEmailOptions.html","topicUid":"Supabase.Gotrue.InviteUserByEmailOptions"},{"name":"NetworkStatus","href":"Supabase.Gotrue.NetworkStatus.html","topicHref":"Supabase.Gotrue.NetworkStatus.html","topicUid":"Supabase.Gotrue.NetworkStatus"},{"name":"NetworkStatus.NetworkListener","href":"Supabase.Gotrue.NetworkStatus.NetworkListener.html","topicHref":"Supabase.Gotrue.NetworkStatus.NetworkListener.html","topicUid":"Supabase.Gotrue.NetworkStatus.NetworkListener"},{"name":"PasswordlessSignInState","href":"Supabase.Gotrue.PasswordlessSignInState.html","topicHref":"Supabase.Gotrue.PasswordlessSignInState.html","topicUid":"Supabase.Gotrue.PasswordlessSignInState"},{"name":"PersistenceListener","href":"Supabase.Gotrue.PersistenceListener.html","topicHref":"Supabase.Gotrue.PersistenceListener.html","topicUid":"Supabase.Gotrue.PersistenceListener"},{"name":"ProviderAuthState","href":"Supabase.Gotrue.ProviderAuthState.html","topicHref":"Supabase.Gotrue.ProviderAuthState.html","topicUid":"Supabase.Gotrue.ProviderAuthState"},{"name":"ResetPasswordForEmailOptions","href":"Supabase.Gotrue.ResetPasswordForEmailOptions.html","topicHref":"Supabase.Gotrue.ResetPasswordForEmailOptions.html","topicUid":"Supabase.Gotrue.ResetPasswordForEmailOptions"},{"name":"ResetPasswordForEmailState","href":"Supabase.Gotrue.ResetPasswordForEmailState.html","topicHref":"Supabase.Gotrue.ResetPasswordForEmailState.html","topicUid":"Supabase.Gotrue.ResetPasswordForEmailState"},{"name":"SSOResponse","href":"Supabase.Gotrue.SSOResponse.html","topicHref":"Supabase.Gotrue.SSOResponse.html","topicUid":"Supabase.Gotrue.SSOResponse"},{"name":"Session","href":"Supabase.Gotrue.Session.html","topicHref":"Supabase.Gotrue.Session.html","topicUid":"Supabase.Gotrue.Session"},{"name":"Settings","href":"Supabase.Gotrue.Settings.html","topicHref":"Supabase.Gotrue.Settings.html","topicUid":"Supabase.Gotrue.Settings"},{"name":"SignInAnonymouslyOptions","href":"Supabase.Gotrue.SignInAnonymouslyOptions.html","topicHref":"Supabase.Gotrue.SignInAnonymouslyOptions.html","topicUid":"Supabase.Gotrue.SignInAnonymouslyOptions"},{"name":"SignInOptions","href":"Supabase.Gotrue.SignInOptions.html","topicHref":"Supabase.Gotrue.SignInOptions.html","topicUid":"Supabase.Gotrue.SignInOptions"},{"name":"SignInWithPasswordlessEmailOptions","href":"Supabase.Gotrue.SignInWithPasswordlessEmailOptions.html","topicHref":"Supabase.Gotrue.SignInWithPasswordlessEmailOptions.html","topicUid":"Supabase.Gotrue.SignInWithPasswordlessEmailOptions"},{"name":"SignInWithPasswordlessOptions","href":"Supabase.Gotrue.SignInWithPasswordlessOptions.html","topicHref":"Supabase.Gotrue.SignInWithPasswordlessOptions.html","topicUid":"Supabase.Gotrue.SignInWithPasswordlessOptions"},{"name":"SignInWithPasswordlessPhoneOptions","href":"Supabase.Gotrue.SignInWithPasswordlessPhoneOptions.html","topicHref":"Supabase.Gotrue.SignInWithPasswordlessPhoneOptions.html","topicUid":"Supabase.Gotrue.SignInWithPasswordlessPhoneOptions"},{"name":"SignInWithPasswordlessPhoneOptions.MessagingChannel","href":"Supabase.Gotrue.SignInWithPasswordlessPhoneOptions.MessagingChannel.html","topicHref":"Supabase.Gotrue.SignInWithPasswordlessPhoneOptions.MessagingChannel.html","topicUid":"Supabase.Gotrue.SignInWithPasswordlessPhoneOptions.MessagingChannel"},{"name":"SignInWithSSOOptions","href":"Supabase.Gotrue.SignInWithSSOOptions.html","topicHref":"Supabase.Gotrue.SignInWithSSOOptions.html","topicUid":"Supabase.Gotrue.SignInWithSSOOptions"},{"name":"SignUpOptions","href":"Supabase.Gotrue.SignUpOptions.html","topicHref":"Supabase.Gotrue.SignUpOptions.html","topicUid":"Supabase.Gotrue.SignUpOptions"},{"name":"StatelessClient","href":"Supabase.Gotrue.StatelessClient.html","topicHref":"Supabase.Gotrue.StatelessClient.html","topicUid":"Supabase.Gotrue.StatelessClient"},{"name":"StatelessClient.StatelessClientOptions","href":"Supabase.Gotrue.StatelessClient.StatelessClientOptions.html","topicHref":"Supabase.Gotrue.StatelessClient.StatelessClientOptions.html","topicUid":"Supabase.Gotrue.StatelessClient.StatelessClientOptions"},{"name":"TokenRefresh","href":"Supabase.Gotrue.TokenRefresh.html","topicHref":"Supabase.Gotrue.TokenRefresh.html","topicUid":"Supabase.Gotrue.TokenRefresh"},{"name":"User","href":"Supabase.Gotrue.User.html","topicHref":"Supabase.Gotrue.User.html","topicUid":"Supabase.Gotrue.User"},{"name":"UserAttributes","href":"Supabase.Gotrue.UserAttributes.html","topicHref":"Supabase.Gotrue.UserAttributes.html","topicUid":"Supabase.Gotrue.UserAttributes"},{"name":"UserIdentity","href":"Supabase.Gotrue.UserIdentity.html","topicHref":"Supabase.Gotrue.UserIdentity.html","topicUid":"Supabase.Gotrue.UserIdentity"},{"name":"UserList","href":"Supabase.Gotrue.UserList-1.html","topicHref":"Supabase.Gotrue.UserList-1.html","topicUid":"Supabase.Gotrue.UserList`1"},{"name":"VerifyOTPParams","href":"Supabase.Gotrue.VerifyOTPParams.html","topicHref":"Supabase.Gotrue.VerifyOTPParams.html","topicUid":"Supabase.Gotrue.VerifyOTPParams"}]},{"name":"Supabase.Gotrue.Exceptions","href":"Supabase.Gotrue.Exceptions.html","topicHref":"Supabase.Gotrue.Exceptions.html","topicUid":"Supabase.Gotrue.Exceptions","items":[{"name":"FailureHint","href":"Supabase.Gotrue.Exceptions.FailureHint.html","topicHref":"Supabase.Gotrue.Exceptions.FailureHint.html","topicUid":"Supabase.Gotrue.Exceptions.FailureHint"},{"name":"FailureHint.Reason","href":"Supabase.Gotrue.Exceptions.FailureHint.Reason.html","topicHref":"Supabase.Gotrue.Exceptions.FailureHint.Reason.html","topicUid":"Supabase.Gotrue.Exceptions.FailureHint.Reason"},{"name":"GotrueException","href":"Supabase.Gotrue.Exceptions.GotrueException.html","topicHref":"Supabase.Gotrue.Exceptions.GotrueException.html","topicUid":"Supabase.Gotrue.Exceptions.GotrueException"}]},{"name":"Supabase.Gotrue.Interfaces","href":"Supabase.Gotrue.Interfaces.html","topicHref":"Supabase.Gotrue.Interfaces.html","topicUid":"Supabase.Gotrue.Interfaces","items":[{"name":"IGotrueAdminClient","href":"Supabase.Gotrue.Interfaces.IGotrueAdminClient-1.html","topicHref":"Supabase.Gotrue.Interfaces.IGotrueAdminClient-1.html","topicUid":"Supabase.Gotrue.Interfaces.IGotrueAdminClient`1"},{"name":"IGotrueApi","href":"Supabase.Gotrue.Interfaces.IGotrueApi-2.html","topicHref":"Supabase.Gotrue.Interfaces.IGotrueApi-2.html","topicUid":"Supabase.Gotrue.Interfaces.IGotrueApi`2"},{"name":"IGotrueClient","href":"Supabase.Gotrue.Interfaces.IGotrueClient-2.html","topicHref":"Supabase.Gotrue.Interfaces.IGotrueClient-2.html","topicUid":"Supabase.Gotrue.Interfaces.IGotrueClient`2"},{"name":"IGotrueClient.AuthEventHandler","href":"Supabase.Gotrue.Interfaces.IGotrueClient-2.AuthEventHandler.html","topicHref":"Supabase.Gotrue.Interfaces.IGotrueClient-2.AuthEventHandler.html","topicUid":"Supabase.Gotrue.Interfaces.IGotrueClient`2.AuthEventHandler"},{"name":"IGotruePersistenceListener","href":"Supabase.Gotrue.Interfaces.IGotruePersistenceListener-1.html","topicHref":"Supabase.Gotrue.Interfaces.IGotruePersistenceListener-1.html","topicUid":"Supabase.Gotrue.Interfaces.IGotruePersistenceListener`1"},{"name":"IGotrueSessionPersistence","href":"Supabase.Gotrue.Interfaces.IGotrueSessionPersistence-1.html","topicHref":"Supabase.Gotrue.Interfaces.IGotrueSessionPersistence-1.html","topicUid":"Supabase.Gotrue.Interfaces.IGotrueSessionPersistence`1"},{"name":"IGotrueStatelessClient","href":"Supabase.Gotrue.Interfaces.IGotrueStatelessClient-2.html","topicHref":"Supabase.Gotrue.Interfaces.IGotrueStatelessClient-2.html","topicUid":"Supabase.Gotrue.Interfaces.IGotrueStatelessClient`2"}]},{"name":"Supabase.Gotrue.Responses","href":"Supabase.Gotrue.Responses.html","topicHref":"Supabase.Gotrue.Responses.html","topicUid":"Supabase.Gotrue.Responses","items":[{"name":"BaseResponse","href":"Supabase.Gotrue.Responses.BaseResponse.html","topicHref":"Supabase.Gotrue.Responses.BaseResponse.html","topicUid":"Supabase.Gotrue.Responses.BaseResponse"},{"name":"GenerateLinkResponse","href":"Supabase.Gotrue.Responses.GenerateLinkResponse.html","topicHref":"Supabase.Gotrue.Responses.GenerateLinkResponse.html","topicUid":"Supabase.Gotrue.Responses.GenerateLinkResponse"}]}],"memberLayout":"SamePage"} diff --git a/index.html b/index.html index b5d0ceb..91a3e24 100644 --- a/index.html +++ b/index.html @@ -16,7 +16,7 @@ - + @@ -77,7 +77,7 @@

    gotrue-csharp

    diff --git a/index.json b/index.json index 538a982..f6f30fd 100644 --- a/index.json +++ b/index.json @@ -12,12 +12,12 @@ "api/Supabase.Gotrue.Api.html": { "href": "api/Supabase.Gotrue.Api.html", "title": "Class Api | gotrue-csharp", - "keywords": "Class Api Namespace Supabase.Gotrue Assembly Supabase.Gotrue.dll The REST calls to the Gotrue API. public class Api : IGotrueApi, IGettableHeaders Inheritance object Api Implements IGotrueApi IGettableHeaders Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors Api(string, Dictionary?) Creates a new API client public Api(string url, Dictionary? headers = null) Parameters url string headers Dictionary Properties GetHeaders Function that can be set to return dynamic headers. Headers specified in the constructor will ALWAYS take precedence over headers returned by this function. public Func>? GetHeaders { get; set; } Property Value Func> Headers Headers to be sent with every request. These will be merged with any headers returned by GetHeaders. protected Dictionary Headers { get; set; } Property Value Dictionary Methods CreateUser(string, AdminUserAttributes?) Create a user public Task CreateUser(string jwt, AdminUserAttributes? attributes = null) Parameters jwt string A valid JWT. Must be a full-access API key (e.g. service_role key). attributes AdminUserAttributes Additional administrative details Returns Task DeleteUser(string, string) Delete a user public Task DeleteUser(string uid, string jwt) Parameters uid string The user uid you want to remove. jwt string A valid JWT. Must be a full-access API key (e.g. service_role key). Returns Task ExchangeCodeForSession(string, string) Log in an existing user via code from third-party provider. public Task ExchangeCodeForSession(string codeVerifier, string authCode) Parameters codeVerifier string Generated verifier (probably from GetUrlForProvider) authCode string The received Auth Code Callback Returns Task GenerateLink(string, GenerateLinkOptions) Generates email links and OTPs to be sent via a custom email provider. public Task GenerateLink(string jwt, GenerateLinkOptions options) Parameters jwt string options GenerateLinkOptions Returns Task GetUriForProvider(Provider, SignInOptions?) public ProviderAuthState GetUriForProvider(Constants.Provider provider, SignInOptions? options = null) Parameters provider Constants.Provider options SignInOptions Returns ProviderAuthState GetUser(string) Gets User Details public Task GetUser(string jwt) Parameters jwt string Returns Task GetUserById(string, string) Get User details by Id public Task GetUserById(string jwt, string userId) Parameters jwt string A valid JWT. Must be a full-access API key (e.g. service_role key). userId string userID Returns Task InviteUserByEmail(string, string, InviteUserByEmailOptions?) Sends an invite link to an email address. public Task InviteUserByEmail(string email, string jwt, InviteUserByEmailOptions? options = null) Parameters email string jwt string this token needs role 'supabase_admin' or 'service_role' options InviteUserByEmailOptions Returns Task LinkIdentity(string, Provider, SignInOptions) Links an oauth identity to an existing user. This method requires the PKCE flow. public Task LinkIdentity(string token, Constants.Provider provider, SignInOptions options) Parameters token string User's token provider Constants.Provider Provider to Link options SignInOptions Returns Task ListUsers(string, string?, string?, SortOrder, int?, int?) Lists users public Task?> ListUsers(string jwt, string? filter = null, string? sortBy = null, Constants.SortOrder sortOrder = SortOrder.Descending, int? page = null, int? perPage = null) Parameters jwt string A valid JWT. Must be a full-access API key (e.g. service_role key). filter string A string for example part of the email sortBy string Snake case string of the given key, currently only created_at is supported sortOrder Constants.SortOrder asc or desc, if null desc is used page int? page to show for pagination perPage int? items per page for pagination Returns Task> Reauthenticate(string) Sends a re-authentication request, used for password changes. See: https://github.com/supabase/gotrue#get-reauthenticate public Task Reauthenticate(string userJwt) Parameters userJwt string The user's auth token. Returns Task RefreshAccessToken(string, string) Generates a new Session given a user's access token and refresh token. public Task RefreshAccessToken(string accessToken, string refreshToken) Parameters accessToken string refreshToken string Returns Task ResetPasswordForEmail(ResetPasswordForEmailOptions) Sends a password reset request to an email address. This Method supports the PKCE Flow public Task ResetPasswordForEmail(ResetPasswordForEmailOptions options) Parameters options ResetPasswordForEmailOptions Returns Task ResetPasswordForEmail(string) Sends a reset request to an email address. public Task ResetPasswordForEmail(string email) Parameters email string Returns Task SendMagicLinkEmail(string, SignInOptions?) Sends a magic login link to an email address. public Task SendMagicLinkEmail(string email, SignInOptions? options = null) Parameters email string options SignInOptions Returns Task SendMobileOTP(string) Sends a mobile OTP via SMS. Will register the account if it doesn't already exist public Task SendMobileOTP(string phone) Parameters phone string phone The user's phone number WITH international prefix Returns Task Settings() Calls the GoTrue server to get the settings (for example, if email auto confirmation is turned on) public Task Settings() Returns Task mpose up -d SignInAnonymously(SignInAnonymouslyOptions?) Creates a new anonymous user. public Task SignInAnonymously(SignInAnonymouslyOptions? options = null) Parameters options SignInAnonymouslyOptions Returns Task A session where the is_anonymous claim in the access token JWT set to true SignInWithEmail(string, string) Logs in an existing user using their email address. public Task SignInWithEmail(string email, string password) Parameters email string password string Returns Task SignInWithIdToken(Provider, string, string?, string?, string?) Allows signing in with an ID token issued by certain supported providers. The [idToken] is verified for validity and a new session is established. This method of signing in only supports [Provider.Google] or [Provider.Apple]. public Task SignInWithIdToken(Constants.Provider provider, string idToken, string? accessToken = null, string? nonce = null, string? captchaToken = null) Parameters provider Constants.Provider A supported provider (Google, Apple, Azure, Facebook) idToken string OIDC ID token issued by the specified provider. The iss claim in the ID token must match the supplied provider. Some ID tokens contain an at_hash which require that you provide an access_token value to be accepted properly. If the token contains a nonce claim you must supply the nonce used to obtain the ID token. accessToken string If the ID token contains an at_hash claim, then the hash of this value is compared to the value in the ID token. nonce string If the ID token contains a nonce claim, then the hash of this value is compared to the value in the ID token. captchaToken string Verification token received when the user completes the captcha on the site. Returns Task SignInWithOtp(SignInWithPasswordlessEmailOptions) Log in a user using magiclink or a one-time password (OTP). If the {{ .ConfirmationURL }} variable is specified in the email template, a magiclink will be sent. If the {{ .Token }} variable is specified in the email template, an OTP will be sent. If you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins. Be aware that you may get back an error message that will not distinguish between the cases where the account does not exist or, that the account can only be accessed via social login. Do note that you will need to configure a Whatsapp sender on Twilio if you are using phone sign in with the 'whatsapp' channel. The whatsapp channel is not supported on other providers at this time. public Task SignInWithOtp(SignInWithPasswordlessEmailOptions options) Parameters options SignInWithPasswordlessEmailOptions Returns Task SignInWithOtp(SignInWithPasswordlessPhoneOptions) Log in a user using magiclink or a one-time password (OTP). If the {{ .ConfirmationURL }} variable is specified in the email template, a magiclink will be sent. If the {{ .Token }} variable is specified in the email template, an OTP will be sent. If you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins. Be aware that you may get back an error message that will not distinguish between the cases where the account does not exist or, that the account can only be accessed via social login. Do note that you will need to configure a Whatsapp sender on Twilio if you are using phone sign in with the 'whatsapp' channel. The whatsapp channel is not supported on other providers at this time. public Task SignInWithOtp(SignInWithPasswordlessPhoneOptions options) Parameters options SignInWithPasswordlessPhoneOptions Returns Task SignInWithPhone(string, string) Logs in an existing user using their phone number and password. public Task SignInWithPhone(string phone, string password) Parameters phone string The phone number of the user. password string The password of the user. Returns Task SignInWithSSO(Guid, SignInWithSSOOptions?) public Task SignInWithSSO(Guid providerId, SignInWithSSOOptions? options = null) Parameters providerId Guid options SignInWithSSOOptions Returns Task SignInWithSSO(string, SignInWithSSOOptions?) public Task SignInWithSSO(string domain, SignInWithSSOOptions? options = null) Parameters domain string options SignInWithSSOOptions Returns Task SignOut(string) Removes a logged-in session. public Task SignOut(string jwt) Parameters jwt string Returns Task SignUpWithEmail(string, string, SignUpOptions?) Signs a user up using an email address and password. public Task SignUpWithEmail(string email, string password, SignUpOptions? options = null) Parameters email string password string options SignUpOptions Optional Signup data. Returns Task SignUpWithPhone(string, string, SignUpOptions?) Signs up a new user using their phone number and a password.The phone number of the user. public Task SignUpWithPhone(string phone, string password, SignUpOptions? options = null) Parameters phone string The phone number of the user. password string The password of the user. options SignUpOptions Optional Signup data. Returns Task UnlinkIdentity(string, UserIdentity) Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked. public Task UnlinkIdentity(string token, UserIdentity userIdentity) Parameters token string User's token userIdentity UserIdentity Identity to be unlinked Returns Task UpdateUser(string, UserAttributes) Updates the User data public Task UpdateUser(string jwt, UserAttributes attributes) Parameters jwt string attributes UserAttributes Returns Task UpdateUserById(string, string, UserAttributes) Update user by Id public Task UpdateUserById(string jwt, string userId, UserAttributes userData) Parameters jwt string A valid JWT. Must be a full-access API key (e.g. service_role key). userId string userID userData UserAttributes User attributes e.g. email, password, etc. Returns Task VerifyEmailOTP(string, string, EmailOtpType) Send User supplied Email OTP to be verified public Task VerifyEmailOTP(string email, string token, Constants.EmailOtpType type) Parameters email string The user's email address token string token that user was sent to their mobile phone type Constants.EmailOtpType Type of verification, e.g. invite, recovery, etc. Returns Task VerifyMobileOTP(string, string, MobileOtpType) Send User supplied Mobile OTP to be verified public Task VerifyMobileOTP(string phone, string token, Constants.MobileOtpType type) Parameters phone string The user's phone number WITH international prefix token string token that user was sent to their mobile phone type Constants.MobileOtpType e.g. SMS or phone change Returns Task" + "keywords": "Class Api Namespace Supabase.Gotrue Assembly Supabase.Gotrue.dll The REST calls to the Gotrue API. public class Api : IGotrueApi, IGettableHeaders Inheritance object Api Implements IGotrueApi IGettableHeaders Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors Api(string, Dictionary?) Creates a new API client public Api(string url, Dictionary? headers = null) Parameters url string headers Dictionary Properties GetHeaders Function that can be set to return dynamic headers. Headers specified in the constructor will ALWAYS take precedence over headers returned by this function. public Func>? GetHeaders { get; set; } Property Value Func> Headers Headers to be sent with every request. These will be merged with any headers returned by GetHeaders. protected Dictionary Headers { get; set; } Property Value Dictionary Methods CreateUser(string, AdminUserAttributes?) Create a user public Task CreateUser(string jwt, AdminUserAttributes? attributes = null) Parameters jwt string A valid JWT. Must be a full-access API key (e.g. service_role key). attributes AdminUserAttributes Additional administrative details Returns Task DeleteUser(string, string) Delete a user public Task DeleteUser(string uid, string jwt) Parameters uid string The user uid you want to remove. jwt string A valid JWT. Must be a full-access API key (e.g. service_role key). Returns Task ExchangeCodeForSession(string, string) Log in an existing user via code from third-party provider. public Task ExchangeCodeForSession(string codeVerifier, string authCode) Parameters codeVerifier string Generated verifier (probably from GetUrlForProvider) authCode string The received Auth Code Callback Returns Task GenerateLink(string, GenerateLinkOptions) Generates email links and OTPs to be sent via a custom email provider. public Task GenerateLink(string jwt, GenerateLinkOptions options) Parameters jwt string options GenerateLinkOptions Returns Task GetUriForProvider(Provider, SignInOptions?) public ProviderAuthState GetUriForProvider(Constants.Provider provider, SignInOptions? options = null) Parameters provider Constants.Provider options SignInOptions Returns ProviderAuthState GetUser(string) Gets User Details public Task GetUser(string jwt) Parameters jwt string Returns Task GetUserById(string, string) Get User details by Id public Task GetUserById(string jwt, string userId) Parameters jwt string A valid JWT. Must be a full-access API key (e.g. service_role key). userId string userID Returns Task InviteUserByEmail(string, string, InviteUserByEmailOptions?) Sends an invite link to an email address. public Task InviteUserByEmail(string email, string jwt, InviteUserByEmailOptions? options = null) Parameters email string jwt string this token needs role 'supabase_admin' or 'service_role' options InviteUserByEmailOptions Returns Task LinkIdentity(string, Provider, SignInOptions) Links an oauth identity to an existing user. This method requires the PKCE flow. public Task LinkIdentity(string token, Constants.Provider provider, SignInOptions options) Parameters token string User's token provider Constants.Provider Provider to Link options SignInOptions Returns Task ListUsers(string, string?, string?, SortOrder, int?, int?) Lists users public Task?> ListUsers(string jwt, string? filter = null, string? sortBy = null, Constants.SortOrder sortOrder = SortOrder.Descending, int? page = null, int? perPage = null) Parameters jwt string A valid JWT. Must be a full-access API key (e.g. service_role key). filter string A string for example part of the email sortBy string Snake case string of the given key, currently only created_at is supported sortOrder Constants.SortOrder asc or desc, if null desc is used page int? page to show for pagination perPage int? items per page for pagination Returns Task> Reauthenticate(string) Sends a re-authentication request, used for password changes. See: https://github.com/supabase/gotrue#get-reauthenticate public Task Reauthenticate(string userJwt) Parameters userJwt string The user's auth token. Returns Task RefreshAccessToken(string, string) Generates a new Session given a user's access token and refresh token. public Task RefreshAccessToken(string accessToken, string refreshToken) Parameters accessToken string refreshToken string Returns Task ResetPasswordForEmail(ResetPasswordForEmailOptions) Sends a password reset request to an email address. This Method supports the PKCE Flow public Task ResetPasswordForEmail(ResetPasswordForEmailOptions options) Parameters options ResetPasswordForEmailOptions Returns Task ResetPasswordForEmail(string) Sends a reset request to an email address. public Task ResetPasswordForEmail(string email) Parameters email string Returns Task SendMagicLinkEmail(string, SignInOptions?) Sends a magic login link to an email address. public Task SendMagicLinkEmail(string email, SignInOptions? options = null) Parameters email string options SignInOptions Returns Task SendMobileOTP(string) Sends a mobile OTP via SMS. Will register the account if it doesn't already exist public Task SendMobileOTP(string phone) Parameters phone string phone The user's phone number WITH international prefix Returns Task Settings() Calls the GoTrue server to get the settings (for example, if email auto confirmation is turned on) public Task Settings() Returns Task mpose up -d SignInAnonymously(SignInAnonymouslyOptions?) Creates a new anonymous user. public Task SignInAnonymously(SignInAnonymouslyOptions? options = null) Parameters options SignInAnonymouslyOptions Returns Task A session where the is_anonymous claim in the access token JWT set to true SignInWithEmail(string, string) Logs in an existing user using their email address. public Task SignInWithEmail(string email, string password) Parameters email string password string Returns Task SignInWithIdToken(Provider, string, string?, string?, string?) Allows signing in with an ID token issued by certain supported providers. The [idToken] is verified for validity and a new session is established. This method of signing in only supports [Provider.Google] or [Provider.Apple]. public Task SignInWithIdToken(Constants.Provider provider, string idToken, string? accessToken = null, string? nonce = null, string? captchaToken = null) Parameters provider Constants.Provider A supported provider (Google, Apple, Azure, Facebook) idToken string OIDC ID token issued by the specified provider. The iss claim in the ID token must match the supplied provider. Some ID tokens contain an at_hash which require that you provide an access_token value to be accepted properly. If the token contains a nonce claim you must supply the nonce used to obtain the ID token. accessToken string If the ID token contains an at_hash claim, then the hash of this value is compared to the value in the ID token. nonce string If the ID token contains a nonce claim, then the hash of this value is compared to the value in the ID token. captchaToken string Verification token received when the user completes the captcha on the site. Returns Task SignInWithOtp(SignInWithPasswordlessEmailOptions) Log in a user using magiclink or a one-time password (OTP). If the {{ .ConfirmationURL }} variable is specified in the email template, a magiclink will be sent. If the {{ .Token }} variable is specified in the email template, an OTP will be sent. If you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins. Be aware that you may get back an error message that will not distinguish between the cases where the account does not exist or, that the account can only be accessed via social login. Do note that you will need to configure a Whatsapp sender on Twilio if you are using phone sign in with the 'whatsapp' channel. The whatsapp channel is not supported on other providers at this time. public Task SignInWithOtp(SignInWithPasswordlessEmailOptions options) Parameters options SignInWithPasswordlessEmailOptions Returns Task SignInWithOtp(SignInWithPasswordlessPhoneOptions) Log in a user using magiclink or a one-time password (OTP). If the {{ .ConfirmationURL }} variable is specified in the email template, a magiclink will be sent. If the {{ .Token }} variable is specified in the email template, an OTP will be sent. If you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins. Be aware that you may get back an error message that will not distinguish between the cases where the account does not exist or, that the account can only be accessed via social login. Do note that you will need to configure a Whatsapp sender on Twilio if you are using phone sign in with the 'whatsapp' channel. The whatsapp channel is not supported on other providers at this time. public Task SignInWithOtp(SignInWithPasswordlessPhoneOptions options) Parameters options SignInWithPasswordlessPhoneOptions Returns Task SignInWithPhone(string, string) Logs in an existing user using their phone number and password. public Task SignInWithPhone(string phone, string password) Parameters phone string The phone number of the user. password string The password of the user. Returns Task SignInWithSSO(Guid, SignInWithSSOOptions?) public Task SignInWithSSO(Guid providerId, SignInWithSSOOptions? options = null) Parameters providerId Guid options SignInWithSSOOptions Returns Task SignInWithSSO(string, SignInWithSSOOptions?) public Task SignInWithSSO(string domain, SignInWithSSOOptions? options = null) Parameters domain string options SignInWithSSOOptions Returns Task SignOut(string, SignOutScope) Removes a logged-in session. public Task SignOut(string jwt, Constants.SignOutScope scope = SignOutScope.Global) Parameters jwt string scope Constants.SignOutScope Returns Task SignUpWithEmail(string, string, SignUpOptions?) Signs a user up using an email address and password. public Task SignUpWithEmail(string email, string password, SignUpOptions? options = null) Parameters email string password string options SignUpOptions Optional Signup data. Returns Task SignUpWithPhone(string, string, SignUpOptions?) Signs up a new user using their phone number and a password.The phone number of the user. public Task SignUpWithPhone(string phone, string password, SignUpOptions? options = null) Parameters phone string The phone number of the user. password string The password of the user. options SignUpOptions Optional Signup data. Returns Task UnlinkIdentity(string, UserIdentity) Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked. public Task UnlinkIdentity(string token, UserIdentity userIdentity) Parameters token string User's token userIdentity UserIdentity Identity to be unlinked Returns Task UpdateUser(string, UserAttributes) Updates the User data public Task UpdateUser(string jwt, UserAttributes attributes) Parameters jwt string attributes UserAttributes Returns Task UpdateUserById(string, string, UserAttributes) Update user by Id public Task UpdateUserById(string jwt, string userId, UserAttributes userData) Parameters jwt string A valid JWT. Must be a full-access API key (e.g. service_role key). userId string userID userData UserAttributes User attributes e.g. email, password, etc. Returns Task VerifyEmailOTP(string, string, EmailOtpType) Send User supplied Email OTP to be verified public Task VerifyEmailOTP(string email, string token, Constants.EmailOtpType type) Parameters email string The user's email address token string token that user was sent to their mobile phone type Constants.EmailOtpType Type of verification, e.g. invite, recovery, etc. Returns Task VerifyMobileOTP(string, string, MobileOtpType) Send User supplied Mobile OTP to be verified public Task VerifyMobileOTP(string phone, string token, Constants.MobileOtpType type) Parameters phone string The user's phone number WITH international prefix token string token that user was sent to their mobile phone type Constants.MobileOtpType e.g. SMS or phone change Returns Task" }, "api/Supabase.Gotrue.Client.html": { "href": "api/Supabase.Gotrue.Client.html", "title": "Class Client | gotrue-csharp", - "keywords": "Class Client Namespace Supabase.Gotrue Assembly Supabase.Gotrue.dll public class Client : IGotrueClient, IGettableHeaders Inheritance object Client Implements IGotrueClient IGettableHeaders Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors Client(ClientOptions?) Initializes the GoTrue stateful client. You will likely want to at least specify a ClientOptions.Url Sessions are not automatically retrieved when this object is created. If you want to load the session from your persistence store, GotrueSessionPersistence . If you want to load/refresh the session, RetrieveSessionAsync . For a typical client application, you'll want to load the session from persistence and then refresh it. If your application is listening for session changes, you'll get two SignIn notifications if the persisted session is valid - one for the session loaded from disk, and a second on a successful session refresh. var client = new Supabase.Gotrue.Client(options); client.LoadSession(); await client.RetrieveSessionAsync(); public Client(ClientOptions? options = null) Parameters options ClientOptions Properties CurrentSession The current Session as managed by this client. Does not refresh tokens or have any other side effects. You probably don't want to directly make changes to this object - you'll want to use other methods on this class to make changes. public Session? CurrentSession { get; } Property Value Session CurrentUser The currently logged in User. This is a local cache of the current session User. To persist modifications to the User you'll want to use other methods. Update(UserAttributes)> public User? CurrentUser { get; } Property Value User GetHeaders Headers sent to the API on every request. public Func>? GetHeaders { get; set; } Property Value Func> Online Indicates if the client should be considered online or offline. In a server environment, this client would likely always be online. On a mobile client, you will want to pair this with a network implementation to turn this on and off as the device goes online and offline. public bool Online { get; set; } Property Value bool Options Returns the client options. public ClientOptions Options { get; } Property Value ClientOptions TokenRefresh Get the TokenRefresh object, if it exists public TokenRefresh? TokenRefresh { get; } Property Value TokenRefresh Methods AddDebugListener(Action) Add a listener to get errors that occur outside of a typical Exception flow. In particular, this is used to get errors and messages from the background thread that automatically manages refreshing the user's token. public void AddDebugListener(Action listener) Parameters listener Action Callback method for debug messages AddStateChangedListener(AuthEventHandler) Adds a listener to be notified when the user state changes (e.g. the user logs in, logs out, the token is refreshed, etc). Constants.AuthState public void AddStateChangedListener(IGotrueClient.AuthEventHandler authEventHandler) Parameters authEventHandler IGotrueClient.AuthEventHandler ClearStateChangedListeners() Clears all of the listeners from receiving event state changes. WARNING: The persistence handler and refresh token thread are installed as state change listeners. Clearing the listeners will also delete these handlers. public void ClearStateChangedListeners() Debug(string, Exception?) Posts messages and exceptions to the debug listener. This is particularly useful for sorting out issues with the refresh token background thread. public void Debug(string message, Exception? e = null) Parameters message string e Exception ExchangeCodeForSession(string, string) Logs in an existing user via a third-party provider. public Task ExchangeCodeForSession(string codeVerifier, string authCode) Parameters codeVerifier string authCode string Returns Task GetSessionFromUrl(Uri, bool) Parses a Session out of a Uri's Query parameters. public Task GetSessionFromUrl(Uri uri, bool storeSession = true) Parameters uri Uri storeSession bool Returns Task GetUser(string) Get User details by JWT. Can be used to validate a JWT. public Task GetUser(string jwt) Parameters jwt string A valid JWT. Must be a JWT that originates from a user. Returns Task LinkIdentity(Provider, SignInOptions) Links an oauth identity to an existing user. This method requires the PKCE flow. public Task LinkIdentity(Constants.Provider provider, SignInOptions options) Parameters provider Constants.Provider Provider to Link options SignInOptions Returns Task LoadSession() Loads the session from the persistence layer. public void LoadSession() NotifyAuthStateChange(AuthState) Notifies all listeners that the current user auth state has changed. This is mainly used internally to fire notifications - most client applications won't need this. public void NotifyAuthStateChange(Constants.AuthState stateChanged) Parameters stateChanged Constants.AuthState Reauthenticate() Used for re-authenticating a user in password changes. See: https://github.com/supabase/gotrue#get-reauthenticate public Task Reauthenticate() Returns Task Exceptions GotrueException RefreshSession() Refreshes the currently logged in User's Session. public Task RefreshSession() Returns Task RefreshToken() Refreshes a Token using the current session. public Task RefreshToken() Returns Task RefreshToken(string, string) public Task RefreshToken(string accessToken, string refreshToken) Parameters accessToken string refreshToken string Returns Task RemoveStateChangedListener(AuthEventHandler) Removes a specified listener from event state changes. public void RemoveStateChangedListener(IGotrueClient.AuthEventHandler authEventHandler) Parameters authEventHandler IGotrueClient.AuthEventHandler ResetPasswordForEmail(ResetPasswordForEmailOptions) Sends a password reset request to an email address. Supports the PKCE Flow (the verifier from ResetPasswordForEmailState will be combined with ExchangeCodeForSession(string, string) in response) public Task ResetPasswordForEmail(ResetPasswordForEmailOptions options) Parameters options ResetPasswordForEmailOptions Returns Task ResetPasswordForEmail(string) Sends a reset request to an email address. public Task ResetPasswordForEmail(string email) Parameters email string Returns Task RetrieveSessionAsync() Typically called as part of the startup process for the client. This will take the currently loaded session (e.g. from a persistence implementation) and if possible attempt to refresh it. If the loaded session is expired or invalid, it will log the user out. public Task RetrieveSessionAsync() Returns Task SendMagicLink(string, SignInOptions?) Sends a Magic email login link to the specified email. Most of the interesting configuration for this flow is done in the Supabase/GoTrue admin panel. public Task SendMagicLink(string email, SignInOptions? options = null) Parameters email string options SignInOptions Returns Task SetPersistence(IGotrueSessionPersistence) Sets the persistence implementation for the client (e.g. file system, local storage, etc). public void SetPersistence(IGotrueSessionPersistence persistence) Parameters persistence IGotrueSessionPersistence SetSession(string, string, bool) Sets a new session given a user's access token and their refresh token. Will destroy the current session (if existing) Raise a SignedOut event. Decode token 3a. If expired (or bool forceAccessTokenRefresh set), force an access token refresh. 3b. If not expired, set the CurrentSession and retrieve CurrentUser from the server using the accessToken. Raise a `SignedIn event if successful. public Task SetSession(string accessToken, string refreshToken, bool forceAccessTokenRefresh = false) Parameters accessToken string refreshToken string forceAccessTokenRefresh bool Returns Task Exceptions GotrueException Raised when token combination is invalid. Settings() Retrieves the settings from the server public Task Settings() Returns Task Shutdown() Let all of the listeners know that the stateless client is being shutdown. In particular, the background thread that is used to refresh the token is stopped. public void Shutdown() SignIn(Provider, SignInOptions?) Retrieves a ProviderAuthState to redirect to for signing in with a Constants.Provider. This will likely be paired with a PKCE flow (set in SignInOptions) - after redirecting the user to the flow, you should pair with ExchangeCodeForSession(string, string) public Task SignIn(Constants.Provider provider, SignInOptions? options = null) Parameters provider Constants.Provider options SignInOptions Returns Task SignIn(SignInType, string, string?, string?) Log in an existing user, or login via a third-party provider. public Task SignIn(Constants.SignInType type, string identifierOrToken, string? password = null, string? scopes = null) Parameters type Constants.SignInType Type of Credentials being passed identifierOrToken string An email, phone, or RefreshToken password string Password to account (optional if RefreshToken) scopes string A space-separated list of scopes granted to the OAuth application. Returns Task SignIn(string, SignInOptions?) Sends a magic link login email to the specified email. public Task SignIn(string email, SignInOptions? options = null) Parameters email string options SignInOptions Returns Task SignIn(string, string) Signs in a User. public Task SignIn(string email, string password) Parameters email string password string Returns Task SignInAnonymously(SignInAnonymouslyOptions?) Creates a new anonymous user. public Task SignInAnonymously(SignInAnonymouslyOptions? options = null) Parameters options SignInAnonymouslyOptions Returns Task A session where the is_anonymous claim in the access token JWT set to true SignInWithIdToken(Provider, string, string?, string?, string?) Allows signing in with an ID token issued by certain supported providers. The [idToken] is verified for validity and a new session is established. This method of signing in only supports [Provider.Google] or [Provider.Apple]. public Task SignInWithIdToken(Constants.Provider provider, string idToken, string? accessToken = null, string? nonce = null, string? captchaToken = null) Parameters provider Constants.Provider Provider name or OIDC iss value identifying which provider should be used to verify the provided token. Supported names: google, apple, azure, facebook idToken string OIDC ID token issued by the specified provider. The iss claim in the ID token must match the supplied provider. Some ID tokens contain an at_hash which require that you provide an access_token value to be accepted properly. If the token contains a nonce claim you must supply the nonce used to obtain the ID token. accessToken string If the ID token contains an at_hash claim, then the hash of this value is compared to the value in the ID token. nonce string If the ID token contains a nonce claim, then the hash of this value is compared to the value in the ID token. captchaToken string Verification token received when the user completes the captcha on the site. Returns Task Remarks Calling this method will eliminate the current session (if any). SignInWithOtp(SignInWithPasswordlessEmailOptions) Log in a user using magiclink or a one-time password (OTP). If the {{ .ConfirmationURL }} variable is specified in the email template, a magiclink will be sent. If the {{ .Token }} variable is specified in the email template, an OTP will be sent. If you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins. Be aware that you may get back an error message that will not distinguish between the cases where the account does not exist or, that the account can only be accessed via social login. Do note that you will need to configure a Whatsapp sender on Twilio if you are using phone sign in with the 'whatsapp' channel. The whatsapp channel is not supported on other providers at this time. public Task SignInWithOtp(SignInWithPasswordlessEmailOptions options) Parameters options SignInWithPasswordlessEmailOptions Returns Task Remarks Calling this method will wipe out the current session (if any) SignInWithOtp(SignInWithPasswordlessPhoneOptions) Log in a user using magiclink or a one-time password (OTP). If the {{ .ConfirmationURL }} variable is specified in the email template, a magiclink will be sent. If the {{ .Token }} variable is specified in the email template, an OTP will be sent. If you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins. Be aware that you may get back an error message that will not distinguish between the cases where the account does not exist or, that the account can only be accessed via social login. Do note that you will need to configure a Whatsapp sender on Twilio if you are using phone sign in with the 'whatsapp' channel. The whatsapp channel is not supported on other providers at this time. public Task SignInWithOtp(SignInWithPasswordlessPhoneOptions options) Parameters options SignInWithPasswordlessPhoneOptions Returns Task Remarks Calling this method will wipe out the current session (if any) SignInWithPassword(string, string) Log in an existing user with an email and password or phone and password. public Task SignInWithPassword(string email, string password) Parameters email string password string Returns Task SignInWithSSO(Guid, SignInWithSSOOptions?) Sign in using single sign on (SSO) as supported by supabase To use SSO you need to first set up the providers using the supabase CLI please follow the guide found here: https://supabase.com/docs/guides/auth/enterprise-sso/auth-sso-saml public Task SignInWithSSO(Guid providerId, SignInWithSSOOptions? options = null) Parameters providerId Guid The guid of the provider you wish to use, obtained from running supabase sso list from the CLI options SignInWithSSOOptions The redirect uri and captcha token, if any Returns Task The Uri returned from supabase auth that a user can use to sign in to their given SSO provider (okta, microsoft entra, gsuite ect...) SignInWithSSO(string, SignInWithSSOOptions?) Sign in using single sign on (SSO) as supported by supabase To use SSO you need to first set up the providers using the supabase CLI please follow the guide found here: https://supabase.com/docs/guides/auth/enterprise-sso/auth-sso-saml public Task SignInWithSSO(string domain, SignInWithSSOOptions? options = null) Parameters domain string Your organizations email domain to use for sign in, this domain needs to already be registered with supabase by running the CLI commands Example: google.com options SignInWithSSOOptions The redirect uri and captcha token, if any Returns Task The Uri returned from supabase auth that a user can use to sign in to their given SSO provider (okta, microsoft entra, gsuite ect...) SignOut() Signs out a user and invalidates the current token. public Task SignOut() Returns Task SignUp(SignUpType, string, string, SignUpOptions?) Signs up a user public Task SignUp(Constants.SignUpType type, string identifier, string password, SignUpOptions? options = null) Parameters type Constants.SignUpType identifier string password string options SignUpOptions Object containing redirectTo and optional user metadata (data) Returns Task Remarks Calling this method will log out the current user session (if any). By default, the user needs to verify their email address before logging in. To turn this off, disable confirm email in your project. Confirm email determines if users need to confirm their email address after signing up. - If Confirm email is enabled, a user is returned but session is null. - If Confirm email is disabled, both a user and a session are returned. When the user confirms their email address, they are redirected to the SITE_URL by default. You can modify your SITE_URL or add additional redirect URLs in your project. If signUp() is called for an existing confirmed user: - If Confirm email is enabled in your project, an obfuscated/fake user object is returned. - If Confirm email is disabled, the error message, User already registered is returned. To fetch the currently logged-in user, refer to User. SignUp(string, string, SignUpOptions?) Signs up a user by email address. public Task SignUp(string email, string password, SignUpOptions? options = null) Parameters email string password string options SignUpOptions Object containing redirectTo and optional user metadata (data) Returns Task Remarks By default, the user needs to verify their email address before logging in. To turn this off, disable Confirm email in your project. Confirm email determines if users need to confirm their email address after signing up. - If Confirm email is enabled, a user is returned but session is null. - If Confirm email is disabled, both a user and a session are returned. When the user confirms their email address, they are redirected to the SITE_URL by default. You can modify your SITE_URL or add additional redirect URLs in your project. If signUp() is called for an existing confirmed user: - If Confirm email is enabled in your project, an obfuscated/fake user object is returned. - If Confirm email is disabled, the error message, User already registered is returned. To fetch the currently logged-in user, refer to User . UnlinkIdentity(UserIdentity) Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked. public Task UnlinkIdentity(UserIdentity userIdentity) Parameters userIdentity UserIdentity Identity to be unlinked Returns Task Update(UserAttributes) Updates a User. public Task Update(UserAttributes attributes) Parameters attributes UserAttributes Returns Task VerifyOTP(string, string, EmailOtpType) Log in a user give a user supplied OTP received via email. public Task VerifyOTP(string email, string token, Constants.EmailOtpType type = EmailOtpType.MagicLink) Parameters email string token string type Constants.EmailOtpType Defaults to MagicLink Returns Task VerifyOTP(string, string, MobileOtpType) Log in a user given a User supplied OTP received via mobile. public Task VerifyOTP(string phone, string token, Constants.MobileOtpType type = MobileOtpType.SMS) Parameters phone string The user's phone number. token string Token sent to the user's phone. type Constants.MobileOtpType SMS or phone change Returns Task" + "keywords": "Class Client Namespace Supabase.Gotrue Assembly Supabase.Gotrue.dll public class Client : IGotrueClient, IGettableHeaders Inheritance object Client Implements IGotrueClient IGettableHeaders Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors Client(ClientOptions?) Initializes the GoTrue stateful client. You will likely want to at least specify a ClientOptions.Url Sessions are not automatically retrieved when this object is created. If you want to load the session from your persistence store, GotrueSessionPersistence . If you want to load/refresh the session, RetrieveSessionAsync . For a typical client application, you'll want to load the session from persistence and then refresh it. If your application is listening for session changes, you'll get two SignIn notifications if the persisted session is valid - one for the session loaded from disk, and a second on a successful session refresh. var client = new Supabase.Gotrue.Client(options); client.LoadSession(); await client.RetrieveSessionAsync(); public Client(ClientOptions? options = null) Parameters options ClientOptions Properties CurrentSession The current Session as managed by this client. Does not refresh tokens or have any other side effects. You probably don't want to directly make changes to this object - you'll want to use other methods on this class to make changes. public Session? CurrentSession { get; } Property Value Session CurrentUser The currently logged in User. This is a local cache of the current session User. To persist modifications to the User you'll want to use other methods. Update(UserAttributes)> public User? CurrentUser { get; } Property Value User GetHeaders Headers sent to the API on every request. public Func>? GetHeaders { get; set; } Property Value Func> Online Indicates if the client should be considered online or offline. In a server environment, this client would likely always be online. On a mobile client, you will want to pair this with a network implementation to turn this on and off as the device goes online and offline. public bool Online { get; set; } Property Value bool Options Returns the client options. public ClientOptions Options { get; } Property Value ClientOptions TokenRefresh Get the TokenRefresh object, if it exists public TokenRefresh? TokenRefresh { get; } Property Value TokenRefresh Methods AddDebugListener(Action) Add a listener to get errors that occur outside of a typical Exception flow. In particular, this is used to get errors and messages from the background thread that automatically manages refreshing the user's token. public void AddDebugListener(Action listener) Parameters listener Action Callback method for debug messages AddStateChangedListener(AuthEventHandler) Adds a listener to be notified when the user state changes (e.g. the user logs in, logs out, the token is refreshed, etc). Constants.AuthState public void AddStateChangedListener(IGotrueClient.AuthEventHandler authEventHandler) Parameters authEventHandler IGotrueClient.AuthEventHandler ClearStateChangedListeners() Clears all of the listeners from receiving event state changes. WARNING: The persistence handler and refresh token thread are installed as state change listeners. Clearing the listeners will also delete these handlers. public void ClearStateChangedListeners() Debug(string, Exception?) Posts messages and exceptions to the debug listener. This is particularly useful for sorting out issues with the refresh token background thread. public void Debug(string message, Exception? e = null) Parameters message string e Exception ExchangeCodeForSession(string, string) Logs in an existing user via a third-party provider. public Task ExchangeCodeForSession(string codeVerifier, string authCode) Parameters codeVerifier string authCode string Returns Task GetSessionFromUrl(Uri, bool) Parses a Session out of a Uri's Query parameters. public Task GetSessionFromUrl(Uri uri, bool storeSession = true) Parameters uri Uri storeSession bool Returns Task GetUser(string) Get User details by JWT. Can be used to validate a JWT. public Task GetUser(string jwt) Parameters jwt string A valid JWT. Must be a JWT that originates from a user. Returns Task LinkIdentity(Provider, SignInOptions) Links an oauth identity to an existing user. This method requires the PKCE flow. public Task LinkIdentity(Constants.Provider provider, SignInOptions options) Parameters provider Constants.Provider Provider to Link options SignInOptions Returns Task LoadSession() Loads the session from the persistence layer. public void LoadSession() NotifyAuthStateChange(AuthState) Notifies all listeners that the current user auth state has changed. This is mainly used internally to fire notifications - most client applications won't need this. public void NotifyAuthStateChange(Constants.AuthState stateChanged) Parameters stateChanged Constants.AuthState Reauthenticate() Used for re-authenticating a user in password changes. See: https://github.com/supabase/gotrue#get-reauthenticate public Task Reauthenticate() Returns Task Exceptions GotrueException RefreshSession() Refreshes the currently logged in User's Session. public Task RefreshSession() Returns Task RefreshToken() Refreshes a Token using the current session. public Task RefreshToken() Returns Task RefreshToken(string, string) public Task RefreshToken(string accessToken, string refreshToken) Parameters accessToken string refreshToken string Returns Task RemoveStateChangedListener(AuthEventHandler) Removes a specified listener from event state changes. public void RemoveStateChangedListener(IGotrueClient.AuthEventHandler authEventHandler) Parameters authEventHandler IGotrueClient.AuthEventHandler ResetPasswordForEmail(ResetPasswordForEmailOptions) Sends a password reset request to an email address. Supports the PKCE Flow (the verifier from ResetPasswordForEmailState will be combined with ExchangeCodeForSession(string, string) in response) public Task ResetPasswordForEmail(ResetPasswordForEmailOptions options) Parameters options ResetPasswordForEmailOptions Returns Task ResetPasswordForEmail(string) Sends a reset request to an email address. public Task ResetPasswordForEmail(string email) Parameters email string Returns Task RetrieveSessionAsync() Typically called as part of the startup process for the client. This will take the currently loaded session (e.g. from a persistence implementation) and if possible attempt to refresh it. If the loaded session is expired or invalid, it will log the user out. public Task RetrieveSessionAsync() Returns Task SendMagicLink(string, SignInOptions?) Sends a Magic email login link to the specified email. Most of the interesting configuration for this flow is done in the Supabase/GoTrue admin panel. public Task SendMagicLink(string email, SignInOptions? options = null) Parameters email string options SignInOptions Returns Task SetPersistence(IGotrueSessionPersistence) Sets the persistence implementation for the client (e.g. file system, local storage, etc). public void SetPersistence(IGotrueSessionPersistence persistence) Parameters persistence IGotrueSessionPersistence SetSession(string, string, bool) Sets a new session given a user's access token and their refresh token. Will destroy the current session (if existing) Raise a SignedOut event. Decode token 3a. If expired (or bool forceAccessTokenRefresh set), force an access token refresh. 3b. If not expired, set the CurrentSession and retrieve CurrentUser from the server using the accessToken. Raise a `SignedIn event if successful. public Task SetSession(string accessToken, string refreshToken, bool forceAccessTokenRefresh = false) Parameters accessToken string refreshToken string forceAccessTokenRefresh bool Returns Task Exceptions GotrueException Raised when token combination is invalid. Settings() Retrieves the settings from the server public Task Settings() Returns Task Shutdown() Let all of the listeners know that the stateless client is being shutdown. In particular, the background thread that is used to refresh the token is stopped. public void Shutdown() SignIn(Provider, SignInOptions?) Retrieves a ProviderAuthState to redirect to for signing in with a Constants.Provider. This will likely be paired with a PKCE flow (set in SignInOptions) - after redirecting the user to the flow, you should pair with ExchangeCodeForSession(string, string) public Task SignIn(Constants.Provider provider, SignInOptions? options = null) Parameters provider Constants.Provider options SignInOptions Returns Task SignIn(SignInType, string, string?, string?) Log in an existing user, or login via a third-party provider. public Task SignIn(Constants.SignInType type, string identifierOrToken, string? password = null, string? scopes = null) Parameters type Constants.SignInType Type of Credentials being passed identifierOrToken string An email, phone, or RefreshToken password string Password to account (optional if RefreshToken) scopes string A space-separated list of scopes granted to the OAuth application. Returns Task SignIn(string, SignInOptions?) Sends a magic link login email to the specified email. public Task SignIn(string email, SignInOptions? options = null) Parameters email string options SignInOptions Returns Task SignIn(string, string) Signs in a User. public Task SignIn(string email, string password) Parameters email string password string Returns Task SignInAnonymously(SignInAnonymouslyOptions?) Creates a new anonymous user. public Task SignInAnonymously(SignInAnonymouslyOptions? options = null) Parameters options SignInAnonymouslyOptions Returns Task A session where the is_anonymous claim in the access token JWT set to true SignInWithIdToken(Provider, string, string?, string?, string?) Allows signing in with an ID token issued by certain supported providers. The [idToken] is verified for validity and a new session is established. This method of signing in only supports [Provider.Google] or [Provider.Apple]. public Task SignInWithIdToken(Constants.Provider provider, string idToken, string? accessToken = null, string? nonce = null, string? captchaToken = null) Parameters provider Constants.Provider Provider name or OIDC iss value identifying which provider should be used to verify the provided token. Supported names: google, apple, azure, facebook idToken string OIDC ID token issued by the specified provider. The iss claim in the ID token must match the supplied provider. Some ID tokens contain an at_hash which require that you provide an access_token value to be accepted properly. If the token contains a nonce claim you must supply the nonce used to obtain the ID token. accessToken string If the ID token contains an at_hash claim, then the hash of this value is compared to the value in the ID token. nonce string If the ID token contains a nonce claim, then the hash of this value is compared to the value in the ID token. captchaToken string Verification token received when the user completes the captcha on the site. Returns Task Remarks Calling this method will eliminate the current session (if any). SignInWithOtp(SignInWithPasswordlessEmailOptions) Log in a user using magiclink or a one-time password (OTP). If the {{ .ConfirmationURL }} variable is specified in the email template, a magiclink will be sent. If the {{ .Token }} variable is specified in the email template, an OTP will be sent. If you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins. Be aware that you may get back an error message that will not distinguish between the cases where the account does not exist or, that the account can only be accessed via social login. Do note that you will need to configure a Whatsapp sender on Twilio if you are using phone sign in with the 'whatsapp' channel. The whatsapp channel is not supported on other providers at this time. public Task SignInWithOtp(SignInWithPasswordlessEmailOptions options) Parameters options SignInWithPasswordlessEmailOptions Returns Task Remarks Calling this method will wipe out the current session (if any) SignInWithOtp(SignInWithPasswordlessPhoneOptions) Log in a user using magiclink or a one-time password (OTP). If the {{ .ConfirmationURL }} variable is specified in the email template, a magiclink will be sent. If the {{ .Token }} variable is specified in the email template, an OTP will be sent. If you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins. Be aware that you may get back an error message that will not distinguish between the cases where the account does not exist or, that the account can only be accessed via social login. Do note that you will need to configure a Whatsapp sender on Twilio if you are using phone sign in with the 'whatsapp' channel. The whatsapp channel is not supported on other providers at this time. public Task SignInWithOtp(SignInWithPasswordlessPhoneOptions options) Parameters options SignInWithPasswordlessPhoneOptions Returns Task Remarks Calling this method will wipe out the current session (if any) SignInWithPassword(string, string) Log in an existing user with an email and password or phone and password. public Task SignInWithPassword(string email, string password) Parameters email string password string Returns Task SignInWithSSO(Guid, SignInWithSSOOptions?) Sign in using single sign on (SSO) as supported by supabase To use SSO you need to first set up the providers using the supabase CLI please follow the guide found here: https://supabase.com/docs/guides/auth/enterprise-sso/auth-sso-saml public Task SignInWithSSO(Guid providerId, SignInWithSSOOptions? options = null) Parameters providerId Guid The guid of the provider you wish to use, obtained from running supabase sso list from the CLI options SignInWithSSOOptions The redirect uri and captcha token, if any Returns Task The Uri returned from supabase auth that a user can use to sign in to their given SSO provider (okta, microsoft entra, gsuite ect...) SignInWithSSO(string, SignInWithSSOOptions?) Sign in using single sign on (SSO) as supported by supabase To use SSO you need to first set up the providers using the supabase CLI please follow the guide found here: https://supabase.com/docs/guides/auth/enterprise-sso/auth-sso-saml public Task SignInWithSSO(string domain, SignInWithSSOOptions? options = null) Parameters domain string Your organizations email domain to use for sign in, this domain needs to already be registered with supabase by running the CLI commands Example: google.com options SignInWithSSOOptions The redirect uri and captcha token, if any Returns Task The Uri returned from supabase auth that a user can use to sign in to their given SSO provider (okta, microsoft entra, gsuite ect...) SignOut(SignOutScope) Signs out and invalidates all sessions for a user. public Task SignOut(Constants.SignOutScope scope = SignOutScope.Global) Parameters scope Constants.SignOutScope Determines which sessions should be invalidated. By default, it will invalidate all session for a user Returns Task SignUp(SignUpType, string, string, SignUpOptions?) Signs up a user public Task SignUp(Constants.SignUpType type, string identifier, string password, SignUpOptions? options = null) Parameters type Constants.SignUpType identifier string password string options SignUpOptions Object containing redirectTo and optional user metadata (data) Returns Task Remarks Calling this method will log out the current user session (if any). By default, the user needs to verify their email address before logging in. To turn this off, disable confirm email in your project. Confirm email determines if users need to confirm their email address after signing up. - If Confirm email is enabled, a user is returned but session is null. - If Confirm email is disabled, both a user and a session are returned. When the user confirms their email address, they are redirected to the SITE_URL by default. You can modify your SITE_URL or add additional redirect URLs in your project. If signUp() is called for an existing confirmed user: - If Confirm email is enabled in your project, an obfuscated/fake user object is returned. - If Confirm email is disabled, the error message, User already registered is returned. To fetch the currently logged-in user, refer to User. SignUp(string, string, SignUpOptions?) Signs up a user by email address. public Task SignUp(string email, string password, SignUpOptions? options = null) Parameters email string password string options SignUpOptions Object containing redirectTo and optional user metadata (data) Returns Task Remarks By default, the user needs to verify their email address before logging in. To turn this off, disable Confirm email in your project. Confirm email determines if users need to confirm their email address after signing up. - If Confirm email is enabled, a user is returned but session is null. - If Confirm email is disabled, both a user and a session are returned. When the user confirms their email address, they are redirected to the SITE_URL by default. You can modify your SITE_URL or add additional redirect URLs in your project. If signUp() is called for an existing confirmed user: - If Confirm email is enabled in your project, an obfuscated/fake user object is returned. - If Confirm email is disabled, the error message, User already registered is returned. To fetch the currently logged-in user, refer to User . UnlinkIdentity(UserIdentity) Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked. public Task UnlinkIdentity(UserIdentity userIdentity) Parameters userIdentity UserIdentity Identity to be unlinked Returns Task Update(UserAttributes) Updates a User. public Task Update(UserAttributes attributes) Parameters attributes UserAttributes Returns Task VerifyOTP(string, string, EmailOtpType) Log in a user give a user supplied OTP received via email. public Task VerifyOTP(string email, string token, Constants.EmailOtpType type = EmailOtpType.MagicLink) Parameters email string token string type Constants.EmailOtpType Defaults to MagicLink Returns Task VerifyOTP(string, string, MobileOtpType) Log in a user given a User supplied OTP received via mobile. public Task VerifyOTP(string phone, string token, Constants.MobileOtpType type = MobileOtpType.SMS) Parameters phone string The user's phone number. token string Token sent to the user's phone. type Constants.MobileOtpType SMS or phone change Returns Task" }, "api/Supabase.Gotrue.ClientOptions.html": { "href": "api/Supabase.Gotrue.ClientOptions.html", @@ -54,6 +54,11 @@ "title": "Enum Constants.SignInType | gotrue-csharp", "keywords": "Enum Constants.SignInType Namespace Supabase.Gotrue Assembly Supabase.Gotrue.dll Specifies the functionality expected from the SignIn method public enum Constants.SignInType Fields Email = 0 Phone = 1 RefreshToken = 2" }, + "api/Supabase.Gotrue.Constants.SignOutScope.html": { + "href": "api/Supabase.Gotrue.Constants.SignOutScope.html", + "title": "Enum Constants.SignOutScope | gotrue-csharp", + "keywords": "Enum Constants.SignOutScope Namespace Supabase.Gotrue Assembly Supabase.Gotrue.dll public enum Constants.SignOutScope Fields [MapTo(\"global\", null)] Global = 0 [MapTo(\"local\", null)] Local = 1 [MapTo(\"others\", null)] Others = 2" + }, "api/Supabase.Gotrue.Constants.SignUpType.html": { "href": "api/Supabase.Gotrue.Constants.SignUpType.html", "title": "Enum Constants.SignUpType | gotrue-csharp", @@ -132,7 +137,7 @@ "api/Supabase.Gotrue.Interfaces.IGotrueApi-2.html": { "href": "api/Supabase.Gotrue.Interfaces.IGotrueApi-2.html", "title": "Interface IGotrueApi | gotrue-csharp", - "keywords": "Interface IGotrueApi Namespace Supabase.Gotrue.Interfaces Assembly Supabase.Gotrue.dll public interface IGotrueApi : IGettableHeaders where TUser : User where TSession : Session Type Parameters TUser TSession Inherited Members IGettableHeaders.GetHeaders Methods CreateUser(string, AdminUserAttributes?) Task CreateUser(string jwt, AdminUserAttributes? attributes = null) Parameters jwt string attributes AdminUserAttributes Returns Task DeleteUser(string, string) Task DeleteUser(string uid, string jwt) Parameters uid string jwt string Returns Task ExchangeCodeForSession(string, string) Task ExchangeCodeForSession(string codeVerifier, string authCode) Parameters codeVerifier string authCode string Returns Task GenerateLink(string, GenerateLinkOptions) Task GenerateLink(string jwt, GenerateLinkOptions options) Parameters jwt string options GenerateLinkOptions Returns Task GetUriForProvider(Provider, SignInOptions?) ProviderAuthState GetUriForProvider(Constants.Provider provider, SignInOptions? options = null) Parameters provider Constants.Provider options SignInOptions Returns ProviderAuthState GetUser(string) Task GetUser(string jwt) Parameters jwt string Returns Task GetUserById(string, string) Task GetUserById(string jwt, string userId) Parameters jwt string userId string Returns Task InviteUserByEmail(string, string, InviteUserByEmailOptions?) Task InviteUserByEmail(string email, string jwt, InviteUserByEmailOptions? options = null) Parameters email string jwt string options InviteUserByEmailOptions Returns Task LinkIdentity(string, Provider, SignInOptions) Links an oauth identity to an existing user. This method requires the PKCE flow. Task LinkIdentity(string token, Constants.Provider provider, SignInOptions options) Parameters token string User's token provider Constants.Provider Provider to Link options SignInOptions Returns Task ListUsers(string, string?, string?, SortOrder, int?, int?) Task?> ListUsers(string jwt, string? filter = null, string? sortBy = null, Constants.SortOrder sortOrder = SortOrder.Descending, int? page = null, int? perPage = null) Parameters jwt string filter string sortBy string sortOrder Constants.SortOrder page int? perPage int? Returns Task> Reauthenticate(string) Task Reauthenticate(string userJwt) Parameters userJwt string Returns Task RefreshAccessToken(string, string) Task RefreshAccessToken(string accessToken, string refreshToken) Parameters accessToken string refreshToken string Returns Task ResetPasswordForEmail(ResetPasswordForEmailOptions) Task ResetPasswordForEmail(ResetPasswordForEmailOptions options) Parameters options ResetPasswordForEmailOptions Returns Task ResetPasswordForEmail(string) Task ResetPasswordForEmail(string email) Parameters email string Returns Task SendMagicLinkEmail(string, SignInOptions?) Task SendMagicLinkEmail(string email, SignInOptions? options = null) Parameters email string options SignInOptions Returns Task SendMobileOTP(string) Task SendMobileOTP(string phone) Parameters phone string Returns Task Settings() Task Settings() Returns Task SignInAnonymously(SignInAnonymouslyOptions?) Task SignInAnonymously(SignInAnonymouslyOptions? options = null) Parameters options SignInAnonymouslyOptions Returns Task SignInWithEmail(string, string) Task SignInWithEmail(string email, string password) Parameters email string password string Returns Task SignInWithIdToken(Provider, string, string?, string?, string?) Task SignInWithIdToken(Constants.Provider provider, string idToken, string? accessToken = null, string? nonce = null, string? captchaToken = null) Parameters provider Constants.Provider idToken string accessToken string nonce string captchaToken string Returns Task SignInWithOtp(SignInWithPasswordlessEmailOptions) Task SignInWithOtp(SignInWithPasswordlessEmailOptions options) Parameters options SignInWithPasswordlessEmailOptions Returns Task SignInWithOtp(SignInWithPasswordlessPhoneOptions) Task SignInWithOtp(SignInWithPasswordlessPhoneOptions options) Parameters options SignInWithPasswordlessPhoneOptions Returns Task SignInWithPhone(string, string) Task SignInWithPhone(string phone, string password) Parameters phone string password string Returns Task SignInWithSSO(Guid, SignInWithSSOOptions?) Task SignInWithSSO(Guid providerId, SignInWithSSOOptions? options = null) Parameters providerId Guid options SignInWithSSOOptions Returns Task SignInWithSSO(string, SignInWithSSOOptions?) Task SignInWithSSO(string domain, SignInWithSSOOptions? options = null) Parameters domain string options SignInWithSSOOptions Returns Task SignOut(string) Task SignOut(string jwt) Parameters jwt string Returns Task SignUpWithEmail(string, string, SignUpOptions?) Task SignUpWithEmail(string email, string password, SignUpOptions? options = null) Parameters email string password string options SignUpOptions Returns Task SignUpWithPhone(string, string, SignUpOptions?) Task SignUpWithPhone(string phone, string password, SignUpOptions? options = null) Parameters phone string password string options SignUpOptions Returns Task UnlinkIdentity(string, UserIdentity) Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked. Task UnlinkIdentity(string token, UserIdentity userIdentity) Parameters token string User's token userIdentity UserIdentity Identity to be unlinked Returns Task UpdateUser(string, UserAttributes) Task UpdateUser(string jwt, UserAttributes attributes) Parameters jwt string attributes UserAttributes Returns Task UpdateUserById(string, string, UserAttributes) Task UpdateUserById(string jwt, string userId, UserAttributes userData) Parameters jwt string userId string userData UserAttributes Returns Task VerifyEmailOTP(string, string, EmailOtpType) Task VerifyEmailOTP(string email, string token, Constants.EmailOtpType type) Parameters email string token string type Constants.EmailOtpType Returns Task VerifyMobileOTP(string, string, MobileOtpType) Task VerifyMobileOTP(string phone, string token, Constants.MobileOtpType type) Parameters phone string token string type Constants.MobileOtpType Returns Task" + "keywords": "Interface IGotrueApi Namespace Supabase.Gotrue.Interfaces Assembly Supabase.Gotrue.dll public interface IGotrueApi : IGettableHeaders where TUser : User where TSession : Session Type Parameters TUser TSession Inherited Members IGettableHeaders.GetHeaders Methods CreateUser(string, AdminUserAttributes?) Task CreateUser(string jwt, AdminUserAttributes? attributes = null) Parameters jwt string attributes AdminUserAttributes Returns Task DeleteUser(string, string) Task DeleteUser(string uid, string jwt) Parameters uid string jwt string Returns Task ExchangeCodeForSession(string, string) Task ExchangeCodeForSession(string codeVerifier, string authCode) Parameters codeVerifier string authCode string Returns Task GenerateLink(string, GenerateLinkOptions) Task GenerateLink(string jwt, GenerateLinkOptions options) Parameters jwt string options GenerateLinkOptions Returns Task GetUriForProvider(Provider, SignInOptions?) ProviderAuthState GetUriForProvider(Constants.Provider provider, SignInOptions? options = null) Parameters provider Constants.Provider options SignInOptions Returns ProviderAuthState GetUser(string) Task GetUser(string jwt) Parameters jwt string Returns Task GetUserById(string, string) Task GetUserById(string jwt, string userId) Parameters jwt string userId string Returns Task InviteUserByEmail(string, string, InviteUserByEmailOptions?) Task InviteUserByEmail(string email, string jwt, InviteUserByEmailOptions? options = null) Parameters email string jwt string options InviteUserByEmailOptions Returns Task LinkIdentity(string, Provider, SignInOptions) Links an oauth identity to an existing user. This method requires the PKCE flow. Task LinkIdentity(string token, Constants.Provider provider, SignInOptions options) Parameters token string User's token provider Constants.Provider Provider to Link options SignInOptions Returns Task ListUsers(string, string?, string?, SortOrder, int?, int?) Task?> ListUsers(string jwt, string? filter = null, string? sortBy = null, Constants.SortOrder sortOrder = SortOrder.Descending, int? page = null, int? perPage = null) Parameters jwt string filter string sortBy string sortOrder Constants.SortOrder page int? perPage int? Returns Task> Reauthenticate(string) Task Reauthenticate(string userJwt) Parameters userJwt string Returns Task RefreshAccessToken(string, string) Task RefreshAccessToken(string accessToken, string refreshToken) Parameters accessToken string refreshToken string Returns Task ResetPasswordForEmail(ResetPasswordForEmailOptions) Task ResetPasswordForEmail(ResetPasswordForEmailOptions options) Parameters options ResetPasswordForEmailOptions Returns Task ResetPasswordForEmail(string) Task ResetPasswordForEmail(string email) Parameters email string Returns Task SendMagicLinkEmail(string, SignInOptions?) Task SendMagicLinkEmail(string email, SignInOptions? options = null) Parameters email string options SignInOptions Returns Task SendMobileOTP(string) Task SendMobileOTP(string phone) Parameters phone string Returns Task Settings() Task Settings() Returns Task SignInAnonymously(SignInAnonymouslyOptions?) Task SignInAnonymously(SignInAnonymouslyOptions? options = null) Parameters options SignInAnonymouslyOptions Returns Task SignInWithEmail(string, string) Task SignInWithEmail(string email, string password) Parameters email string password string Returns Task SignInWithIdToken(Provider, string, string?, string?, string?) Task SignInWithIdToken(Constants.Provider provider, string idToken, string? accessToken = null, string? nonce = null, string? captchaToken = null) Parameters provider Constants.Provider idToken string accessToken string nonce string captchaToken string Returns Task SignInWithOtp(SignInWithPasswordlessEmailOptions) Task SignInWithOtp(SignInWithPasswordlessEmailOptions options) Parameters options SignInWithPasswordlessEmailOptions Returns Task SignInWithOtp(SignInWithPasswordlessPhoneOptions) Task SignInWithOtp(SignInWithPasswordlessPhoneOptions options) Parameters options SignInWithPasswordlessPhoneOptions Returns Task SignInWithPhone(string, string) Task SignInWithPhone(string phone, string password) Parameters phone string password string Returns Task SignInWithSSO(Guid, SignInWithSSOOptions?) Task SignInWithSSO(Guid providerId, SignInWithSSOOptions? options = null) Parameters providerId Guid options SignInWithSSOOptions Returns Task SignInWithSSO(string, SignInWithSSOOptions?) Task SignInWithSSO(string domain, SignInWithSSOOptions? options = null) Parameters domain string options SignInWithSSOOptions Returns Task SignOut(string, SignOutScope) Task SignOut(string jwt, Constants.SignOutScope scope = SignOutScope.Global) Parameters jwt string scope Constants.SignOutScope Returns Task SignUpWithEmail(string, string, SignUpOptions?) Task SignUpWithEmail(string email, string password, SignUpOptions? options = null) Parameters email string password string options SignUpOptions Returns Task SignUpWithPhone(string, string, SignUpOptions?) Task SignUpWithPhone(string phone, string password, SignUpOptions? options = null) Parameters phone string password string options SignUpOptions Returns Task UnlinkIdentity(string, UserIdentity) Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked. Task UnlinkIdentity(string token, UserIdentity userIdentity) Parameters token string User's token userIdentity UserIdentity Identity to be unlinked Returns Task UpdateUser(string, UserAttributes) Task UpdateUser(string jwt, UserAttributes attributes) Parameters jwt string attributes UserAttributes Returns Task UpdateUserById(string, string, UserAttributes) Task UpdateUserById(string jwt, string userId, UserAttributes userData) Parameters jwt string userId string userData UserAttributes Returns Task VerifyEmailOTP(string, string, EmailOtpType) Task VerifyEmailOTP(string email, string token, Constants.EmailOtpType type) Parameters email string token string type Constants.EmailOtpType Returns Task VerifyMobileOTP(string, string, MobileOtpType) Task VerifyMobileOTP(string phone, string token, Constants.MobileOtpType type) Parameters phone string token string type Constants.MobileOtpType Returns Task" }, "api/Supabase.Gotrue.Interfaces.IGotrueClient-2.AuthEventHandler.html": { "href": "api/Supabase.Gotrue.Interfaces.IGotrueClient-2.AuthEventHandler.html", @@ -142,7 +147,7 @@ "api/Supabase.Gotrue.Interfaces.IGotrueClient-2.html": { "href": "api/Supabase.Gotrue.Interfaces.IGotrueClient-2.html", "title": "Interface IGotrueClient | gotrue-csharp", - "keywords": "Interface IGotrueClient Namespace Supabase.Gotrue.Interfaces Assembly Supabase.Gotrue.dll GoTrue stateful Client. This class is best used as a long-lived singleton object in your application. You can attach listeners to be notified of changes to the user log in state, a persistence system for sessions across application launches, and more. It includes a (optional, on by default) background thread that runs to refresh the user's session token. Check out the test suite for examples of use. public interface IGotrueClient : IGettableHeaders where TUser : User where TSession : Session Type Parameters TUser TSession Inherited Members IGettableHeaders.GetHeaders Examples var client = new Supabase.Gotrue.Client(options); var user = await client.SignIn(\"user@email.com\", \"fancyPassword\"); Properties CurrentSession The current Session as managed by this client. Does not refresh tokens or have any other side effects. You probably don't want to directly make changes to this object - you'll want to use other methods on this class to make changes. TSession? CurrentSession { get; } Property Value TSession CurrentUser The currently logged in User. This is a local cache of the current session User. To persist modifications to the User you'll want to use other methods. Update(UserAttributes)> TUser? CurrentUser { get; } Property Value TUser Online Indicates if the client should be considered online or offline. In a server environment, this client would likely always be online. On a mobile client, you will want to pair this with a network implementation to turn this on and off as the device goes online and offline. bool Online { get; set; } Property Value bool Options Returns the client options. ClientOptions Options { get; } Property Value ClientOptions Methods AddDebugListener(Action) Add a listener to get errors that occur outside of a typical Exception flow. In particular, this is used to get errors and messages from the background thread that automatically manages refreshing the user's token. void AddDebugListener(Action listener) Parameters listener Action Callback method for debug messages AddStateChangedListener(AuthEventHandler) Adds a listener to be notified when the user state changes (e.g. the user logs in, logs out, the token is refreshed, etc). Constants.AuthState void AddStateChangedListener(IGotrueClient.AuthEventHandler authEventHandler) Parameters authEventHandler IGotrueClient.AuthEventHandler ClearStateChangedListeners() Clears all of the listeners from receiving event state changes. WARNING: The persistence handler and refresh token thread are installed as state change listeners. Clearing the listeners will also delete these handlers. void ClearStateChangedListeners() Debug(string, Exception?) Posts messages and exceptions to the debug listener. This is particularly useful for sorting out issues with the refresh token background thread. void Debug(string message, Exception? e = null) Parameters message string e Exception ExchangeCodeForSession(string, string) Logs in an existing user via a third-party provider. Task ExchangeCodeForSession(string codeVerifier, string authCode) Parameters codeVerifier string authCode string Returns Task GetSessionFromUrl(Uri, bool) Converts a URL to a session. For client apps, this probably requires setting up URL handlers. Task GetSessionFromUrl(Uri uri, bool storeSession = true) Parameters uri Uri storeSession bool Returns Task GetUser(string) Get User details by JWT. Can be used to validate a JWT. Task GetUser(string jwt) Parameters jwt string A valid JWT. Must be a JWT that originates from a user. Returns Task LinkIdentity(Provider, SignInOptions) Links an oauth identity to an existing user. This method requires the PKCE flow. Task LinkIdentity(Constants.Provider provider, SignInOptions options) Parameters provider Constants.Provider Provider to Link options SignInOptions Returns Task LoadSession() Loads the session from the persistence layer. void LoadSession() NotifyAuthStateChange(AuthState) Notifies all listeners that the current user auth state has changed. This is mainly used internally to fire notifications - most client applications won't need this. void NotifyAuthStateChange(Constants.AuthState stateChanged) Parameters stateChanged Constants.AuthState Reauthenticate() Used for re-authenticating a user in password changes. See: https://github.com/supabase/gotrue#get-reauthenticate Task Reauthenticate() Returns Task Exceptions GotrueException RefreshSession() Refreshes the currently logged in User's Session. Task RefreshSession() Returns Task RefreshToken() Refreshes a Token using the current session. Task RefreshToken() Returns Task RemoveStateChangedListener(AuthEventHandler) Removes a specified listener from event state changes. void RemoveStateChangedListener(IGotrueClient.AuthEventHandler authEventHandler) Parameters authEventHandler IGotrueClient.AuthEventHandler ResetPasswordForEmail(ResetPasswordForEmailOptions) Sends a password reset request to an email address. Supports the PKCE Flow (the verifier from ResetPasswordForEmailState will be combined with ExchangeCodeForSession(string, string) in response) Task ResetPasswordForEmail(ResetPasswordForEmailOptions options) Parameters options ResetPasswordForEmailOptions Returns Task ResetPasswordForEmail(string) Sends a reset request to an email address. Task ResetPasswordForEmail(string email) Parameters email string Returns Task RetrieveSessionAsync() Typically called as part of the startup process for the client. This will take the currently loaded session (e.g. from a persistence implementation) and if possible attempt to refresh it. If the loaded session is expired or invalid, it will log the user out. Task RetrieveSessionAsync() Returns Task SendMagicLink(string, SignInOptions?) Sends a Magic email login link to the specified email. Most of the interesting configuration for this flow is done in the Supabase/GoTrue admin panel. Task SendMagicLink(string email, SignInOptions? options = null) Parameters email string options SignInOptions Returns Task SetPersistence(IGotrueSessionPersistence) Sets the persistence implementation for the client (e.g. file system, local storage, etc). void SetPersistence(IGotrueSessionPersistence persistence) Parameters persistence IGotrueSessionPersistence SetSession(string, string, bool) Sets a new session given a user's access token and their refresh token. Will destroy the current session (if existing) Raise a SignedOut event. Decode token 3a. If expired (or bool forceAccessTokenRefresh set), force an access token refresh. 3b. If not expired, set the CurrentSession and retrieve CurrentUser from the server using the accessToken. Raise a `SignedIn event if successful. Task SetSession(string accessToken, string refreshToken, bool forceAccessTokenRefresh = false) Parameters accessToken string refreshToken string forceAccessTokenRefresh bool Returns Task Exceptions GotrueException Raised when token combination is invalid. Settings() Retrieves the settings from the server Task Settings() Returns Task Shutdown() Let all of the listeners know that the stateless client is being shutdown. In particular, the background thread that is used to refresh the token is stopped. void Shutdown() SignIn(Provider, SignInOptions?) Retrieves a ProviderAuthState to redirect to for signing in with a Constants.Provider. This will likely be paired with a PKCE flow (set in SignInOptions) - after redirecting the user to the flow, you should pair with ExchangeCodeForSession(string, string) Task SignIn(Constants.Provider provider, SignInOptions? options = null) Parameters provider Constants.Provider options SignInOptions Returns Task SignIn(SignInType, string, string?, string?) Log in an existing user, or login via a third-party provider. Task SignIn(Constants.SignInType type, string identifierOrToken, string? password = null, string? scopes = null) Parameters type Constants.SignInType Type of Credentials being passed identifierOrToken string An email, phone, or RefreshToken password string Password to account (optional if RefreshToken) scopes string A space-separated list of scopes granted to the OAuth application. Returns Task SignIn(string, SignInOptions?) Sends a magic link login email to the specified email. Task SignIn(string email, SignInOptions? options = null) Parameters email string options SignInOptions Returns Task SignIn(string, string) Signs in a User. Task SignIn(string email, string password) Parameters email string password string Returns Task SignInAnonymously(SignInAnonymouslyOptions?) Creates a new anonymous user. Task SignInAnonymously(SignInAnonymouslyOptions? options = null) Parameters options SignInAnonymouslyOptions Returns Task A session where the is_anonymous claim in the access token JWT set to true SignInWithIdToken(Provider, string, string?, string?, string?) Allows signing in with an ID token issued by certain supported providers. The [idToken] is verified for validity and a new session is established. This method of signing in only supports [Provider.Google] or [Provider.Apple]. Task SignInWithIdToken(Constants.Provider provider, string idToken, string? accessToken = null, string? nonce = null, string? captchaToken = null) Parameters provider Constants.Provider Provider name or OIDC iss value identifying which provider should be used to verify the provided token. Supported names: google, apple, azure, facebook idToken string OIDC ID token issued by the specified provider. The iss claim in the ID token must match the supplied provider. Some ID tokens contain an at_hash which require that you provide an access_token value to be accepted properly. If the token contains a nonce claim you must supply the nonce used to obtain the ID token. accessToken string If the ID token contains an at_hash claim, then the hash of this value is compared to the value in the ID token. nonce string If the ID token contains a nonce claim, then the hash of this value is compared to the value in the ID token. captchaToken string Verification token received when the user completes the captcha on the site. Returns Task Remarks Calling this method will eliminate the current session (if any). SignInWithOtp(SignInWithPasswordlessEmailOptions) Log in a user using magiclink or a one-time password (OTP). If the {{ .ConfirmationURL }} variable is specified in the email template, a magiclink will be sent. If the {{ .Token }} variable is specified in the email template, an OTP will be sent. If you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins. Be aware that you may get back an error message that will not distinguish between the cases where the account does not exist or, that the account can only be accessed via social login. Do note that you will need to configure a Whatsapp sender on Twilio if you are using phone sign in with the 'whatsapp' channel. The whatsapp channel is not supported on other providers at this time. Task SignInWithOtp(SignInWithPasswordlessEmailOptions options) Parameters options SignInWithPasswordlessEmailOptions Returns Task Remarks Calling this method will wipe out the current session (if any) SignInWithOtp(SignInWithPasswordlessPhoneOptions) Log in a user using magiclink or a one-time password (OTP). If the {{ .ConfirmationURL }} variable is specified in the email template, a magiclink will be sent. If the {{ .Token }} variable is specified in the email template, an OTP will be sent. If you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins. Be aware that you may get back an error message that will not distinguish between the cases where the account does not exist or, that the account can only be accessed via social login. Do note that you will need to configure a Whatsapp sender on Twilio if you are using phone sign in with the 'whatsapp' channel. The whatsapp channel is not supported on other providers at this time. Task SignInWithOtp(SignInWithPasswordlessPhoneOptions options) Parameters options SignInWithPasswordlessPhoneOptions Returns Task Remarks Calling this method will wipe out the current session (if any) SignInWithPassword(string, string) Log in an existing user with an email and password or phone and password. Task SignInWithPassword(string email, string password) Parameters email string password string Returns Task SignInWithSSO(Guid, SignInWithSSOOptions?) Sign in using single sign on (SSO) as supported by supabase To use SSO you need to first set up the providers using the supabase CLI please follow the guide found here: https://supabase.com/docs/guides/auth/enterprise-sso/auth-sso-saml Task SignInWithSSO(Guid providerId, SignInWithSSOOptions? options = null) Parameters providerId Guid The guid of the provider you wish to use, obtained from running supabase sso list from the CLI options SignInWithSSOOptions The redirect uri and captcha token, if any Returns Task The Uri returned from supabase auth that a user can use to sign in to their given SSO provider (okta, microsoft entra, gsuite ect...) SignInWithSSO(string, SignInWithSSOOptions?) Sign in using single sign on (SSO) as supported by supabase To use SSO you need to first set up the providers using the supabase CLI please follow the guide found here: https://supabase.com/docs/guides/auth/enterprise-sso/auth-sso-saml Task SignInWithSSO(string domain, SignInWithSSOOptions? options = null) Parameters domain string Your organizations email domain to use for sign in, this domain needs to already be registered with supabase by running the CLI commands Example: google.com options SignInWithSSOOptions The redirect uri and captcha token, if any Returns Task The Uri returned from supabase auth that a user can use to sign in to their given SSO provider (okta, microsoft entra, gsuite ect...) SignOut() Signs out a user and invalidates the current token. Task SignOut() Returns Task SignUp(SignUpType, string, string, SignUpOptions?) Signs up a user Task SignUp(Constants.SignUpType type, string identifier, string password, SignUpOptions? options = null) Parameters type Constants.SignUpType identifier string password string options SignUpOptions Object containing redirectTo and optional user metadata (data) Returns Task Remarks Calling this method will log out the current user session (if any). By default, the user needs to verify their email address before logging in. To turn this off, disable confirm email in your project. Confirm email determines if users need to confirm their email address after signing up. - If Confirm email is enabled, a user is returned but session is null. - If Confirm email is disabled, both a user and a session are returned. When the user confirms their email address, they are redirected to the SITE_URL by default. You can modify your SITE_URL or add additional redirect URLs in your project. If signUp() is called for an existing confirmed user: - If Confirm email is enabled in your project, an obfuscated/fake user object is returned. - If Confirm email is disabled, the error message, User already registered is returned. To fetch the currently logged-in user, refer to User. SignUp(string, string, SignUpOptions?) Signs up a user by email address. Task SignUp(string email, string password, SignUpOptions? options = null) Parameters email string password string options SignUpOptions Object containing redirectTo and optional user metadata (data) Returns Task Remarks By default, the user needs to verify their email address before logging in. To turn this off, disable Confirm email in your project. Confirm email determines if users need to confirm their email address after signing up. - If Confirm email is enabled, a user is returned but session is null. - If Confirm email is disabled, both a user and a session are returned. When the user confirms their email address, they are redirected to the SITE_URL by default. You can modify your SITE_URL or add additional redirect URLs in your project. If signUp() is called for an existing confirmed user: - If Confirm email is enabled in your project, an obfuscated/fake user object is returned. - If Confirm email is disabled, the error message, User already registered is returned. To fetch the currently logged-in user, refer to User . UnlinkIdentity(UserIdentity) Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked. Task UnlinkIdentity(UserIdentity userIdentity) Parameters userIdentity UserIdentity Identity to be unlinked Returns Task Update(UserAttributes) Updates a User. Task Update(UserAttributes attributes) Parameters attributes UserAttributes Returns Task VerifyOTP(string, string, EmailOtpType) Log in a user give a user supplied OTP received via email. Task VerifyOTP(string email, string token, Constants.EmailOtpType type = EmailOtpType.MagicLink) Parameters email string token string type Constants.EmailOtpType Defaults to MagicLink Returns Task VerifyOTP(string, string, MobileOtpType) Log in a user given a User supplied OTP received via mobile. Task VerifyOTP(string phone, string token, Constants.MobileOtpType type = MobileOtpType.SMS) Parameters phone string The user's phone number. token string Token sent to the user's phone. type Constants.MobileOtpType SMS or phone change Returns Task" + "keywords": "Interface IGotrueClient Namespace Supabase.Gotrue.Interfaces Assembly Supabase.Gotrue.dll GoTrue stateful Client. This class is best used as a long-lived singleton object in your application. You can attach listeners to be notified of changes to the user log in state, a persistence system for sessions across application launches, and more. It includes a (optional, on by default) background thread that runs to refresh the user's session token. Check out the test suite for examples of use. public interface IGotrueClient : IGettableHeaders where TUser : User where TSession : Session Type Parameters TUser TSession Inherited Members IGettableHeaders.GetHeaders Examples var client = new Supabase.Gotrue.Client(options); var user = await client.SignIn(\"user@email.com\", \"fancyPassword\"); Properties CurrentSession The current Session as managed by this client. Does not refresh tokens or have any other side effects. You probably don't want to directly make changes to this object - you'll want to use other methods on this class to make changes. TSession? CurrentSession { get; } Property Value TSession CurrentUser The currently logged in User. This is a local cache of the current session User. To persist modifications to the User you'll want to use other methods. Update(UserAttributes)> TUser? CurrentUser { get; } Property Value TUser Online Indicates if the client should be considered online or offline. In a server environment, this client would likely always be online. On a mobile client, you will want to pair this with a network implementation to turn this on and off as the device goes online and offline. bool Online { get; set; } Property Value bool Options Returns the client options. ClientOptions Options { get; } Property Value ClientOptions Methods AddDebugListener(Action) Add a listener to get errors that occur outside of a typical Exception flow. In particular, this is used to get errors and messages from the background thread that automatically manages refreshing the user's token. void AddDebugListener(Action listener) Parameters listener Action Callback method for debug messages AddStateChangedListener(AuthEventHandler) Adds a listener to be notified when the user state changes (e.g. the user logs in, logs out, the token is refreshed, etc). Constants.AuthState void AddStateChangedListener(IGotrueClient.AuthEventHandler authEventHandler) Parameters authEventHandler IGotrueClient.AuthEventHandler ClearStateChangedListeners() Clears all of the listeners from receiving event state changes. WARNING: The persistence handler and refresh token thread are installed as state change listeners. Clearing the listeners will also delete these handlers. void ClearStateChangedListeners() Debug(string, Exception?) Posts messages and exceptions to the debug listener. This is particularly useful for sorting out issues with the refresh token background thread. void Debug(string message, Exception? e = null) Parameters message string e Exception ExchangeCodeForSession(string, string) Logs in an existing user via a third-party provider. Task ExchangeCodeForSession(string codeVerifier, string authCode) Parameters codeVerifier string authCode string Returns Task GetSessionFromUrl(Uri, bool) Converts a URL to a session. For client apps, this probably requires setting up URL handlers. Task GetSessionFromUrl(Uri uri, bool storeSession = true) Parameters uri Uri storeSession bool Returns Task GetUser(string) Get User details by JWT. Can be used to validate a JWT. Task GetUser(string jwt) Parameters jwt string A valid JWT. Must be a JWT that originates from a user. Returns Task LinkIdentity(Provider, SignInOptions) Links an oauth identity to an existing user. This method requires the PKCE flow. Task LinkIdentity(Constants.Provider provider, SignInOptions options) Parameters provider Constants.Provider Provider to Link options SignInOptions Returns Task LoadSession() Loads the session from the persistence layer. void LoadSession() NotifyAuthStateChange(AuthState) Notifies all listeners that the current user auth state has changed. This is mainly used internally to fire notifications - most client applications won't need this. void NotifyAuthStateChange(Constants.AuthState stateChanged) Parameters stateChanged Constants.AuthState Reauthenticate() Used for re-authenticating a user in password changes. See: https://github.com/supabase/gotrue#get-reauthenticate Task Reauthenticate() Returns Task Exceptions GotrueException RefreshSession() Refreshes the currently logged in User's Session. Task RefreshSession() Returns Task RefreshToken() Refreshes a Token using the current session. Task RefreshToken() Returns Task RemoveStateChangedListener(AuthEventHandler) Removes a specified listener from event state changes. void RemoveStateChangedListener(IGotrueClient.AuthEventHandler authEventHandler) Parameters authEventHandler IGotrueClient.AuthEventHandler ResetPasswordForEmail(ResetPasswordForEmailOptions) Sends a password reset request to an email address. Supports the PKCE Flow (the verifier from ResetPasswordForEmailState will be combined with ExchangeCodeForSession(string, string) in response) Task ResetPasswordForEmail(ResetPasswordForEmailOptions options) Parameters options ResetPasswordForEmailOptions Returns Task ResetPasswordForEmail(string) Sends a reset request to an email address. Task ResetPasswordForEmail(string email) Parameters email string Returns Task RetrieveSessionAsync() Typically called as part of the startup process for the client. This will take the currently loaded session (e.g. from a persistence implementation) and if possible attempt to refresh it. If the loaded session is expired or invalid, it will log the user out. Task RetrieveSessionAsync() Returns Task SendMagicLink(string, SignInOptions?) Sends a Magic email login link to the specified email. Most of the interesting configuration for this flow is done in the Supabase/GoTrue admin panel. Task SendMagicLink(string email, SignInOptions? options = null) Parameters email string options SignInOptions Returns Task SetPersistence(IGotrueSessionPersistence) Sets the persistence implementation for the client (e.g. file system, local storage, etc). void SetPersistence(IGotrueSessionPersistence persistence) Parameters persistence IGotrueSessionPersistence SetSession(string, string, bool) Sets a new session given a user's access token and their refresh token. Will destroy the current session (if existing) Raise a SignedOut event. Decode token 3a. If expired (or bool forceAccessTokenRefresh set), force an access token refresh. 3b. If not expired, set the CurrentSession and retrieve CurrentUser from the server using the accessToken. Raise a `SignedIn event if successful. Task SetSession(string accessToken, string refreshToken, bool forceAccessTokenRefresh = false) Parameters accessToken string refreshToken string forceAccessTokenRefresh bool Returns Task Exceptions GotrueException Raised when token combination is invalid. Settings() Retrieves the settings from the server Task Settings() Returns Task Shutdown() Let all of the listeners know that the stateless client is being shutdown. In particular, the background thread that is used to refresh the token is stopped. void Shutdown() SignIn(Provider, SignInOptions?) Retrieves a ProviderAuthState to redirect to for signing in with a Constants.Provider. This will likely be paired with a PKCE flow (set in SignInOptions) - after redirecting the user to the flow, you should pair with ExchangeCodeForSession(string, string) Task SignIn(Constants.Provider provider, SignInOptions? options = null) Parameters provider Constants.Provider options SignInOptions Returns Task SignIn(SignInType, string, string?, string?) Log in an existing user, or login via a third-party provider. Task SignIn(Constants.SignInType type, string identifierOrToken, string? password = null, string? scopes = null) Parameters type Constants.SignInType Type of Credentials being passed identifierOrToken string An email, phone, or RefreshToken password string Password to account (optional if RefreshToken) scopes string A space-separated list of scopes granted to the OAuth application. Returns Task SignIn(string, SignInOptions?) Sends a magic link login email to the specified email. Task SignIn(string email, SignInOptions? options = null) Parameters email string options SignInOptions Returns Task SignIn(string, string) Signs in a User. Task SignIn(string email, string password) Parameters email string password string Returns Task SignInAnonymously(SignInAnonymouslyOptions?) Creates a new anonymous user. Task SignInAnonymously(SignInAnonymouslyOptions? options = null) Parameters options SignInAnonymouslyOptions Returns Task A session where the is_anonymous claim in the access token JWT set to true SignInWithIdToken(Provider, string, string?, string?, string?) Allows signing in with an ID token issued by certain supported providers. The [idToken] is verified for validity and a new session is established. This method of signing in only supports [Provider.Google] or [Provider.Apple]. Task SignInWithIdToken(Constants.Provider provider, string idToken, string? accessToken = null, string? nonce = null, string? captchaToken = null) Parameters provider Constants.Provider Provider name or OIDC iss value identifying which provider should be used to verify the provided token. Supported names: google, apple, azure, facebook idToken string OIDC ID token issued by the specified provider. The iss claim in the ID token must match the supplied provider. Some ID tokens contain an at_hash which require that you provide an access_token value to be accepted properly. If the token contains a nonce claim you must supply the nonce used to obtain the ID token. accessToken string If the ID token contains an at_hash claim, then the hash of this value is compared to the value in the ID token. nonce string If the ID token contains a nonce claim, then the hash of this value is compared to the value in the ID token. captchaToken string Verification token received when the user completes the captcha on the site. Returns Task Remarks Calling this method will eliminate the current session (if any). SignInWithOtp(SignInWithPasswordlessEmailOptions) Log in a user using magiclink or a one-time password (OTP). If the {{ .ConfirmationURL }} variable is specified in the email template, a magiclink will be sent. If the {{ .Token }} variable is specified in the email template, an OTP will be sent. If you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins. Be aware that you may get back an error message that will not distinguish between the cases where the account does not exist or, that the account can only be accessed via social login. Do note that you will need to configure a Whatsapp sender on Twilio if you are using phone sign in with the 'whatsapp' channel. The whatsapp channel is not supported on other providers at this time. Task SignInWithOtp(SignInWithPasswordlessEmailOptions options) Parameters options SignInWithPasswordlessEmailOptions Returns Task Remarks Calling this method will wipe out the current session (if any) SignInWithOtp(SignInWithPasswordlessPhoneOptions) Log in a user using magiclink or a one-time password (OTP). If the {{ .ConfirmationURL }} variable is specified in the email template, a magiclink will be sent. If the {{ .Token }} variable is specified in the email template, an OTP will be sent. If you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins. Be aware that you may get back an error message that will not distinguish between the cases where the account does not exist or, that the account can only be accessed via social login. Do note that you will need to configure a Whatsapp sender on Twilio if you are using phone sign in with the 'whatsapp' channel. The whatsapp channel is not supported on other providers at this time. Task SignInWithOtp(SignInWithPasswordlessPhoneOptions options) Parameters options SignInWithPasswordlessPhoneOptions Returns Task Remarks Calling this method will wipe out the current session (if any) SignInWithPassword(string, string) Log in an existing user with an email and password or phone and password. Task SignInWithPassword(string email, string password) Parameters email string password string Returns Task SignInWithSSO(Guid, SignInWithSSOOptions?) Sign in using single sign on (SSO) as supported by supabase To use SSO you need to first set up the providers using the supabase CLI please follow the guide found here: https://supabase.com/docs/guides/auth/enterprise-sso/auth-sso-saml Task SignInWithSSO(Guid providerId, SignInWithSSOOptions? options = null) Parameters providerId Guid The guid of the provider you wish to use, obtained from running supabase sso list from the CLI options SignInWithSSOOptions The redirect uri and captcha token, if any Returns Task The Uri returned from supabase auth that a user can use to sign in to their given SSO provider (okta, microsoft entra, gsuite ect...) SignInWithSSO(string, SignInWithSSOOptions?) Sign in using single sign on (SSO) as supported by supabase To use SSO you need to first set up the providers using the supabase CLI please follow the guide found here: https://supabase.com/docs/guides/auth/enterprise-sso/auth-sso-saml Task SignInWithSSO(string domain, SignInWithSSOOptions? options = null) Parameters domain string Your organizations email domain to use for sign in, this domain needs to already be registered with supabase by running the CLI commands Example: google.com options SignInWithSSOOptions The redirect uri and captcha token, if any Returns Task The Uri returned from supabase auth that a user can use to sign in to their given SSO provider (okta, microsoft entra, gsuite ect...) SignOut(SignOutScope) Signs out and invalidates all sessions for a user. Task SignOut(Constants.SignOutScope scope = SignOutScope.Global) Parameters scope Constants.SignOutScope Determines which sessions should be invalidated. By default, it will invalidate all session for a user Returns Task SignUp(SignUpType, string, string, SignUpOptions?) Signs up a user Task SignUp(Constants.SignUpType type, string identifier, string password, SignUpOptions? options = null) Parameters type Constants.SignUpType identifier string password string options SignUpOptions Object containing redirectTo and optional user metadata (data) Returns Task Remarks Calling this method will log out the current user session (if any). By default, the user needs to verify their email address before logging in. To turn this off, disable confirm email in your project. Confirm email determines if users need to confirm their email address after signing up. - If Confirm email is enabled, a user is returned but session is null. - If Confirm email is disabled, both a user and a session are returned. When the user confirms their email address, they are redirected to the SITE_URL by default. You can modify your SITE_URL or add additional redirect URLs in your project. If signUp() is called for an existing confirmed user: - If Confirm email is enabled in your project, an obfuscated/fake user object is returned. - If Confirm email is disabled, the error message, User already registered is returned. To fetch the currently logged-in user, refer to User. SignUp(string, string, SignUpOptions?) Signs up a user by email address. Task SignUp(string email, string password, SignUpOptions? options = null) Parameters email string password string options SignUpOptions Object containing redirectTo and optional user metadata (data) Returns Task Remarks By default, the user needs to verify their email address before logging in. To turn this off, disable Confirm email in your project. Confirm email determines if users need to confirm their email address after signing up. - If Confirm email is enabled, a user is returned but session is null. - If Confirm email is disabled, both a user and a session are returned. When the user confirms their email address, they are redirected to the SITE_URL by default. You can modify your SITE_URL or add additional redirect URLs in your project. If signUp() is called for an existing confirmed user: - If Confirm email is enabled in your project, an obfuscated/fake user object is returned. - If Confirm email is disabled, the error message, User already registered is returned. To fetch the currently logged-in user, refer to User . UnlinkIdentity(UserIdentity) Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked. Task UnlinkIdentity(UserIdentity userIdentity) Parameters userIdentity UserIdentity Identity to be unlinked Returns Task Update(UserAttributes) Updates a User. Task Update(UserAttributes attributes) Parameters attributes UserAttributes Returns Task VerifyOTP(string, string, EmailOtpType) Log in a user give a user supplied OTP received via email. Task VerifyOTP(string email, string token, Constants.EmailOtpType type = EmailOtpType.MagicLink) Parameters email string token string type Constants.EmailOtpType Defaults to MagicLink Returns Task VerifyOTP(string, string, MobileOtpType) Log in a user given a User supplied OTP received via mobile. Task VerifyOTP(string phone, string token, Constants.MobileOtpType type = MobileOtpType.SMS) Parameters phone string The user's phone number. token string Token sent to the user's phone. type Constants.MobileOtpType SMS or phone change Returns Task" }, "api/Supabase.Gotrue.Interfaces.IGotruePersistenceListener-1.html": { "href": "api/Supabase.Gotrue.Interfaces.IGotruePersistenceListener-1.html", @@ -317,7 +322,7 @@ "api/Supabase.Gotrue.html": { "href": "api/Supabase.Gotrue.html", "title": "Namespace Supabase.Gotrue | gotrue-csharp", - "keywords": "Namespace Supabase.Gotrue Classes AdminClient Admin client for interacting with the Gotrue API. Intended for use on servers or other secure environments. This client does NOT manage user sessions or track any other state. AdminUserAttributes Ref: https://supabase.github.io/gotrue-js/interfaces/AdminUserAttributes.html Api The REST calls to the Gotrue API. Client ClientOptions Class representation options available to the Client. Constants Constants used throughout the Gotrue Client DebugNotification Manages the debug listeners for the Gotrue Client. You'll want to install a debug listener to get debug information back - especially for errors from the background RefreshToken thread. GenerateLinkEmailChangeCurrentOptions Shortcut options for EmailChangeCurrent GenerateLinkEmailChangeNewOptions Shortcut options for EmailChangeNew GenerateLinkOptions Options for Generating an Email Link GenerateLinkSignupOptions Shortcut options for SignUp Helpers Utility methods to assist with flow. Includes nonce generation and verification. InviteUserByEmailOptions A utility class that represents options for sending a User an Invitation NetworkStatus A Network status system to pair with the OnlineClient. https://learn.microsoft.com/en-us/dotnet/fundamentals/networking/network-info PasswordlessSignInState A utility class that represents a successful response from a request to send a user Passwordless Sign In. PersistenceListener Manages the persistence of the Gotrue Session. You'll want to install a persistence listener to persist user sessions between app restarts. ProviderAuthState Represents an OAuth Provider's URI and Parameters. For use with Provider Auth, PKCE Auth, and ID Token auth. ResetPasswordForEmailOptions A utility class that represents a successful response from a request to send a user's password reset using the PKCE flow. ResetPasswordForEmailState A utility class that represents a successful response from a request to send a user's password reset using the PKCE flow. SSOResponse Single sign on (SSO) response data deserialized from the API {supabaseAuthUrl}/sso Session Represents a Gotrue Session Settings Settings data retrieved from the GoTrue server. SignInAnonymouslyOptions Options for handling signing in anonymously SignInOptions Options used for signing in a user. SignInWithPasswordlessEmailOptions Options used for signing in a user with passwordless Options SignInWithPasswordlessOptions Options used for signing in a user with passwordless Options SignInWithPasswordlessPhoneOptions Options used for signing in a user with passwordless Options SignInWithSSOOptions Options used for signing in a user using single sign on (SSO). SignUpOptions Options used for signing up a user. StatelessClient StatelessClient.StatelessClientOptions Class representation options available to the Client. TokenRefresh Manages the auto-refresh of the Gotrue Session. User Represents a Gotrue User Ref: https://supabase.github.io/gotrue-js/interfaces/User.html UserAttributes Ref: https://supabase.github.io/gotrue-js/interfaces/UserAttributes.html UserIdentity Ref: https://supabase.github.io/gotrue-js/interfaces/UserIdentity.html UserList VerifyOTPParams Ref: https://supabase.github.io/gotrue-js/interfaces/VerifyEmailOTPParams.html Enums Constants.AuthState States that the Auth Client will raise events for. Constants.EmailOtpType Constants.MobileOtpType Constants.OAuthFlowType Represents an OAuth Flow type Constants.Provider Providers available to Supabase Ref: https://supabase.github.io/gotrue-js/modules.html#Provider Constants.SignInType Specifies the functionality expected from the SignIn method Constants.SignUpType Specifies the functionality expected from the SignUp method Constants.SortOrder GenerateLinkOptions.LinkType Mapping of link types that can be generated. SignInWithPasswordlessPhoneOptions.MessagingChannel Represents a messaging channel to use for sending the OTP. Delegates NetworkStatus.NetworkListener A delegate for listening to network changes." + "keywords": "Namespace Supabase.Gotrue Classes AdminClient Admin client for interacting with the Gotrue API. Intended for use on servers or other secure environments. This client does NOT manage user sessions or track any other state. AdminUserAttributes Ref: https://supabase.github.io/gotrue-js/interfaces/AdminUserAttributes.html Api The REST calls to the Gotrue API. Client ClientOptions Class representation options available to the Client. Constants Constants used throughout the Gotrue Client DebugNotification Manages the debug listeners for the Gotrue Client. You'll want to install a debug listener to get debug information back - especially for errors from the background RefreshToken thread. GenerateLinkEmailChangeCurrentOptions Shortcut options for EmailChangeCurrent GenerateLinkEmailChangeNewOptions Shortcut options for EmailChangeNew GenerateLinkOptions Options for Generating an Email Link GenerateLinkSignupOptions Shortcut options for SignUp Helpers Utility methods to assist with flow. Includes nonce generation and verification. InviteUserByEmailOptions A utility class that represents options for sending a User an Invitation NetworkStatus A Network status system to pair with the OnlineClient. https://learn.microsoft.com/en-us/dotnet/fundamentals/networking/network-info PasswordlessSignInState A utility class that represents a successful response from a request to send a user Passwordless Sign In. PersistenceListener Manages the persistence of the Gotrue Session. You'll want to install a persistence listener to persist user sessions between app restarts. ProviderAuthState Represents an OAuth Provider's URI and Parameters. For use with Provider Auth, PKCE Auth, and ID Token auth. ResetPasswordForEmailOptions A utility class that represents a successful response from a request to send a user's password reset using the PKCE flow. ResetPasswordForEmailState A utility class that represents a successful response from a request to send a user's password reset using the PKCE flow. SSOResponse Single sign on (SSO) response data deserialized from the API {supabaseAuthUrl}/sso Session Represents a Gotrue Session Settings Settings data retrieved from the GoTrue server. SignInAnonymouslyOptions Options for handling signing in anonymously SignInOptions Options used for signing in a user. SignInWithPasswordlessEmailOptions Options used for signing in a user with passwordless Options SignInWithPasswordlessOptions Options used for signing in a user with passwordless Options SignInWithPasswordlessPhoneOptions Options used for signing in a user with passwordless Options SignInWithSSOOptions Options used for signing in a user using single sign on (SSO). SignUpOptions Options used for signing up a user. StatelessClient StatelessClient.StatelessClientOptions Class representation options available to the Client. TokenRefresh Manages the auto-refresh of the Gotrue Session. User Represents a Gotrue User Ref: https://supabase.github.io/gotrue-js/interfaces/User.html UserAttributes Ref: https://supabase.github.io/gotrue-js/interfaces/UserAttributes.html UserIdentity Ref: https://supabase.github.io/gotrue-js/interfaces/UserIdentity.html UserList VerifyOTPParams Ref: https://supabase.github.io/gotrue-js/interfaces/VerifyEmailOTPParams.html Enums Constants.AuthState States that the Auth Client will raise events for. Constants.EmailOtpType Constants.MobileOtpType Constants.OAuthFlowType Represents an OAuth Flow type Constants.Provider Providers available to Supabase Ref: https://supabase.github.io/gotrue-js/modules.html#Provider Constants.SignInType Specifies the functionality expected from the SignIn method Constants.SignOutScope Constants.SignUpType Specifies the functionality expected from the SignUp method Constants.SortOrder GenerateLinkOptions.LinkType Mapping of link types that can be generated. SignInWithPasswordlessPhoneOptions.MessagingChannel Represents a messaging channel to use for sending the OTP. Delegates NetworkStatus.NetworkListener A delegate for listening to network changes." }, "index.html": { "href": "index.html", diff --git a/manifest.json b/manifest.json index 84f943e..1b0dac9 100644 --- a/manifest.json +++ b/manifest.json @@ -120,6 +120,16 @@ }, "version": "" }, + { + "type": "ManagedReference", + "source_relative_path": "api/Supabase.Gotrue.Constants.SignOutScope.yml", + "output": { + ".html": { + "relative_path": "api/Supabase.Gotrue.Constants.SignOutScope.html" + } + }, + "version": "" + }, { "type": "ManagedReference", "source_relative_path": "api/Supabase.Gotrue.Constants.SignUpType.yml", diff --git a/xrefmap.yml b/xrefmap.yml index d7218db..0727b0c 100644 --- a/xrefmap.yml +++ b/xrefmap.yml @@ -678,15 +678,15 @@ references: isSpec: "True" fullName: Supabase.Gotrue.Api.SignInWithSSO nameWithType: Api.SignInWithSSO -- uid: Supabase.Gotrue.Api.SignOut(System.String) - name: SignOut(string) - href: api/Supabase.Gotrue.Api.html#Supabase_Gotrue_Api_SignOut_System_String_ - commentId: M:Supabase.Gotrue.Api.SignOut(System.String) - name.vb: SignOut(String) - fullName: Supabase.Gotrue.Api.SignOut(string) - fullName.vb: Supabase.Gotrue.Api.SignOut(String) - nameWithType: Api.SignOut(string) - nameWithType.vb: Api.SignOut(String) +- uid: Supabase.Gotrue.Api.SignOut(System.String,Supabase.Gotrue.Constants.SignOutScope) + name: SignOut(string, SignOutScope) + href: api/Supabase.Gotrue.Api.html#Supabase_Gotrue_Api_SignOut_System_String_Supabase_Gotrue_Constants_SignOutScope_ + commentId: M:Supabase.Gotrue.Api.SignOut(System.String,Supabase.Gotrue.Constants.SignOutScope) + name.vb: SignOut(String, SignOutScope) + fullName: Supabase.Gotrue.Api.SignOut(string, Supabase.Gotrue.Constants.SignOutScope) + fullName.vb: Supabase.Gotrue.Api.SignOut(String, Supabase.Gotrue.Constants.SignOutScope) + nameWithType: Api.SignOut(string, Constants.SignOutScope) + nameWithType.vb: Api.SignOut(String, Constants.SignOutScope) - uid: Supabase.Gotrue.Api.SignOut* name: SignOut href: api/Supabase.Gotrue.Api.html#Supabase_Gotrue_Api_SignOut_ @@ -1350,12 +1350,12 @@ references: isSpec: "True" fullName: Supabase.Gotrue.Client.SignInWithSSO nameWithType: Client.SignInWithSSO -- uid: Supabase.Gotrue.Client.SignOut - name: SignOut() - href: api/Supabase.Gotrue.Client.html#Supabase_Gotrue_Client_SignOut - commentId: M:Supabase.Gotrue.Client.SignOut - fullName: Supabase.Gotrue.Client.SignOut() - nameWithType: Client.SignOut() +- uid: Supabase.Gotrue.Client.SignOut(Supabase.Gotrue.Constants.SignOutScope) + name: SignOut(SignOutScope) + href: api/Supabase.Gotrue.Client.html#Supabase_Gotrue_Client_SignOut_Supabase_Gotrue_Constants_SignOutScope_ + commentId: M:Supabase.Gotrue.Client.SignOut(Supabase.Gotrue.Constants.SignOutScope) + fullName: Supabase.Gotrue.Client.SignOut(Supabase.Gotrue.Constants.SignOutScope) + nameWithType: Client.SignOut(Constants.SignOutScope) - uid: Supabase.Gotrue.Client.SignOut* name: SignOut href: api/Supabase.Gotrue.Client.html#Supabase_Gotrue_Client_SignOut_ @@ -1841,6 +1841,30 @@ references: commentId: F:Supabase.Gotrue.Constants.SignInType.RefreshToken fullName: Supabase.Gotrue.Constants.SignInType.RefreshToken nameWithType: Constants.SignInType.RefreshToken +- uid: Supabase.Gotrue.Constants.SignOutScope + name: Constants.SignOutScope + href: api/Supabase.Gotrue.Constants.SignOutScope.html + commentId: T:Supabase.Gotrue.Constants.SignOutScope + fullName: Supabase.Gotrue.Constants.SignOutScope + nameWithType: Constants.SignOutScope +- uid: Supabase.Gotrue.Constants.SignOutScope.Global + name: Global + href: api/Supabase.Gotrue.Constants.SignOutScope.html#Supabase_Gotrue_Constants_SignOutScope_Global + commentId: F:Supabase.Gotrue.Constants.SignOutScope.Global + fullName: Supabase.Gotrue.Constants.SignOutScope.Global + nameWithType: Constants.SignOutScope.Global +- uid: Supabase.Gotrue.Constants.SignOutScope.Local + name: Local + href: api/Supabase.Gotrue.Constants.SignOutScope.html#Supabase_Gotrue_Constants_SignOutScope_Local + commentId: F:Supabase.Gotrue.Constants.SignOutScope.Local + fullName: Supabase.Gotrue.Constants.SignOutScope.Local + nameWithType: Constants.SignOutScope.Local +- uid: Supabase.Gotrue.Constants.SignOutScope.Others + name: Others + href: api/Supabase.Gotrue.Constants.SignOutScope.html#Supabase_Gotrue_Constants_SignOutScope_Others + commentId: F:Supabase.Gotrue.Constants.SignOutScope.Others + fullName: Supabase.Gotrue.Constants.SignOutScope.Others + nameWithType: Constants.SignOutScope.Others - uid: Supabase.Gotrue.Constants.SignUpType name: Constants.SignUpType href: api/Supabase.Gotrue.Constants.SignUpType.html @@ -3059,15 +3083,15 @@ references: fullName.vb: Supabase.Gotrue.Interfaces.IGotrueApi(Of TUser, TSession).SignInWithSSO nameWithType: IGotrueApi.SignInWithSSO nameWithType.vb: IGotrueApi(Of TUser, TSession).SignInWithSSO -- uid: Supabase.Gotrue.Interfaces.IGotrueApi`2.SignOut(System.String) - name: SignOut(string) - href: api/Supabase.Gotrue.Interfaces.IGotrueApi-2.html#Supabase_Gotrue_Interfaces_IGotrueApi_2_SignOut_System_String_ - commentId: M:Supabase.Gotrue.Interfaces.IGotrueApi`2.SignOut(System.String) - name.vb: SignOut(String) - fullName: Supabase.Gotrue.Interfaces.IGotrueApi.SignOut(string) - fullName.vb: Supabase.Gotrue.Interfaces.IGotrueApi(Of TUser, TSession).SignOut(String) - nameWithType: IGotrueApi.SignOut(string) - nameWithType.vb: IGotrueApi(Of TUser, TSession).SignOut(String) +- uid: Supabase.Gotrue.Interfaces.IGotrueApi`2.SignOut(System.String,Supabase.Gotrue.Constants.SignOutScope) + name: SignOut(string, SignOutScope) + href: api/Supabase.Gotrue.Interfaces.IGotrueApi-2.html#Supabase_Gotrue_Interfaces_IGotrueApi_2_SignOut_System_String_Supabase_Gotrue_Constants_SignOutScope_ + commentId: M:Supabase.Gotrue.Interfaces.IGotrueApi`2.SignOut(System.String,Supabase.Gotrue.Constants.SignOutScope) + name.vb: SignOut(String, SignOutScope) + fullName: Supabase.Gotrue.Interfaces.IGotrueApi.SignOut(string, Supabase.Gotrue.Constants.SignOutScope) + fullName.vb: Supabase.Gotrue.Interfaces.IGotrueApi(Of TUser, TSession).SignOut(String, Supabase.Gotrue.Constants.SignOutScope) + nameWithType: IGotrueApi.SignOut(string, Constants.SignOutScope) + nameWithType.vb: IGotrueApi(Of TUser, TSession).SignOut(String, Constants.SignOutScope) - uid: Supabase.Gotrue.Interfaces.IGotrueApi`2.SignOut* name: SignOut href: api/Supabase.Gotrue.Interfaces.IGotrueApi-2.html#Supabase_Gotrue_Interfaces_IGotrueApi_2_SignOut_ @@ -3814,14 +3838,14 @@ references: fullName.vb: Supabase.Gotrue.Interfaces.IGotrueClient(Of TUser, TSession).SignInWithSSO nameWithType: IGotrueClient.SignInWithSSO nameWithType.vb: IGotrueClient(Of TUser, TSession).SignInWithSSO -- uid: Supabase.Gotrue.Interfaces.IGotrueClient`2.SignOut - name: SignOut() - href: api/Supabase.Gotrue.Interfaces.IGotrueClient-2.html#Supabase_Gotrue_Interfaces_IGotrueClient_2_SignOut - commentId: M:Supabase.Gotrue.Interfaces.IGotrueClient`2.SignOut - fullName: Supabase.Gotrue.Interfaces.IGotrueClient.SignOut() - fullName.vb: Supabase.Gotrue.Interfaces.IGotrueClient(Of TUser, TSession).SignOut() - nameWithType: IGotrueClient.SignOut() - nameWithType.vb: IGotrueClient(Of TUser, TSession).SignOut() +- uid: Supabase.Gotrue.Interfaces.IGotrueClient`2.SignOut(Supabase.Gotrue.Constants.SignOutScope) + name: SignOut(SignOutScope) + href: api/Supabase.Gotrue.Interfaces.IGotrueClient-2.html#Supabase_Gotrue_Interfaces_IGotrueClient_2_SignOut_Supabase_Gotrue_Constants_SignOutScope_ + commentId: M:Supabase.Gotrue.Interfaces.IGotrueClient`2.SignOut(Supabase.Gotrue.Constants.SignOutScope) + fullName: Supabase.Gotrue.Interfaces.IGotrueClient.SignOut(Supabase.Gotrue.Constants.SignOutScope) + fullName.vb: Supabase.Gotrue.Interfaces.IGotrueClient(Of TUser, TSession).SignOut(Supabase.Gotrue.Constants.SignOutScope) + nameWithType: IGotrueClient.SignOut(Constants.SignOutScope) + nameWithType.vb: IGotrueClient(Of TUser, TSession).SignOut(Constants.SignOutScope) - uid: Supabase.Gotrue.Interfaces.IGotrueClient`2.SignOut* name: SignOut href: api/Supabase.Gotrue.Interfaces.IGotrueClient-2.html#Supabase_Gotrue_Interfaces_IGotrueClient_2_SignOut_