-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathEpochtalkServer.Session.html
386 lines (272 loc) · 13.2 KB
/
EpochtalkServer.Session.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.29.4">
<meta name="project" content="epochtalk_server v0.1.0">
<title>EpochtalkServer.Session — epochtalk_server v0.1.0</title>
<link rel="stylesheet" href="dist/html-elixir-HHVY3JYD.css" />
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-XWGFFSCD.js"></script>
<script src="dist/sidebar_items-EA60E5D0.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/html-JDI3AVDD.js"></script>
</head>
<body data-type="modules" class="page-module">
<script>
try {
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
if (settings.theme === 'dark' ||
((settings.theme === 'system' || settings.theme == null) &&
window.matchMedia('(prefers-color-scheme: dark)').matches)
) {
document.body.classList.add('dark')
}
} catch (error) { }
</script>
<div class="main">
<button class="sidebar-button sidebar-toggle" aria-label="toggle sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<section class="sidebar">
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button" aria-label="Submit Search">
<i class="ri-search-2-line" aria-hidden="true" title="Submit search"></i>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-label="Cancel Search">
<i class="ri-close-line ri-lg" aria-hidden="true" title="Cancel search"></i>
</button>
<label class="search-label">
<p class="sr-only">Search</p>
<input name="q" type="text" class="search-input" placeholder="Search..." aria-label="Input your search terms" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
</label>
</form>
<div class="autocomplete">
<div class="autocomplete-results">
</div>
</div>
<div class="sidebar-header">
<div class="sidebar-projectDetails">
<a href="api-reference.html" class="sidebar-projectName" translate="no">
epochtalk_server
</a>
<div class="sidebar-projectVersion" translate="no">
v0.1.0
</div>
</div>
<ul class="sidebar-listNav">
<li><a id="extras-list-link" href="#full-list">Pages</a></li>
<li><a id="modules-list-link" href="#full-list">Modules</a></li>
</ul>
</div>
<div class="gradient"></div>
<ul id="full-list"></ul>
</section>
<section class="content">
<output role="status" id="toast"></output>
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<button class="icon-action display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
<span translate="no">EpochtalkServer.Session</span>
<small class="app-vsn" translate="no">(epochtalk_server v0.1.0)</small>
</h1>
<section id="moduledoc">
<p>Manages <code class="inline">User</code> sessions in Redis. Used by Auth related <code class="inline">User</code> actions.</p>
</section>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this section</span>
</a>
Summary
</h1>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#create/3" translate="no">create(user, remember_me, conn)</a>
</div>
<div class="summary-synopsis"><p>Create session performs the following actions</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#delete/1" translate="no">delete(conn)</a>
</div>
<div class="summary-synopsis"><p>Deletes the session specified in conn</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#delete_sessions/1" translate="no">delete_sessions(user)</a>
</div>
<div class="summary-synopsis"><p>Deletes every session instance for the specified <code class="inline">User</code></p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_resource/2" translate="no">get_resource(user_id, session_id)</a>
</div>
<div class="summary-synopsis"><p>Get the resource for a specified user_id and session_id if available
Otherwise, return an error</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_sessions/1" translate="no">get_sessions(user_id)</a>
</div>
<div class="summary-synopsis"><p>Gets all session ids for a specific user_id</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#update/1" translate="no">update(user_id)</a>
</div>
<div class="summary-synopsis"><p>Update session performs the following actions for active session</p></div>
</div>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this section</span>
</a>
Functions
</h1>
<div class="functions-list">
<section class="detail" id="create/3">
<div class="detail-header">
<a href="#create/3" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">create(user, remember_me, conn)</h1>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> create(
user :: <a href="EpochtalkServer.Models.User.html#t:t/0">EpochtalkServer.Models.User.t</a>(),
remember_me :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">boolean</a>(),
conn :: <a href="https://hexdocs.pm/plug/1.16.1/Plug.Conn.html#t:t/0">Plug.Conn.t</a>()
) ::
{:ok, user :: <a href="EpochtalkServer.Models.User.html#t:t/0">EpochtalkServer.Models.User.t</a>(), encoded_token :: <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>(),
conn :: <a href="https://hexdocs.pm/plug/1.16.1/Plug.Conn.html#t:t/0">Plug.Conn.t</a>()}</pre>
</div>
<p>Create session performs the following actions:</p><ul><li>Sets user's session id, timestamp, ttl</li><li>Logs <code class="inline">User</code> in with Guardian to get token</li><li>Saves <code class="inline">User</code> session info to redis (avatar, roles, moderating, ban info, etc)</li><li>returns {:ok, user, token and conn}</li></ul>
</section>
</section>
<section class="detail" id="delete/1">
<div class="detail-header">
<a href="#delete/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">delete(conn)</h1>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> delete(conn :: <a href="https://hexdocs.pm/plug/1.16.1/Plug.Conn.html#t:t/0">Plug.Conn.t</a>()) ::
{:ok, conn :: <a href="https://hexdocs.pm/plug/1.16.1/Plug.Conn.html#t:t/0">Plug.Conn.t</a>()}
| {:error, <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">atom</a>() | <a href="https://hexdocs.pm/redix/1.2.4/Redix.Error.html#t:t/0">Redix.Error.t</a>() | <a href="https://hexdocs.pm/redix/1.2.4/Redix.ConnectionError.html#t:t/0">Redix.ConnectionError.t</a>()}</pre>
</div>
<p>Deletes the session specified in conn</p>
</section>
</section>
<section class="detail" id="delete_sessions/1">
<div class="detail-header">
<a href="#delete_sessions/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">delete_sessions(user)</h1>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> delete_sessions(user :: <a href="EpochtalkServer.Models.User.html#t:t/0">EpochtalkServer.Models.User.t</a>()) ::
{:ok, <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>()} | <a href="https://hexdocs.pm/redix/1.2.4/Redix.ConnectionError.html#t:t/0">Redix.ConnectionError.t</a>()</pre>
</div>
<p>Deletes every session instance for the specified <code class="inline">User</code></p>
</section>
</section>
<section class="detail" id="get_resource/2">
<div class="detail-header">
<a href="#get_resource/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">get_resource(user_id, session_id)</h1>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> get_resource(user_id :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>(), session_id :: <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>()) ::
{:ok, resource :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>()}
| {:error, reason :: <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>() | <a href="https://hexdocs.pm/redix/1.2.4/Redix.Error.html#t:t/0">Redix.Error.t</a>() | <a href="https://hexdocs.pm/redix/1.2.4/Redix.ConnectionError.html#t:t/0">Redix.ConnectionError.t</a>()}</pre>
</div>
<p>Get the resource for a specified user_id and session_id if available
Otherwise, return an error</p>
</section>
</section>
<section class="detail" id="get_sessions/1">
<div class="detail-header">
<a href="#get_sessions/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">get_sessions(user_id)</h1>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> get_sessions(user_id :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>()) ::
{:ok, sessions_ids :: [<a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>()]}
| {:error, <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">atom</a>() | <a href="https://hexdocs.pm/redix/1.2.4/Redix.Error.html#t:t/0">Redix.Error.t</a>() | <a href="https://hexdocs.pm/redix/1.2.4/Redix.ConnectionError.html#t:t/0">Redix.ConnectionError.t</a>()}</pre>
</div>
<p>Gets all session ids for a specific user_id</p>
</section>
</section>
<section class="detail" id="update/1">
<div class="detail-header">
<a href="#update/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">update(user_id)</h1>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> update(user_id :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>()) ::
{:ok, user :: <a href="EpochtalkServer.Models.User.html#t:t/0">EpochtalkServer.Models.User.t</a>()}
| {:error, reason :: <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>() | <a href="https://hexdocs.pm/postgrex/0.17.5/Postgrex.Error.html#t:t/0">Postgrex.Error.t</a>()}</pre>
</div>
<p>Update session performs the following actions for active session:</p><ul><li>Saves <code class="inline">User</code> session info to redis (avatar, roles, moderating, ban info, etc)</li><li>returns {:ok, user} on success</li><li>returns {:error, reason} on failure</li></ul><p>DOES NOT change:</p><ul><li>User's session id, timestamp, ttl</li><li>Guardian token</li></ul>
</section>
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
<button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
Search HexDocs
</button>
<a href="epochtalk_server.epub" title="ePub version">
Download ePub version
</a>
</span>
</p>
<p class="built-using">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.29.4) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</section>
</div>
</body>
</html>