+Enum Constants.SignOutScope +
+ + + + + + +public enum Constants.SignOutScope
+ Fields +
+-
+
[MapTo("global", null)] +Global = 0
+
+ [MapTo("local", null)] +Local = 1
+
+ [MapTo("others", null)] +Others = 2
+
+
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 @@
Initialize the client with a service key.
@@ -205,7 +205,7 @@Headers sent to the API on every request.
@@ -237,7 +237,7 @@The initialized client options.
@@ -273,7 +273,7 @@Creates a user using the admin key (not the anonymous key). @@ -311,7 +311,7 @@
Creates a user using the admin key (not the anonymous key). @@ -353,7 +353,7 @@
Creates a user using the admin key (not the anonymous key). @@ -391,7 +391,7 @@
Generates email links and OTPs to be sent via a custom email provider.
@@ -429,7 +429,7 @@Gets a user from a user's JWT. This is using the GoTrue server to validate a user's JWT.
@@ -466,7 +466,7 @@Gets a user by ID from the server using the admin key (not the anonymous key).
@@ -503,7 +503,7 @@Sends an email to the user.
@@ -542,7 +542,7 @@Lists users
@@ -592,7 +592,7 @@Updates a User using the service key
@@ -629,7 +629,7 @@Update user by Id
@@ -668,7 +668,7 @@A custom data object for app_metadata that. Can be any JSON serializable data. @@ -212,7 +212,7 @@
Sets if a user has confirmed their email address. @@ -246,7 +246,7 @@
Sets if a user has confirmed their phone number. @@ -280,7 +280,7 @@
A custom data object for user_metadata. Can be any JSON serializable data. @@ -314,7 +314,7 @@
Creates a new API client
@@ -202,7 +202,7 @@Function that can be set to return dynamic headers. @@ -235,7 +235,7 @@
Headers to be sent with every request. These will be merged with any headers returned by GetHeaders.
@@ -271,7 +271,7 @@Create a user
@@ -312,7 +312,7 @@Delete a user
@@ -353,7 +353,7 @@Log in an existing user via code from third-party provider.
@@ -394,7 +394,7 @@Generates email links and OTPs to be sent via a custom email provider.
@@ -433,7 +433,7 @@Gets User Details
@@ -508,7 +508,7 @@Get User details by Id
@@ -549,7 +549,7 @@Sends an invite link to an email address.
@@ -591,7 +591,7 @@Links an oauth identity to an existing user.
@@ -635,7 +635,7 @@Lists users
@@ -688,7 +688,7 @@Sends a re-authentication request, used for password changes.
@@ -727,7 +727,7 @@Generates a new Session given a user's access token and refresh token.
@@ -766,7 +766,7 @@Sends a password reset request to an email address.
@@ -804,7 +804,7 @@Sends a reset request to an email address.
@@ -841,7 +841,7 @@Sends a magic login link to an email address.
@@ -880,7 +880,7 @@Sends a mobile OTP via SMS. Will register the account if it doesn't already exist
@@ -918,7 +918,7 @@Calls the GoTrue server to get the settings (for example, if email auto confirmation is turned on)
@@ -951,7 +951,7 @@Creates a new anonymous user.
@@ -989,7 +989,7 @@Logs in an existing user using their email address.
@@ -1028,7 +1028,7 @@Allows signing in with an ID token issued by certain supported providers. @@ -1080,7 +1080,7 @@
Log in a user using magiclink or a one-time password (OTP).
@@ -1126,7 +1126,7 @@Log in a user using magiclink or a one-time password (OTP).
@@ -1172,7 +1172,7 @@Logs in an existing user using their phone number and password.
@@ -1213,7 +1213,7 @@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)
jwt
stringscope
Constants.SignOutScopeSigns a user up using an email address and password.
@@ -1368,7 +1370,7 @@Signs up a new user using their phone number and a password.The phone number of the user.
@@ -1412,7 +1414,7 @@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 @@Updates the User data
@@ -1492,7 +1494,7 @@Update user by Id
@@ -1536,7 +1538,7 @@Send User supplied Email OTP to be verified
@@ -1580,7 +1582,7 @@Send User supplied Mobile OTP to be verified
@@ -1624,7 +1626,7 @@Initializes the GoTrue stateful client.
@@ -212,7 +212,7 @@The current Session as managed by this client. Does not refresh tokens or have any other side effects.
@@ -246,7 +246,7 @@The currently logged in User. This is a local cache of the current session User. @@ -280,7 +280,7 @@
Headers sent to the API on every request.
@@ -312,7 +312,7 @@Indicates if the client should be considered online or offline.
@@ -347,7 +347,7 @@Returns the client options.
@@ -379,7 +379,7 @@Get the TokenRefresh object, if it exists
@@ -415,7 +415,7 @@Add a listener to get errors that occur outside of a typical Exception flow. @@ -450,7 +450,7 @@
Adds a listener to be notified when the user state changes (e.g. the user logs in, logs out, @@ -484,7 +484,7 @@
Clears all of the listeners from receiving event state changes.
@@ -513,7 +513,7 @@Posts messages and exceptions to the debug listener. This is particularly useful for sorting @@ -548,7 +548,7 @@
Logs in an existing user via a third-party provider.
@@ -587,7 +587,7 @@Parses a Session out of a Uri's Query parameters.
@@ -626,7 +626,7 @@Get User details by JWT. Can be used to validate a JWT.
@@ -664,7 +664,7 @@Links an oauth identity to an existing user.
@@ -705,7 +705,7 @@Loads the session from the persistence layer.
@@ -732,7 +732,7 @@Notifies all listeners that the current user auth state has changed.
@@ -765,7 +765,7 @@Used for re-authenticating a user in password changes.
@@ -803,7 +803,7 @@Refreshes the currently logged in User's Session.
@@ -835,7 +835,7 @@Refreshes a Token using the current session.
@@ -867,7 +867,7 @@Removes a specified listener from event state changes.
@@ -937,7 +937,7 @@Sends a password reset request to an email address.
@@ -975,7 +975,7 @@Sends a reset request to an email address.
@@ -1012,7 +1012,7 @@Typically called as part of the startup process for the client.
@@ -1047,7 +1047,7 @@Sends a Magic email login link to the specified email.
@@ -1088,7 +1088,7 @@Sets the persistence implementation for the client (e.g. file system, local storage, etc).
@@ -1120,7 +1120,7 @@Sets a new session given a user's access token and their refresh token.
@@ -1175,7 +1175,7 @@Retrieves the settings from the server
@@ -1207,7 +1207,7 @@Let all of the listeners know that the stateless client is being shutdown.
@@ -1235,7 +1235,7 @@Retrieves a ProviderAuthState to redirect to for signing in with a Constants.Provider.
@@ -1276,7 +1276,7 @@Log in an existing user, or login via a third-party provider.
@@ -1323,7 +1323,7 @@Sends a magic link login email to the specified email.
@@ -1362,7 +1362,7 @@Signs in a User.
@@ -1401,7 +1401,7 @@Creates a new anonymous user.
@@ -1439,7 +1439,7 @@Allows signing in with an ID token issued by certain supported providers. @@ -1494,7 +1494,7 @@
Log in a user using magiclink or a one-time password (OTP).
@@ -1543,7 +1543,7 @@Log in a user using magiclink or a one-time password (OTP).
@@ -1592,7 +1592,7 @@Log in an existing user with an email and password or phone and password.
@@ -1631,7 +1631,7 @@Sign in using single sign on (SSO) as supported by supabase @@ -1675,7 +1675,7 @@
Sign in using single sign on (SSO) as supported by supabase @@ -1718,19 +1718,25 @@
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)
scope
Constants.SignOutScopeDetermines which sessions should be invalidated. By default, it will invalidate all session for a user
+Signs up a user
@@ -1808,7 +1814,7 @@Signs up a user by email address.
@@ -1862,7 +1868,7 @@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 @@Updates a User.
@@ -1937,7 +1943,7 @@Log in a user give a user supplied OTP received via email.
@@ -1979,7 +1985,7 @@Log in a user given a User supplied OTP received via mobile.
@@ -2023,7 +2029,7 @@Headers to be sent with subsequent requests.
@@ -192,7 +192,7 @@Very unlikely this flag needs to be changed except in very specific contexts.
@@ -226,7 +226,7 @@Should the Client automatically handle refreshing the User's Token?
@@ -258,7 +258,7 @@Ask the TokenRefresh system to log extra debug info
@@ -290,7 +290,7 @@By default, the Client will attempt to refresh the token when roughly 1/5 of the @@ -332,7 +332,7 @@
Gotrue Endpoint
@@ -364,7 +364,7 @@public enum Constants.SignOutScope
+ [MapTo("global", null)]
+Global = 0
[MapTo("local", null)]
+Local = 1
[MapTo("others", null)]
+Others = 2
URL for the Gotrue server. Defaults to localhost:9999.
@@ -277,7 +277,7 @@Add a debug listener to the Gotrue Client. This will be called with debug information
@@ -190,7 +190,7 @@Send a debug message to all debug listeners
@@ -224,7 +224,7 @@Detects the reason for the error based on the status code and the contents of the error message.
@@ -194,7 +194,7 @@Something with wrong with Gotrue / Auth
@@ -230,7 +230,7 @@Something with wrong with Gotrue / Auth
@@ -266,7 +266,7 @@Something with wrong with Gotrue / Auth
@@ -304,7 +304,7 @@Something with wrong with Gotrue / Auth
@@ -344,7 +344,7 @@The content of the HTTP response from the server
@@ -376,7 +376,7 @@Best guess at what caused the error from the server, see FailureHint.Reason
@@ -408,7 +408,7 @@The HTTP response from the server
@@ -440,7 +440,7 @@The HTTP status code from the server
@@ -476,7 +476,7 @@Adds the best-effort reason for the failure
@@ -503,7 +503,7 @@Constructs options for EmailChangeCurrent
@@ -210,7 +210,7 @@Constructs options for EmailChangeNew
@@ -210,7 +210,7 @@Constructs options, additional properties may need to be assigned depending on GenerateLinkOptions.LinkType
@@ -208,7 +208,7 @@A custom data object to store the user's metadata. This maps to the auth.users.user_metadata
column.
The User's Email
@@ -275,7 +275,7 @@The user's new email. Only required if type is 'email_change_current' or 'email_change_new'.
@@ -308,7 +308,7 @@Only required if generating a signup link.
@@ -341,7 +341,7 @@The URL which will be appended to the email link generated.
@@ -374,7 +374,7 @@The type of link being generated
@@ -407,7 +407,7 @@Constructs options for SignUp
@@ -213,7 +213,7 @@Generates a nonce (code verifier) @@ -192,7 +192,7 @@
Generates a PKCE SHA256 code challenge given a nonce (code verifier)
@@ -231,7 +231,7 @@Generates a SHA256 nonce given a rawNonce, used Apple/Google Sign in.
@@ -268,7 +268,7 @@Creates a user using the admin key (not the anonymous key). @@ -175,7 +175,7 @@
Creates a user using the admin key (not the anonymous key). @@ -217,7 +217,7 @@
Creates a user using the admin key (not the anonymous key). @@ -255,7 +255,7 @@
Generates email links and OTPs to be sent via a custom email provider.
@@ -293,7 +293,7 @@Gets a user from a user's JWT. This is using the GoTrue server to validate a user's JWT.
@@ -330,7 +330,7 @@Gets a user by ID from the server using the admin key (not the anonymous key).
@@ -367,7 +367,7 @@Sends an email to the user.
@@ -406,7 +406,7 @@Lists users
@@ -456,7 +456,7 @@Updates a User using the service key
@@ -493,7 +493,7 @@Update user by Id
@@ -532,7 +532,7 @@Links an oauth identity to an existing user.
@@ -486,7 +486,7 @@Task<BaseResponse> SignOut(string jwt)
+ Task<BaseResponse> SignOut(string jwt, Constants.SignOutScope scope = SignOutScope.Global)
jwt
stringscope
Constants.SignOutScopeUnlinks 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 @@The current Session as managed by this client. Does not refresh tokens or have any other side effects.
@@ -182,7 +182,7 @@The currently logged in User. This is a local cache of the current session User. @@ -216,7 +216,7 @@
Indicates if the client should be considered online or offline.
@@ -251,7 +251,7 @@Returns the client options.
@@ -287,7 +287,7 @@Add a listener to get errors that occur outside of a typical Exception flow. @@ -322,7 +322,7 @@
Adds a listener to be notified when the user state changes (e.g. the user logs in, logs out, @@ -356,7 +356,7 @@
Clears all of the listeners from receiving event state changes.
@@ -385,7 +385,7 @@Posts messages and exceptions to the debug listener. This is particularly useful for sorting @@ -420,7 +420,7 @@
Logs in an existing user via a third-party provider.
@@ -459,7 +459,7 @@Converts a URL to a session. For client apps, this probably requires setting up URL handlers.
@@ -498,7 +498,7 @@Get User details by JWT. Can be used to validate a JWT.
@@ -536,7 +536,7 @@Links an oauth identity to an existing user.
@@ -577,7 +577,7 @@Loads the session from the persistence layer.
@@ -604,7 +604,7 @@Notifies all listeners that the current user auth state has changed.
@@ -637,7 +637,7 @@Used for re-authenticating a user in password changes.
@@ -675,7 +675,7 @@Refreshes the currently logged in User's Session.
@@ -707,7 +707,7 @@Refreshes a Token using the current session.
@@ -739,7 +739,7 @@Removes a specified listener from event state changes.
@@ -771,7 +771,7 @@Sends a password reset request to an email address.
@@ -809,7 +809,7 @@Sends a reset request to an email address.
@@ -846,7 +846,7 @@Typically called as part of the startup process for the client.
@@ -881,7 +881,7 @@Sends a Magic email login link to the specified email.
@@ -922,7 +922,7 @@Sets the persistence implementation for the client (e.g. file system, local storage, etc).
@@ -954,7 +954,7 @@Sets a new session given a user's access token and their refresh token.
@@ -1009,7 +1009,7 @@Retrieves the settings from the server
@@ -1041,7 +1041,7 @@Let all of the listeners know that the stateless client is being shutdown.
@@ -1069,7 +1069,7 @@Retrieves a ProviderAuthState to redirect to for signing in with a Constants.Provider.
@@ -1110,7 +1110,7 @@Log in an existing user, or login via a third-party provider.
@@ -1157,7 +1157,7 @@Sends a magic link login email to the specified email.
@@ -1196,7 +1196,7 @@Signs in a User.
@@ -1235,7 +1235,7 @@Creates a new anonymous user.
@@ -1273,7 +1273,7 @@Allows signing in with an ID token issued by certain supported providers. @@ -1328,7 +1328,7 @@
Log in a user using magiclink or a one-time password (OTP).
@@ -1377,7 +1377,7 @@