Skip to content

Commit 89b407c

Browse files
committed
Deploying to gh-pages from @ 2de994c 🚀
1 parent c158bcc commit 89b407c

7 files changed

Lines changed: 109 additions & 6 deletions

api/Supabase.Gotrue.ProviderAuthState.html

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ <h2 class="section" id="constructors">Constructors
164164

165165
<h3 id="Supabase_Gotrue_ProviderAuthState__ctor_System_Uri_" data-uid="Supabase.Gotrue.ProviderAuthState.#ctor(System.Uri)">
166166
ProviderAuthState(Uri)
167-
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/ProviderAuthState.cs/#L25"><i class="bi bi-code-slash"></i></a>
167+
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/ProviderAuthState.cs/#L31"><i class="bi bi-code-slash"></i></a>
168168
</h3>
169169

170170
<div class="markdown level1 summary"><p>Constructor</p>
@@ -228,6 +228,39 @@ <h4 class="section">Property Value</h4>
228228

229229

230230

231+
<a id="Supabase_Gotrue_ProviderAuthState_State_" data-uid="Supabase.Gotrue.ProviderAuthState.State*"></a>
232+
233+
<h3 id="Supabase_Gotrue_ProviderAuthState_State" data-uid="Supabase.Gotrue.ProviderAuthState.State">
234+
State
235+
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/ProviderAuthState.cs/#L25"><i class="bi bi-code-slash"></i></a>
236+
</h3>
237+
238+
<div class="markdown level1 summary"><p>The state parameter included in the OAuth URL for CSRF protection (RFC 6749 §10.12).
239+
Validate this against the state echoed back in the OAuth callback.</p>
240+
</div>
241+
<div class="markdown level1 conceptual"></div>
242+
243+
<div class="codewrapper">
244+
<pre><code class="lang-csharp hljs">public string State { get; set; }</code></pre>
245+
</div>
246+
247+
248+
249+
250+
251+
<h4 class="section">Property Value</h4>
252+
<dl class="parameters">
253+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
254+
<dd></dd>
255+
</dl>
256+
257+
258+
259+
260+
261+
262+
263+
231264
<a id="Supabase_Gotrue_ProviderAuthState_Uri_" data-uid="Supabase.Gotrue.ProviderAuthState.Uri*"></a>
232265

233266
<h3 id="Supabase_Gotrue_ProviderAuthState_Uri" data-uid="Supabase.Gotrue.ProviderAuthState.Uri">

api/Supabase.Gotrue.SSOResponse.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,9 @@ <h1 id="Supabase_Gotrue_SSOResponse" data-uid="Supabase.Gotrue.SSOResponse" clas
128128
<div>
129129
<a class="xref" href="Supabase.Gotrue.ProviderAuthState.html#Supabase_Gotrue_ProviderAuthState_PKCEVerifier">ProviderAuthState.PKCEVerifier</a>
130130
</div>
131+
<div>
132+
<a class="xref" href="Supabase.Gotrue.ProviderAuthState.html#Supabase_Gotrue_ProviderAuthState_State">ProviderAuthState.State</a>
133+
</div>
131134
<div>
132135
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
133136
</div>

api/Supabase.Gotrue.SignInOptions.html

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -289,6 +289,41 @@ <h4 class="section">Property Value</h4>
289289

290290

291291

292+
<a id="Supabase_Gotrue_SignInOptions_State_" data-uid="Supabase.Gotrue.SignInOptions.State*"></a>
293+
294+
<h3 id="Supabase_Gotrue_SignInOptions_State" data-uid="Supabase.Gotrue.SignInOptions.State">
295+
State
296+
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/SignInOptions.cs/#L39"><i class="bi bi-code-slash"></i></a>
297+
</h3>
298+
299+
<div class="markdown level1 summary"><p>An optional state parameter for CSRF protection (RFC 6749 §10.12).
300+
If not provided, one will be generated automatically.
301+
Store the returned <a class="xref" href="Supabase.Gotrue.ProviderAuthState.html#Supabase_Gotrue_ProviderAuthState_State">State</a> value and validate it
302+
against the state echoed back in the OAuth callback.</p>
303+
</div>
304+
<div class="markdown level1 conceptual"></div>
305+
306+
<div class="codewrapper">
307+
<pre><code class="lang-csharp hljs">public string? State { get; set; }</code></pre>
308+
</div>
309+
310+
311+
312+
313+
314+
<h4 class="section">Property Value</h4>
315+
<dl class="parameters">
316+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
317+
<dd></dd>
318+
</dl>
319+
320+
321+
322+
323+
324+
325+
326+
292327

