Skip to content

Commit 7ecc936

Browse files
committed
Deploying to gh-pages from @ a3f8f49 🚀
1 parent 0b29922 commit 7ecc936

File tree

3 files changed

+110
-14
lines changed

3 files changed

+110
-14
lines changed

api/Supabase.Gotrue.Session.html

Lines changed: 83 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
8989

9090

9191
<h1 id="Supabase_Gotrue_Session" data-uid="Supabase.Gotrue.Session" class="text-break">
92-
Class Session <a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/Session.cs/#L10"><i class="bi bi-code-slash"></i></a>
92+
Class Session <a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/Session.cs/#L11"><i class="bi bi-code-slash"></i></a>
9393
</h1>
9494

9595
<div class="facts text-secondary">
@@ -157,10 +157,11 @@ <h2 class="section" id="properties">Properties
157157

158158
<h3 id="Supabase_Gotrue_Session_AccessToken" data-uid="Supabase.Gotrue.Session.AccessToken">
159159
AccessToken
160-
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/Session.cs/#L12"><i class="bi bi-code-slash"></i></a>
160+
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/Session.cs/#L16"><i class="bi bi-code-slash"></i></a>
161161
</h3>
162162

163-
<div class="markdown level1 summary"></div>
163+
<div class="markdown level1 summary"><p>The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value.</p>
164+
</div>
164165
<div class="markdown level1 conceptual"></div>
165166

166167
<div class="codewrapper">
@@ -189,7 +190,7 @@ <h4 class="section">Property Value</h4>
189190

190191
<h3 id="Supabase_Gotrue_Session_CreatedAt" data-uid="Supabase.Gotrue.Session.CreatedAt">
191192
CreatedAt
192-
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/Session.cs/#L27"><i class="bi bi-code-slash"></i></a>
193+
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/Session.cs/#L50"><i class="bi bi-code-slash"></i></a>
193194
</h3>
194195

195196
<div class="markdown level1 summary"></div>
@@ -221,10 +222,11 @@ <h4 class="section">Property Value</h4>
221222

222223
<h3 id="Supabase_Gotrue_Session_ExpiresIn" data-uid="Supabase.Gotrue.Session.ExpiresIn">
223224
ExpiresIn
224-
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/Session.cs/#L15"><i class="bi bi-code-slash"></i></a>
225+
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/Session.cs/#L22"><i class="bi bi-code-slash"></i></a>
225226
</h3>
226227

227-
<div class="markdown level1 summary"></div>
228+
<div class="markdown level1 summary"><p>The number of seconds until the token expires (since it was issued). Returned when a login is confirmed.</p>
229+
</div>
228230
<div class="markdown level1 conceptual"></div>
229231

230232
<div class="codewrapper">
@@ -249,14 +251,82 @@ <h4 class="section">Property Value</h4>
249251

250252

251253

254+
<a id="Supabase_Gotrue_Session_ProviderRefreshToken_" data-uid="Supabase.Gotrue.Session.ProviderRefreshToken*"></a>
255+
256+
<h3 id="Supabase_Gotrue_Session_ProviderRefreshToken" data-uid="Supabase.Gotrue.Session.ProviderRefreshToken">
257+
ProviderRefreshToken
258+
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/Session.cs/#L35"><i class="bi bi-code-slash"></i></a>
259+
</h3>
260+
261+
<div class="markdown level1 summary"><p>The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.
262+
Not all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token.</p>
263+
</div>
264+
<div class="markdown level1 conceptual"></div>
265+
266+
<div class="codewrapper">
267+
<pre><code class="lang-csharp hljs">[JsonProperty(&quot;provider_refresh_token&quot;)]
268+
public string? ProviderRefreshToken { get; set; }</code></pre>
269+
</div>
270+
271+
272+
273+
274+
275+
<h4 class="section">Property Value</h4>
276+
<dl class="parameters">
277+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
278+
<dd></dd>
279+
</dl>
280+
281+
282+
283+
284+
285+
286+
287+
288+
<a id="Supabase_Gotrue_Session_ProviderToken_" data-uid="Supabase.Gotrue.Session.ProviderToken*"></a>
289+
290+
<h3 id="Supabase_Gotrue_Session_ProviderToken" data-uid="Supabase.Gotrue.Session.ProviderToken">
291+
ProviderToken
292+
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/Session.cs/#L28"><i class="bi bi-code-slash"></i></a>
293+
</h3>
294+
295+
<div class="markdown level1 summary"><p>The oauth provider token. If present, this can be used to make external API requests to the oauth provider used.</p>
296+
</div>
297+
<div class="markdown level1 conceptual"></div>
298+
299+
<div class="codewrapper">
300+
<pre><code class="lang-csharp hljs">[JsonProperty(&quot;provider_token&quot;)]
301+
public string? ProviderToken { get; set; }</code></pre>
302+
</div>
303+
304+
305+
306+
307+
308+
<h4 class="section">Property Value</h4>
309+
<dl class="parameters">
310+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
311+
<dd></dd>
312+
</dl>
313+
314+
315+
316+
317+
318+
319+
320+
252321
<a id="Supabase_Gotrue_Session_RefreshToken_" data-uid="Supabase.Gotrue.Session.RefreshToken*"></a>
253322

