-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathEpochtalkServerWeb.Controllers.PreferenceJSON.html
227 lines (176 loc) · 8.1 KB
/
EpochtalkServerWeb.Controllers.PreferenceJSON.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
<!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>EpochtalkServerWeb.Controllers.PreferenceJSON — 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">EpochtalkServerWeb.Controllers.PreferenceJSON</span>
<small class="app-vsn" translate="no">(epochtalk_server v0.1.0)</small>
</h1>
<section id="moduledoc">
<p>Renders and formats <code class="inline">Preference</code> data, in JSON format for frontend</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="#preferences/1" translate="no">preferences(map)</a>
</div>
<div class="summary-synopsis"><p>Renders formatted JSON response for user preferences.</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="preferences/1">
<div class="detail-header">
<a href="#preferences/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">preferences(map)</h1>
</div>
<section class="docstring">
<p>Renders formatted JSON response for user preferences.</p><h2 id="preferences/1-example" class="section-heading">
<a href="#preferences/1-example" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">example</p>
</a>
Example
</h2>
<p> iex> EpochtalkServerWeb.Controllers.PreferenceJSON.preferences(%{preferences: nil})
%{</p><pre><code class="makeup elixir" translate="no"><span class="ss">posts_per_page</span><span class="p">:</span><span class="w"> </span><span class="mi">25</span><span class="p">,</span><span class="w">
</span><span class="ss">threads_per_page</span><span class="p">:</span><span class="w"> </span><span class="mi">25</span><span class="p">,</span><span class="w">
</span><span class="ss">collapsed_categories</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="3719311519-1">[</span><span class="p" data-group-id="3719311519-1">]</span><span class="p">,</span><span class="w">
</span><span class="ss">ignored_boards</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="3719311519-2">[</span><span class="p" data-group-id="3719311519-2">]</span><span class="p">,</span><span class="w">
</span><span class="ss">timezone_offset</span><span class="p">:</span><span class="w"> </span><span class="s">""</span><span class="p">,</span><span class="w">
</span><span class="ss">notify_replied_threads</span><span class="p">:</span><span class="w"> </span><span class="no">true</span><span class="p">,</span><span class="w">
</span><span class="ss">ignore_newbies</span><span class="p">:</span><span class="w"> </span><span class="no">false</span><span class="p">,</span><span class="w">
</span><span class="ss">patroller_view</span><span class="p">:</span><span class="w"> </span><span class="no">false</span><span class="p">,</span><span class="w">
</span><span class="ss">email_mentions</span><span class="p">:</span><span class="w"> </span><span class="no">true</span><span class="p">,</span><span class="w">
</span><span class="ss">email_messages</span><span class="p">:</span><span class="w"> </span><span class="no">true</span></code></pre><p> }
iex> preferences = %{
iex> posts_per_page: 25,
iex> threads_per_page: 25,
iex> collapsed_categories: %{"cats" => []},
iex> ignored_boards: %{"boards" => []},
iex> timezone_offset: "",
iex> notify_replied_threads: true,
iex> ignore_newbies: false,
iex> patroller_view: false,
iex> email_mentions: true,
iex> email_messages: true
iex> }
iex> EpochtalkServerWeb.Controllers.PreferenceJSON.preferences(%{preferences: preferences})</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>