-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathEpochtalkServer.Models.Mention.html
560 lines (393 loc) · 20.7 KB
/
EpochtalkServer.Models.Mention.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
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
<!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.Models.Mention — 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.Models.Mention</span>
<small class="app-vsn" translate="no">(epochtalk_server v0.1.0)</small>
</h1>
<section id="moduledoc">
<p><code class="inline">Mention</code> model, for performing actions relating to forum categories</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-types summary">
<h2>
<a href="#types">Types</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:t/0" translate="no">t()</a>
</div>
</div>
</div>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#correct_text_search_vector/1" translate="no">correct_text_search_vector(post_attrs)</a>
</div>
<div class="summary-synopsis"><p>Fixes text search vector, since usernames are being converted to user ids before
<code class="inline">Post</code> is created, the created <code class="inline">Post</code> will have the ids in the tsv field. To correct
this we recreate the tsv field using the original <code class="inline">Post</code> body.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#create/1" translate="no">create(mention_attrs)</a>
</div>
<div class="summary-synopsis"><p>Create a <code class="inline">Mention</code> if the mentioned <code class="inline">User</code> has permission to view <code class="inline">Board</code> they are being mentioned in.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#create_changeset/2" translate="no">create_changeset(mention, attrs)</a>
</div>
<div class="summary-synopsis"><p>Create changeset for <code class="inline">Mention</code> model</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#delete/1" translate="no">delete(id)</a>
</div>
<div class="summary-synopsis"><p>Delete specific <code class="inline">Mention</code> by <code class="inline">id</code></p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#delete_by_user_id/1" translate="no">delete_by_user_id(user_id)</a>
</div>
<div class="summary-synopsis"><p>Delete all <code class="inline">Mention</code> for a specific <code class="inline">User</code></p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#handle_user_mention_creation/3" translate="no">handle_user_mention_creation(user, post_attrs, post)</a>
</div>
<div class="summary-synopsis"><p>Handles logic tied to the creation of <code class="inline">Mention</code>. Performs the following actions</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#page_by_user_id/3" translate="no">page_by_user_id(user_id, page \\ 1, opts \\ [])</a>
</div>
<div class="summary-synopsis"><p>Page <code class="inline">Mention</code> models by for a specific <code class="inline">User</code></p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#user_id_to_username/1" translate="no">user_id_to_username(post)</a>
</div>
<div class="summary-synopsis"><p>Iterates through list of <code class="inline">Post</code>, converts mentioned <code class="inline">User</code> id to a <code class="inline">User</code> usernames within the body of posts.
Used when retreiving posts from the database</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#username_to_user_id/2" translate="no">username_to_user_id(user, post_attrs)</a>
</div>
<div class="summary-synopsis"><p>Within <code class="inline">Post</code>, converts mentioned <code class="inline">User</code> usernames to a <code class="inline">User</code> ids within the body of posts.
Used before storing <code class="inline">Post</code> in the database</p></div>
</div>
</div>
</section>
<section id="types" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#types">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this section</span>
</a>
Types
</h1>
<div class="types-list">
<section class="detail" id="t:t/0">
<div class="detail-header">
<a href="#t:t/0" class="detail-link" title="Link to this type">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this type</span>
</a>
<h1 class="signature" translate="no">t()</h1>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@type</span> t() :: %EpochtalkServer.Models.Mention{
__meta__: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
created_at: <a href="https://hexdocs.pm/elixir/NaiveDateTime.html#t:t/0">NaiveDateTime.t</a>() | nil,
id: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>() | nil,
mentionee: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
mentionee_id: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>() | nil,
mentioner: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
mentioner_id: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>() | nil,
notification_id: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
post: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
post_id: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>() | nil,
thread: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
thread_id: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>() | nil,
viewed: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()
}</pre>
</div>
</section>
</section>
</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="correct_text_search_vector/1">
<div class="detail-header">
<a href="#correct_text_search_vector/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">correct_text_search_vector(post_attrs)</h1>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> correct_text_search_vector(post_attrs :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>()) ::
:ok | {<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>(), nil}</pre>
</div>
<p>Fixes text search vector, since usernames are being converted to user ids before
<code class="inline">Post</code> is created, the created <code class="inline">Post</code> will have the ids in the tsv field. To correct
this we recreate the tsv field using the original <code class="inline">Post</code> body.</p>
</section>
</section>
<section class="detail" id="create/1">
<div class="detail-header">
<a href="#create/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">create(mention_attrs)</h1>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> create(mention_attrs :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>()) ::
{:ok, mention :: <a href="#t:t/0">t</a>() | <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">boolean</a>()} | {:error, <a href="https://hexdocs.pm/ecto/3.11.2/Ecto.Changeset.html#t:t/0">Ecto.Changeset.t</a>()}</pre>
</div>
<p>Create a <code class="inline">Mention</code> if the mentioned <code class="inline">User</code> has permission to view <code class="inline">Board</code> they are being mentioned in.</p>
</section>
</section>
<section class="detail" id="create_changeset/2">
<div class="detail-header">
<a href="#create_changeset/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">create_changeset(mention, attrs)</h1>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> create_changeset(mention :: <a href="#t:t/0">t</a>(), attrs :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>() | nil) :: <a href="https://hexdocs.pm/ecto/3.11.2/Ecto.Changeset.html#t:t/0">Ecto.Changeset.t</a>()</pre>
</div>
<p>Create changeset for <code class="inline">Mention</code> model</p>
</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(id)</h1>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> delete(id :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>()) :: {:ok, deleted :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">boolean</a>()}</pre>
</div>
<p>Delete specific <code class="inline">Mention</code> by <code class="inline">id</code></p>
</section>
</section>
<section class="detail" id="delete_by_user_id/1">
<div class="detail-header">
<a href="#delete_by_user_id/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_by_user_id(user_id)</h1>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> delete_by_user_id(user_id :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>()) :: {:ok, deleted :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">boolean</a>()}</pre>
</div>
<p>Delete all <code class="inline">Mention</code> for a specific <code class="inline">User</code></p>
</section>
</section>
<section class="detail" id="handle_user_mention_creation/3">
<div class="detail-header">
<a href="#handle_user_mention_creation/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">handle_user_mention_creation(user, post_attrs, post)</h1>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> handle_user_mention_creation(
user :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>(),
post_attrs :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>(),
post :: <a href="EpochtalkServer.Models.Post.html#t:t/0">EpochtalkServer.Models.Post.t</a>()
) :: :ok</pre>
</div>
<p>Handles logic tied to the creation of <code class="inline">Mention</code>. Performs the following actions:</p><ul><li>Checks that <code class="inline">User</code> has permission to create <code class="inline">Mention</code></li><li>Iterates though each mentioned <code class="inline">User</code><ul><li>Checks that mentioned <code class="inline">User</code> is not ignoring the authenticated <code class="inline">User</code></li><li>Creates mentions</li><li>Sends websocket notification</li><li>Checks mention email settings<ul><li>Sends email to mentioned user if applicable</li></ul></li></ul></li></ul>
</section>
</section>
<section class="detail" id="page_by_user_id/3">
<span id="page_by_user_id/1"></span>
<span id="page_by_user_id/2"></span>
<div class="detail-header">
<a href="#page_by_user_id/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">page_by_user_id(user_id, page \\ 1, opts \\ [])</h1>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> page_by_user_id(user_id :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>(), page :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>(),
per_page: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>(),
extended: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">boolean</a>()
) :: {:ok, mentions :: [<a href="#t:t/0">t</a>()] | [], pagination_data :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>()}</pre>
</div>
<p>Page <code class="inline">Mention</code> models by for a specific <code class="inline">User</code></p><h3 id="page_by_user_id/3-valid-options" class="section-heading">
<a href="#page_by_user_id/3-valid-options" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">valid-options</p>
</a>
Valid Options
</h3>
<table><thead><tr><th style="text-align: left;">name</th><th style="text-align: left;">type</th><th style="text-align: left;">details</th></tr></thead><tbody><tr><td style="text-align: left;"><code class="inline">:per_page</code></td><td style="text-align: left;"><code class="inline">non_neg_integer</code></td><td style="text-align: left;">records per page to return</td></tr><tr><td style="text-align: left;"><code class="inline">:extended</code></td><td style="text-align: left;"><code class="inline">boolean</code></td><td style="text-align: left;">returns board and post details with mention if true</td></tr></tbody></table>
</section>
</section>
<section class="detail" id="user_id_to_username/1">
<div class="detail-header">
<a href="#user_id_to_username/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">user_id_to_username(post)</h1>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> user_id_to_username(posts :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>() | [<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>()]) :: updated_posts :: [<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>()]</pre>
</div>
<p>Iterates through list of <code class="inline">Post</code>, converts mentioned <code class="inline">User</code> id to a <code class="inline">User</code> usernames within the body of posts.
Used when retreiving posts from the database</p>
</section>
</section>
<section class="detail" id="username_to_user_id/2">
<div class="detail-header">
<a href="#username_to_user_id/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">username_to_user_id(user, post_attrs)</h1>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> username_to_user_id(user :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>(), post_attrs :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>()) ::
updated_post_attrs :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>()</pre>
</div>
<p>Within <code class="inline">Post</code>, converts mentioned <code class="inline">User</code> usernames to a <code class="inline">User</code> ids within the body of posts.
Used before storing <code class="inline">Post</code> in the database</p>
</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>