293328
</article>
294329

api/Supabase.Gotrue.SignInWithSSOOptions.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,9 @@ <h1 id="Supabase_Gotrue_SignInWithSSOOptions" data-uid="Supabase.Gotrue.SignInWi
134134
<div>
135135
<a class="xref" href="Supabase.Gotrue.SignInOptions.html#Supabase_Gotrue_SignInOptions_FlowType">SignInOptions.FlowType</a>
136136
</div>
137+
<div>
138+
<a class="xref" href="Supabase.Gotrue.SignInOptions.html#Supabase_Gotrue_SignInOptions_State">SignInOptions.State</a>
139+
</div>
137140
<div>
138141
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
139142
</div>

api/Supabase.Gotrue.SignUpOptions.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,9 @@ <h1 id="Supabase_Gotrue_SignUpOptions" data-uid="Supabase.Gotrue.SignUpOptions"
134134
<div>
135135
<a class="xref" href="Supabase.Gotrue.SignInOptions.html#Supabase_Gotrue_SignInOptions_FlowType">SignInOptions.FlowType</a>
136136
</div>
137+
<div>
138+
<a class="xref" href="Supabase.Gotrue.SignInOptions.html#Supabase_Gotrue_SignInOptions_State">SignInOptions.State</a>
139+
</div>
137140
<div>
138141
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
139142
</div>