254323
<h3 id="Supabase_Gotrue_Session_RefreshToken" data-uid="Supabase.Gotrue.Session.RefreshToken">
255324
RefreshToken
256-
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/Session.cs/#L18"><i class="bi bi-code-slash"></i></a>
325+
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/Session.cs/#L41"><i class="bi bi-code-slash"></i></a>
257326
</h3>
258327

259-
<div class="markdown level1 summary"></div>
328+
<div class="markdown level1 summary"><p>A one-time used refresh token that never expires.</p>
329+
</div>
260330
<div class="markdown level1 conceptual"></div>
261331

262332
<div class="codewrapper">
@@ -285,7 +355,7 @@ <h4 class="section">Property Value</h4>
285355

286356
<h3 id="Supabase_Gotrue_Session_TokenType" data-uid="Supabase.Gotrue.Session.TokenType">
287357
TokenType
288-
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/Session.cs/#L21"><i class="bi bi-code-slash"></i></a>
358+
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/Session.cs/#L44"><i class="bi bi-code-slash"></i></a>
289359
</h3>
290360

291361
<div class="markdown level1 summary"></div>
@@ -317,7 +387,7 @@ <h4 class="section">Property Value</h4>
317387

318388
<h3 id="Supabase_Gotrue_Session_User" data-uid="Supabase.Gotrue.Session.User">
319389
User
320-
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/Session.cs/#L24"><i class="bi bi-code-slash"></i></a>
390+
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/Session.cs/#L47"><i class="bi bi-code-slash"></i></a>
321391
</h3>
322392

323393
<div class="markdown level1 summary"></div>
@@ -353,7 +423,7 @@ <h2 class="section" id="methods">Methods
353423

354424
<h3 id="Supabase_Gotrue_Session_Expired" data-uid="Supabase.Gotrue.Session.Expired">
355425
Expired()
356-
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/Session.cs/#L40"><i class="bi bi-code-slash"></i></a>
426+
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/Session.cs/#L63"><i class="bi bi-code-slash"></i></a>
357427
</h3>
358428

359429
<div class="markdown level1 summary"><p>Returns true if the session has expired</p>
@@ -385,7 +455,7 @@ <h4 class="section">Returns</h4>
385455

386456
<h3 id="Supabase_Gotrue_Session_ExpiresAt" data-uid="Supabase.Gotrue.Session.ExpiresAt">
387457
ExpiresAt()
388-
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/Session.cs/#L34"><i class="bi bi-code-slash"></i></a>
458+
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/Session.cs/#L57"><i class="bi bi-code-slash"></i></a>
389459
</h3>
390460

391461
<div class="markdown level1 summary"><p>The expiration date of this session, in UTC time.</p>
@@ -417,7 +487,7 @@ <h4 class="section">Returns</h4>
417487
</article>
418488

419489
<div class="contribution d-print-none">
420-
<a href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/Session.cs/#L10" class="edit-link">Edit this page</a>
490+
<a href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/Session.cs/#L11" class="edit-link">Edit this page</a>
421491
</div>
422492

423493