index.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,7 @@
297297
"api/Supabase.Gotrue.ProviderAuthState.html": {
298298
"href": "api/Supabase.Gotrue.ProviderAuthState.html",
299299
"title": "Class ProviderAuthState | gotrue-csharp",
300-
"summary": "Class ProviderAuthState Namespace Supabase.Gotrue Assembly Supabase.Gotrue.dll Represents an OAuth Provider's URI and Parameters. For use with Provider Auth, PKCE Auth, and ID Token auth. public class ProviderAuthState Inheritance object ProviderAuthState Derived SSOResponse Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors ProviderAuthState(Uri) Constructor public ProviderAuthState(Uri uri) Parameters uri Uri Properties PKCEVerifier The PKCE Verifier nonce, only set during a PKCE auth flow. public string? PKCEVerifier { get; set; } Property Value string Uri The Generated Provider's URI public Uri Uri { get; set; } Property Value Uri"
300+
"summary": "Class ProviderAuthState Namespace Supabase.Gotrue Assembly Supabase.Gotrue.dll Represents an OAuth Provider's URI and Parameters. For use with Provider Auth, PKCE Auth, and ID Token auth. public class ProviderAuthState Inheritance object ProviderAuthState Derived SSOResponse Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors ProviderAuthState(Uri) Constructor public ProviderAuthState(Uri uri) Parameters uri Uri Properties PKCEVerifier The PKCE Verifier nonce, only set during a PKCE auth flow. public string? PKCEVerifier { get; set; } Property Value string State The state parameter included in the OAuth URL for CSRF protection (RFC 6749 §10.12). Validate this against the state echoed back in the OAuth callback. public string State { get; set; } Property Value string Uri The Generated Provider's URI public Uri Uri { get; set; } Property Value Uri"
301301
},
302302
"api/Supabase.Gotrue.ResetPasswordForEmailOptions.html": {
303303
"href": "api/Supabase.Gotrue.ResetPasswordForEmailOptions.html",
@@ -327,7 +327,7 @@
327327
"api/Supabase.Gotrue.SSOResponse.html": {
328328
"href": "api/Supabase.Gotrue.SSOResponse.html",
329329
"title": "Class SSOResponse | gotrue-csharp",
330-
"summary": "Class SSOResponse Namespace Supabase.Gotrue Assembly Supabase.Gotrue.dll Single sign on (SSO) response data deserialized from the API {supabaseAuthUrl}/sso public class SSOResponse : ProviderAuthState Inheritance object ProviderAuthState SSOResponse Inherited Members ProviderAuthState.Uri ProviderAuthState.PKCEVerifier object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors SSOResponse(Uri) Deserialized response from {supabaseAuthUrl}/sso public SSOResponse(Uri uri) Parameters uri Uri Uri from the response, this will open the SSO providers login page and allow a user to login to their provider"
330+
"summary": "Class SSOResponse Namespace Supabase.Gotrue Assembly Supabase.Gotrue.dll Single sign on (SSO) response data deserialized from the API {supabaseAuthUrl}/sso public class SSOResponse : ProviderAuthState Inheritance object ProviderAuthState SSOResponse Inherited Members ProviderAuthState.Uri ProviderAuthState.PKCEVerifier ProviderAuthState.State object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors SSOResponse(Uri) Deserialized response from {supabaseAuthUrl}/sso public SSOResponse(Uri uri) Parameters uri Uri Uri from the response, this will open the SSO providers login page and allow a user to login to their provider"
331331
},
332332
"api/Supabase.Gotrue.Session.html": {
333333
"href": "api/Supabase.Gotrue.Session.html",
@@ -347,7 +347,7 @@
347347
"api/Supabase.Gotrue.SignInOptions.html": {
348348
"href": "api/Supabase.Gotrue.SignInOptions.html",
349349
"title": "Class SignInOptions | gotrue-csharp",
350-
"summary": "Class SignInOptions Namespace Supabase.Gotrue Assembly Supabase.Gotrue.dll Options used for signing in a user. public class SignInOptions Inheritance object SignInOptions Derived SignInWithSSOOptions SignUpOptions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Properties FlowType Represents an OAuth Flow type, defaults to Implicit PKCE is recommended for mobile and server-side applications. public Constants.OAuthFlowType FlowType { get; set; } Property Value Constants.OAuthFlowType QueryParams An object of key-value pairs containing query parameters granted to the OAuth application. public Dictionary<string, string>? QueryParams { get; set; } Property Value Dictionary<string, string> RedirectTo A URL or mobile address to send the user to after they are confirmed. public string? RedirectTo { get; set; } Property Value string Scopes A space-separated list of scopes granted to the OAuth application. public string? Scopes { get; set; } Property Value string"
350+
"summary": "Class SignInOptions Namespace Supabase.Gotrue Assembly Supabase.Gotrue.dll Options used for signing in a user. public class SignInOptions Inheritance object SignInOptions Derived SignInWithSSOOptions SignUpOptions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Properties FlowType Represents an OAuth Flow type, defaults to Implicit PKCE is recommended for mobile and server-side applications. public Constants.OAuthFlowType FlowType { get; set; } Property Value Constants.OAuthFlowType QueryParams An object of key-value pairs containing query parameters granted to the OAuth application. public Dictionary<string, string>? QueryParams { get; set; } Property Value Dictionary<string, string> RedirectTo A URL or mobile address to send the user to after they are confirmed. public string? RedirectTo { get; set; } Property Value string Scopes A space-separated list of scopes granted to the OAuth application. public string? Scopes { get; set; } Property Value string State An optional state parameter for CSRF protection (RFC 6749 §10.12). If not provided, one will be generated automatically. Store the returned State value and validate it against the state echoed back in the OAuth callback. public string? State { get; set; } Property Value string"
351351
},
352352
"api/Supabase.Gotrue.SignInWithPasswordlessEmailOptions.html": {
353353
"href": "api/Supabase.Gotrue.SignInWithPasswordlessEmailOptions.html",
@@ -372,12 +372,12 @@
372372
"api/Supabase.Gotrue.SignInWithSSOOptions.html": {
373373
"href": "api/Supabase.Gotrue.SignInWithSSOOptions.html",
374374
"title": "Class SignInWithSSOOptions | gotrue-csharp",
375-
"summary": "Class SignInWithSSOOptions Namespace Supabase.Gotrue Assembly Supabase.Gotrue.dll Options used for signing in a user using single sign on (SSO). public class SignInWithSSOOptions : SignInOptions Inheritance object SignInOptions SignInWithSSOOptions Inherited Members SignInOptions.RedirectTo SignInOptions.Scopes SignInOptions.QueryParams SignInOptions.FlowType object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Properties CaptchaToken Verification token received when the user completes the captcha on the site. [JsonProperty(\"captchaToken\")] public string? CaptchaToken { get; set; } Property Value string"
375+
"summary": "Class SignInWithSSOOptions Namespace Supabase.Gotrue Assembly Supabase.Gotrue.dll Options used for signing in a user using single sign on (SSO). public class SignInWithSSOOptions : SignInOptions Inheritance object SignInOptions SignInWithSSOOptions Inherited Members SignInOptions.RedirectTo SignInOptions.Scopes SignInOptions.QueryParams SignInOptions.FlowType SignInOptions.State object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Properties CaptchaToken Verification token received when the user completes the captcha on the site. [JsonProperty(\"captchaToken\")] public string? CaptchaToken { get; set; } Property Value string"
376376
},
377377
"api/Supabase.Gotrue.SignUpOptions.html": {
378378
"href": "api/Supabase.Gotrue.SignUpOptions.html",
379379
"title": "Class SignUpOptions | gotrue-csharp",
380-
"summary": "Class SignUpOptions Namespace Supabase.Gotrue Assembly Supabase.Gotrue.dll Options used for signing up a user. public class SignUpOptions : SignInOptions Inheritance object SignInOptions SignUpOptions Inherited Members SignInOptions.RedirectTo SignInOptions.Scopes SignInOptions.QueryParams SignInOptions.FlowType object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Properties Data Optional user metadata. public Dictionary<string, object>? Data { get; set; } Property Value Dictionary<string, object>"
380+
"summary": "Class SignUpOptions Namespace Supabase.Gotrue Assembly Supabase.Gotrue.dll Options used for signing up a user. public class SignUpOptions : SignInOptions Inheritance object SignInOptions SignUpOptions Inherited Members SignInOptions.RedirectTo SignInOptions.Scopes SignInOptions.QueryParams SignInOptions.FlowType SignInOptions.State object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Properties Data Optional user metadata. public Dictionary<string, object>? Data { get; set; } Property Value Dictionary<string, object>"
381381
},
382382
"api/Supabase.Gotrue.StatelessClient.StatelessClientOptions.html": {
383383
"href": "api/Supabase.Gotrue.StatelessClient.StatelessClientOptions.html",

xrefmap.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6114,6 +6114,19 @@ references:
61146114
isSpec: "True"
61156115
fullName: Supabase.Gotrue.ProviderAuthState.PKCEVerifier
61166116
nameWithType: ProviderAuthState.PKCEVerifier
6117+
- uid: Supabase.Gotrue.ProviderAuthState.State
6118+
name: State
6119+
href: api/Supabase.Gotrue.ProviderAuthState.html#Supabase_Gotrue_ProviderAuthState_State
6120+
commentId: P:Supabase.Gotrue.ProviderAuthState.State
6121+
fullName: Supabase.Gotrue.ProviderAuthState.State
6122+
nameWithType: ProviderAuthState.State
6123+
- uid: Supabase.Gotrue.ProviderAuthState.State*
6124+
name: State
6125+
href: api/Supabase.Gotrue.ProviderAuthState.html#Supabase_Gotrue_ProviderAuthState_State_
6126+
commentId: Overload:Supabase.Gotrue.ProviderAuthState.State
6127+
isSpec: "True"
6128+
fullName: Supabase.Gotrue.ProviderAuthState.State
6129+
nameWithType: ProviderAuthState.State
61176130
- uid: Supabase.Gotrue.ProviderAuthState.Uri
61186131
name: Uri
61196132
href: api/Supabase.Gotrue.ProviderAuthState.html#Supabase_Gotrue_ProviderAuthState_Uri
@@ -6667,6 +6680,19 @@ references:
66676680
isSpec: "True"
66686681
fullName: Supabase.Gotrue.SignInOptions.Scopes
66696682
nameWithType: SignInOptions.Scopes
6683+
- uid: Supabase.Gotrue.SignInOptions.State
6684+
name: State
6685+
href: api/Supabase.Gotrue.SignInOptions.html#Supabase_Gotrue_SignInOptions_State
6686+
commentId: P:Supabase.Gotrue.SignInOptions.State
6687+
fullName: Supabase.Gotrue.SignInOptions.State
6688+
nameWithType: SignInOptions.State
6689+
- uid: Supabase.Gotrue.SignInOptions.State*
6690+
name: State
6691+
href: api/Supabase.Gotrue.SignInOptions.html#Supabase_Gotrue_SignInOptions_State_
6692+
commentId: Overload:Supabase.Gotrue.SignInOptions.State
6693+
isSpec: "True"
6694+
fullName: Supabase.Gotrue.SignInOptions.State
6695+
nameWithType: SignInOptions.State
66706696
- uid: Supabase.Gotrue.SignInWithPasswordlessEmailOptions
66716697
name: SignInWithPasswordlessEmailOptions
66726698
href: api/Supabase.Gotrue.SignInWithPasswordlessEmailOptions.html

0 commit comments

Comments
 (0)