index.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@
222222
"api/Supabase.Gotrue.Session.html": {
223223
"href": "api/Supabase.Gotrue.Session.html",
224224
"title": "Class Session | gotrue-csharp",
225-
"keywords": "Class Session Namespace Supabase.Gotrue Assembly Supabase.Gotrue.dll Represents a Gotrue Session public class Session Inheritance object Session Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Properties AccessToken [JsonProperty(\"access_token\")] public string? AccessToken { get; set; } Property Value string CreatedAt [JsonProperty(\"created_at\")] public DateTime CreatedAt { get; set; } Property Value DateTime ExpiresIn [JsonProperty(\"expires_in\")] public long ExpiresIn { get; set; } Property Value long RefreshToken [JsonProperty(\"refresh_token\")] public string? RefreshToken { get; set; } Property Value string TokenType [JsonProperty(\"token_type\")] public string? TokenType { get; set; } Property Value string User [JsonProperty(\"user\")] public User? User { get; set; } Property Value User Methods Expired() Returns true if the session has expired public bool Expired() Returns bool ExpiresAt() The expiration date of this session, in UTC time. public DateTime ExpiresAt() Returns DateTime"
225+
"keywords": "Class Session Namespace Supabase.Gotrue Assembly Supabase.Gotrue.dll Represents a Gotrue Session public class Session Inheritance object Session Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Properties AccessToken The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value. [JsonProperty(\"access_token\")] public string? AccessToken { get; set; } Property Value string CreatedAt [JsonProperty(\"created_at\")] public DateTime CreatedAt { get; set; } Property Value DateTime ExpiresIn The number of seconds until the token expires (since it was issued). Returned when a login is confirmed. [JsonProperty(\"expires_in\")] public long ExpiresIn { get; set; } Property Value long ProviderRefreshToken The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API. Not all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token. [JsonProperty(\"provider_refresh_token\")] public string? ProviderRefreshToken { get; set; } Property Value string ProviderToken The oauth provider token. If present, this can be used to make external API requests to the oauth provider used. [JsonProperty(\"provider_token\")] public string? ProviderToken { get; set; } Property Value string RefreshToken A one-time used refresh token that never expires. [JsonProperty(\"refresh_token\")] public string? RefreshToken { get; set; } Property Value string TokenType [JsonProperty(\"token_type\")] public string? TokenType { get; set; } Property Value string User [JsonProperty(\"user\")] public User? User { get; set; } Property Value User Methods Expired() Returns true if the session has expired public bool Expired() Returns bool ExpiresAt() The expiration date of this session, in UTC time. public DateTime ExpiresAt() Returns DateTime"
226226
},
227227
"api/Supabase.Gotrue.Settings.html": {
228228
"href": "api/Supabase.Gotrue.Settings.html",

xrefmap.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4835,6 +4835,32 @@ references:
48354835
isSpec: "True"
48364836
fullName: Supabase.Gotrue.Session.ExpiresIn
48374837
nameWithType: Session.ExpiresIn
4838+
- uid: Supabase.Gotrue.Session.ProviderRefreshToken
4839+
name: ProviderRefreshToken
4840+
href: api/Supabase.Gotrue.Session.html#Supabase_Gotrue_Session_ProviderRefreshToken
4841+
commentId: P:Supabase.Gotrue.Session.ProviderRefreshToken
4842+
fullName: Supabase.Gotrue.Session.ProviderRefreshToken
4843+
nameWithType: Session.ProviderRefreshToken
4844+
- uid: Supabase.Gotrue.Session.ProviderRefreshToken*
4845+
name: ProviderRefreshToken
4846+
href: api/Supabase.Gotrue.Session.html#Supabase_Gotrue_Session_ProviderRefreshToken_
4847+
commentId: Overload:Supabase.Gotrue.Session.ProviderRefreshToken
4848+
isSpec: "True"
4849+
fullName: Supabase.Gotrue.Session.ProviderRefreshToken
4850+
nameWithType: Session.ProviderRefreshToken
4851+
- uid: Supabase.Gotrue.Session.ProviderToken
4852+
name: ProviderToken
4853+
href: api/Supabase.Gotrue.Session.html#Supabase_Gotrue_Session_ProviderToken
4854+
commentId: P:Supabase.Gotrue.Session.ProviderToken
4855+
fullName: Supabase.Gotrue.Session.ProviderToken
4856+
nameWithType: Session.ProviderToken
4857+
- uid: Supabase.Gotrue.Session.ProviderToken*
4858+
name: ProviderToken
4859+
href: api/Supabase.Gotrue.Session.html#Supabase_Gotrue_Session_ProviderToken_
4860+
commentId: Overload:Supabase.Gotrue.Session.ProviderToken
4861+
isSpec: "True"
4862+
fullName: Supabase.Gotrue.Session.ProviderToken
4863+
nameWithType: Session.ProviderToken
48384864
- uid: Supabase.Gotrue.Session.RefreshToken
48394865
name: RefreshToken
48404866
href: api/Supabase.Gotrue.Session.html#Supabase_Gotrue_Session_RefreshToken

0 commit comments

Comments
 (0)