@qikdev/sdk 1.0.2 → 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/{docs/access.html → access.html} +353 -20
- package/dist/api.html +444 -0
- package/dist/{docs/auth.html → auth.html} +14 -14
- package/dist/cache.html +351 -0
- package/dist/{docs/content.html → content.html} +46 -21
- package/dist/{docs/files.html → files.html} +147 -6
- package/dist/{docs/filter.html → filter.html} +9 -9
- package/dist/geo.html +1029 -0
- package/dist/global.html +240 -0
- package/dist/index.html +96 -0
- package/dist/main.js +2 -3
- package/dist/module-QikStorage-CookieStorageAdapter.html +407 -0
- package/dist/module-QikStorage-LocalStorageAdapter.html +193 -0
- package/dist/module-QikStorage-StorageAdapter.html +977 -0
- package/dist/module-QikStorage.html +433 -0
- package/dist/qik.access.js.html +904 -0
- package/dist/qik.api.js.html +409 -0
- package/dist/{docs/qik.auth.js.html → qik.auth.js.html} +142 -104
- package/dist/qik.cache.js.html +125 -0
- package/dist/qik.content.js.html +967 -0
- package/dist/qik.core.js.html +322 -0
- package/dist/qik.files.js.html +249 -0
- package/dist/{docs/qik.filter.js.html → qik.filter.js.html} +3 -3
- package/dist/qik.geo.js.html +963 -0
- package/dist/{docs/qik.socket.js.html → qik.socket.js.html} +53 -12
- package/dist/qik.storage.js.html +375 -0
- package/dist/qik.system.js.html +117 -0
- package/dist/qik.utils.js.html +1548 -0
- package/dist/{docs/socket.html → socket.html} +7 -7
- package/dist/{docs/styles → styles}/jsdoc.css +2 -2
- package/dist/system.html +197 -0
- package/dist/utils.html +4422 -0
- package/package.json +2 -2
- package/src/api/qik.filter.js +1 -1
- package/src/api/qik.geo.js +1 -1
- package/src/api/qik.socket.js +18 -12
- package/src/api/qik.utils.js +6 -0
- package/src/version.js +1 -1
- package/dist/docs/api.html +0 -1356
- package/dist/docs/cache.html +0 -351
- package/dist/docs/index.html +0 -96
- package/dist/docs/qik.access.js.html +0 -790
- package/dist/docs/qik.api.js.html +0 -511
- package/dist/docs/qik.cache.js.html +0 -131
- package/dist/docs/qik.content.js.html +0 -918
- package/dist/docs/qik.core.js.html +0 -301
- package/dist/docs/qik.files.js.html +0 -219
- package/dist/docs/qik.system.js.html +0 -117
- package/dist/docs/qik.utils.js.html +0 -1467
- package/dist/docs/system.html +0 -197
- /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Bold.eot +0 -0
- /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Bold.ttf +0 -0
- /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Bold.woff +0 -0
- /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Bold.woff2 +0 -0
- /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Regular.eot +0 -0
- /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Regular.ttf +0 -0
- /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Regular.woff +0 -0
- /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Regular.woff2 +0 -0
- /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
- /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -0
- /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
- /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
- /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
- /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
- /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -0
- /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
- /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
- /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
- /package/dist/{docs/scripts → scripts}/collapse.js +0 -0
- /package/dist/{docs/scripts → scripts}/linenumber.js +0 -0
- /package/dist/{docs/scripts → scripts}/nav.js +0 -0
- /package/dist/{docs/scripts → scripts}/polyfill.js +0 -0
- /package/dist/{docs/scripts → scripts}/prettify/Apache-License-2.0.txt +0 -0
- /package/dist/{docs/scripts → scripts}/prettify/lang-css.js +0 -0
- /package/dist/{docs/scripts → scripts}/prettify/prettify.js +0 -0
- /package/dist/{docs/scripts → scripts}/search.js +0 -0
- /package/dist/{docs/styles → styles}/prettify.css +0 -0
package/dist/cache.html
ADDED
|
@@ -0,0 +1,351 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
|
|
5
|
+
<meta charset="utf-8">
|
|
6
|
+
<title>cache - Documentation</title>
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
<script src="scripts/prettify/prettify.js"></script>
|
|
10
|
+
<script src="scripts/prettify/lang-css.js"></script>
|
|
11
|
+
<!--[if lt IE 9]>
|
|
12
|
+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
13
|
+
<![endif]-->
|
|
14
|
+
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
|
|
15
|
+
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
|
|
16
|
+
<script src="scripts/nav.js" defer></script>
|
|
17
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
18
|
+
</head>
|
|
19
|
+
<body>
|
|
20
|
+
|
|
21
|
+
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
|
|
22
|
+
<label for="nav-trigger" class="navicon-button x">
|
|
23
|
+
<div class="navicon"></div>
|
|
24
|
+
</label>
|
|
25
|
+
|
|
26
|
+
<label for="nav-trigger" class="overlay"></label>
|
|
27
|
+
|
|
28
|
+
<nav >
|
|
29
|
+
|
|
30
|
+
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="access.html">access</a><ul class='methods'><li data-type='method'><a href="access.html#.actionableScopes">actionableScopes</a></li><li data-type='method'><a href="access.html#.allPermissions">allPermissions</a></li><li data-type='method'><a href="access.html#.allPermissionTypes">allPermissionTypes</a></li><li data-type='method'><a href="access.html#.allUserScopes">allUserScopes</a></li><li data-type='method'><a href="access.html#.canCreate">canCreate</a></li><li data-type='method'><a href="access.html#.canDeleteItem">canDeleteItem</a></li><li data-type='method'><a href="access.html#.canEditItem">canEditItem</a></li><li data-type='method'><a href="access.html#.canEraseItem">canEraseItem</a></li><li data-type='method'><a href="access.html#.canKnowOf">canKnowOf</a></li><li data-type='method'><a href="access.html#.canListItem">canListItem</a></li><li data-type='method'><a href="access.html#.canRestoreItem">canRestoreItem</a></li><li data-type='method'><a href="access.html#.canViewItem">canViewItem</a></li><li data-type='method'><a href="access.html#.checkActionAccess">checkActionAccess</a></li><li data-type='method'><a href="access.html#.getAllDescendants">getAllDescendants</a></li><li data-type='method'><a href="access.html#.has">has</a></li><li data-type='method'><a href="access.html#.hasFeature">hasFeature</a></li><li data-type='method'><a href="access.html#.hashPermissions">hashPermissions</a></li><li data-type='method'><a href="access.html#.isAdministrator">isAdministrator</a></li><li data-type='method'><a href="access.html#.isAssignee">isAssignee</a></li><li data-type='method'><a href="access.html#.isOwner">isOwner</a></li></ul></li><li><a href="api.html">api</a><ul class='methods'><li data-type='method'><a href="api.html#.generateEndpointURL">generateEndpointURL</a></li></ul></li><li><a href="auth.html">auth</a><ul class='methods'><li data-type='method'><a href="auth.html#.changeOrganisation">changeOrganisation</a></li><li data-type='method'><a href="auth.html#.ensureValidToken">ensureValidToken</a></li><li data-type='method'><a href="auth.html#.getCurrentToken">getCurrentToken</a></li><li data-type='method'><a href="auth.html#.getCurrentUser">getCurrentUser</a></li><li data-type='method'><a href="auth.html#.impersonate">impersonate</a></li><li data-type='method'><a href="auth.html#.login">login</a></li><li data-type='method'><a href="auth.html#.logout">logout</a></li><li data-type='method'><a href="auth.html#.retrieveUserFromResetToken">retrieveUserFromResetToken</a></li><li data-type='method'><a href="auth.html#.sendResetPasswordRequest">sendResetPasswordRequest</a></li><li data-type='method'><a href="auth.html#.set">set</a></li><li data-type='method'><a href="auth.html#.sync">sync</a></li><li data-type='method'><a href="auth.html#.updateUserWithToken">updateUserWithToken</a></li></ul></li><li><a href="cache.html">cache</a><ul class='methods'><li data-type='method'><a href="cache.html#.get">get</a></li><li data-type='method'><a href="cache.html#.reset">reset</a></li></ul></li><li><a href="content.html">content</a><ul class='methods'><li data-type='method'><a href="content.html#.create">create</a></li><li data-type='method'><a href="content.html#.delete">delete</a></li><li data-type='method'><a href="content.html#.get">get</a></li><li data-type='method'><a href="content.html#.getFromSlug">getFromSlug</a></li><li data-type='method'><a href="content.html#.glossary">glossary</a></li><li data-type='method'><a href="content.html#.list">list</a></li><li data-type='method'><a href="content.html#.patch">patch</a></li><li data-type='method'><a href="content.html#.restore">restore</a></li><li data-type='method'><a href="content.html#.scopeGlossary">scopeGlossary</a></li><li data-type='method'><a href="content.html#.update">update</a></li><li data-type='method'><a href="content.html#.validateField">validateField</a></li><li data-type='method'><a href="content.html#.variables">variables</a></li></ul></li><li><a href="files.html">files</a><ul class='methods'><li data-type='method'><a href="files.html#.downloadUrl">downloadUrl</a></li><li data-type='method'><a href="files.html#.duration">duration</a></li><li data-type='method'><a href="files.html#.filesize">filesize</a></li><li data-type='method'><a href="files.html#.getBinaryTypeFromMime">getBinaryTypeFromMime</a></li><li data-type='method'><a href="files.html#.mediaUrl">mediaUrl</a></li></ul></li><li><a href="filter.html">filter</a><ul class='methods'><li data-type='method'><a href="filter.html#.activeFilterComparators">activeFilterComparators</a></li><li data-type='method'><a href="filter.html#.activeFilterKeys">activeFilterKeys</a></li><li data-type='method'><a href="filter.html#.activeFilterOperators">activeFilterOperators</a></li><li data-type='method'><a href="filter.html#.activeFilters">activeFilters</a></li><li data-type='method'><a href="filter.html#.activeFilterValues">activeFilterValues</a></li><li data-type='method'><a href="filter.html#.filterChangeString">filterChangeString</a></li><li data-type='method'><a href="filter.html#.isValidFilter">isValidFilter</a></li></ul></li><li><a href="geo.html">geo</a><ul class='methods'><li data-type='method'><a href="geo.html#.distance">distance</a></li><li data-type='method'><a href="geo.html#.getDefaultCountry">getDefaultCountry</a></li><li data-type='method'><a href="geo.html#.getDefaultTimezone">getDefaultTimezone</a></li><li data-type='method'><a href="geo.html#.getPosition">getPosition</a></li><li data-type='method'><a href="geo.html#.stopWatchPosition">stopWatchPosition</a></li><li data-type='method'><a href="geo.html#.watchPosition">watchPosition</a></li></ul></li><li><a href="module-QikStorage-CookieStorageAdapter.html">CookieStorageAdapter</a><ul class='methods'><li data-type='method'><a href="module-QikStorage-CookieStorageAdapter.html#getCookieOptions">getCookieOptions</a></li><li data-type='method'><a href="module-QikStorage-CookieStorageAdapter.html#isCookieMode">isCookieMode</a></li></ul></li><li><a href="module-QikStorage-LocalStorageAdapter.html">LocalStorageAdapter</a></li><li><a href="module-QikStorage-StorageAdapter.html">StorageAdapter</a><ul class='methods'><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#clearUser">clearUser</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#getAccessToken">getAccessToken</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#getRefreshToken">getRefreshToken</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#getTokenExpiry">getTokenExpiry</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#getUser">getUser</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#isAvailable">isAvailable</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#setUser">setUser</a></li></ul></li><li><a href="socket.html">socket</a><ul class='methods'><li data-type='method'><a href="socket.html#.channel">channel</a></li><li data-type='method'><a href="socket.html#.close">close</a></li><li data-type='method'><a href="socket.html#.connect">connect</a></li><li data-type='method'><a href="socket.html#.reconnect">reconnect</a></li><li data-type='method'><a href="socket.html#.subscribe">subscribe</a></li><li data-type='method'><a href="socket.html#.unsubscribe">unsubscribe</a></li></ul></li><li><a href="system.html">system</a><ul class='methods'><li data-type='method'><a href="system.html#.countries">countries</a></li></ul></li><li><a href="utils.html">utils</a><ul class='methods'><li data-type='method'><a href="utils.html#.cleanValue">cleanValue</a></li><li data-type='method'><a href="utils.html#.comma">comma</a></li><li data-type='method'><a href="utils.html#.errorMessage">errorMessage</a></li><li data-type='method'><a href="utils.html#.exists">exists</a></li><li data-type='method'><a href="utils.html#.extractFromArray">extractFromArray</a></li><li data-type='method'><a href="utils.html#.formatCurrency">formatCurrency</a></li><li data-type='method'><a href="utils.html#.getTypeFromID">getTypeFromID</a></li><li data-type='method'><a href="utils.html#.guid">guid</a></li><li data-type='method'><a href="utils.html#.hash">hash</a></li><li data-type='method'><a href="utils.html#.id">id</a></li><li data-type='method'><a href="utils.html#.ids">ids</a></li><li data-type='method'><a href="utils.html#.isValidEmailAddress">isValidEmailAddress</a></li><li data-type='method'><a href="utils.html#.loadExternalScript">loadExternalScript</a></li><li data-type='method'><a href="utils.html#.loadExternalStyle">loadExternalStyle</a></li><li data-type='method'><a href="utils.html#.machineName">machineName</a></li><li data-type='method'><a href="utils.html#.mapParameters">mapParameters</a></li><li data-type='method'><a href="utils.html#.matchInArray">matchInArray</a></li><li data-type='method'><a href="utils.html#.parseBoolean">parseBoolean</a></li><li data-type='method'><a href="utils.html#.parseDate">parseDate</a></li><li data-type='method'><a href="utils.html#.parseEmail">parseEmail</a></li><li data-type='method'><a href="utils.html#.parseInt">parseInt</a></li><li data-type='method'><a href="utils.html#.parseNumber">parseNumber</a></li><li data-type='method'><a href="utils.html#.parseURL">parseURL</a></li></ul></li></ul><h3>Modules</h3><ul><li><a href="module-QikStorage.html">QikStorage</a><ul class='methods'><li data-type='method'><a href="module-QikStorage.html#.createStorageAdapter">createStorageAdapter</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#EventDispatcher">EventDispatcher</a></li></ul>
|
|
31
|
+
</nav>
|
|
32
|
+
|
|
33
|
+
<div id="main">
|
|
34
|
+
|
|
35
|
+
<h1 class="page-title">cache</h1>
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
<section>
|
|
44
|
+
|
|
45
|
+
<header>
|
|
46
|
+
|
|
47
|
+
<h2>
|
|
48
|
+
cache
|
|
49
|
+
</h2>
|
|
50
|
+
|
|
51
|
+
<div class="class-description usertext">A static service that provides tools for caching api requests and other information</div>
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
</header>
|
|
55
|
+
|
|
56
|
+
<article>
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
<h3 class="subsection-title">Methods</h3>
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
<h4 class="name" id=".get"><span class="type-signature">(static) </span>get<span class="signature">(key)</span><span class="type-signature"> → {LRUCache}</span></h4>
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
<dl class="details">
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
<dt class="tag-source">Source:</dt>
|
|
92
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
93
|
+
<a href="qik.cache.js.html">qik.cache.js</a>, <a href="qik.cache.js.html#line42">line 42</a>
|
|
94
|
+
</li></ul></dd>
|
|
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
|
+
</dl>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
<div class="description usertext">
|
|
133
|
+
A helper function to retrieve a specific cache
|
|
134
|
+
</div>
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
<h5>Parameters:</h5>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
<table class="params">
|
|
150
|
+
<thead>
|
|
151
|
+
<tr>
|
|
152
|
+
|
|
153
|
+
<th>Name</th>
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
<th>Type</th>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
<th class="last">Description</th>
|
|
163
|
+
</tr>
|
|
164
|
+
</thead>
|
|
165
|
+
|
|
166
|
+
<tbody>
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
<tr>
|
|
170
|
+
|
|
171
|
+
<td class="name"><code>key</code></td>
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
<td class="type">
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
<span class="param-type">string</span>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
</td>
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
<td class="description last">The key for the cache you want to retrieve</td>
|
|
188
|
+
</tr>
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
</tbody>
|
|
192
|
+
</table>
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
<h5>Returns:</h5>
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
<div class="param-desc">
|
|
213
|
+
The cache store for the specified key
|
|
214
|
+
</div>
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
<dl class="param-type">
|
|
219
|
+
<dt>
|
|
220
|
+
Type
|
|
221
|
+
</dt>
|
|
222
|
+
<dd>
|
|
223
|
+
|
|
224
|
+
<span class="param-type">LRUCache</span>
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
</dd>
|
|
228
|
+
</dl>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
<h4 class="name" id=".reset"><span class="type-signature">(static) </span>reset<span class="signature">()</span><span class="type-signature"></span></h4>
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
<dl class="details">
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
<dt class="tag-source">Source:</dt>
|
|
250
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
251
|
+
<a href="qik.cache.js.html">qik.cache.js</a>, <a href="qik.cache.js.html#line24">line 24</a>
|
|
252
|
+
</li></ul></dd>
|
|
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
|
+
</dl>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
<div class="description usertext">
|
|
291
|
+
A helper function to reset all caches, useful if changing organisation or logging in or out as another user
|
|
292
|
+
</div>
|
|
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
|
+
</article>
|
|
328
|
+
|
|
329
|
+
</section>
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
</div>
|
|
337
|
+
|
|
338
|
+
<br class="clear">
|
|
339
|
+
|
|
340
|
+
<footer>
|
|
341
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Mon Jul 13 2026 18:47:22 GMT+1000 (Australian Eastern Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
342
|
+
</footer>
|
|
343
|
+
|
|
344
|
+
<script>prettyPrint();</script>
|
|
345
|
+
<script src="scripts/polyfill.js"></script>
|
|
346
|
+
<script src="scripts/linenumber.js"></script>
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
</body>
|
|
351
|
+
</html>
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
|
|
28
28
|
<nav >
|
|
29
29
|
|
|
30
|
-
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="access.html">access</a><ul class='methods'><li data-type='method'><a href="access.html#.actionableScopes">actionableScopes</a></li><li data-type='method'><a href="access.html#.allPermissions">allPermissions</a></li><li data-type='method'><a href="access.html#.allPermissionTypes">allPermissionTypes</a></li><li data-type='method'><a href="access.html#.allUserScopes">allUserScopes</a></li><li data-type='method'><a href="access.html#.canCreate">canCreate</a></li><li data-type='method'><a href="access.html#.canDeleteItem">canDeleteItem</a></li><li data-type='method'><a href="access.html#.canEditItem">canEditItem</a></li><li data-type='method'><a href="access.html#.canEraseItem">canEraseItem</a></li><li data-type='method'><a href="access.html#.canKnowOf">canKnowOf</a></li><li data-type='method'><a href="access.html#.canListItem">canListItem</a></li><li data-type='method'><a href="access.html#.canRestoreItem">canRestoreItem</a></li><li data-type='method'><a href="access.html#.canViewItem">canViewItem</a></li><li data-type='method'><a href="access.html#.checkActionAccess">checkActionAccess</a></li><li data-type='method'><a href="access.html#.getAllDescendants">getAllDescendants</a></li><li data-type='method'><a href="access.html#.has">has</a></li><li data-type='method'><a href="access.html#.
|
|
30
|
+
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="access.html">access</a><ul class='methods'><li data-type='method'><a href="access.html#.actionableScopes">actionableScopes</a></li><li data-type='method'><a href="access.html#.allPermissions">allPermissions</a></li><li data-type='method'><a href="access.html#.allPermissionTypes">allPermissionTypes</a></li><li data-type='method'><a href="access.html#.allUserScopes">allUserScopes</a></li><li data-type='method'><a href="access.html#.canCreate">canCreate</a></li><li data-type='method'><a href="access.html#.canDeleteItem">canDeleteItem</a></li><li data-type='method'><a href="access.html#.canEditItem">canEditItem</a></li><li data-type='method'><a href="access.html#.canEraseItem">canEraseItem</a></li><li data-type='method'><a href="access.html#.canKnowOf">canKnowOf</a></li><li data-type='method'><a href="access.html#.canListItem">canListItem</a></li><li data-type='method'><a href="access.html#.canRestoreItem">canRestoreItem</a></li><li data-type='method'><a href="access.html#.canViewItem">canViewItem</a></li><li data-type='method'><a href="access.html#.checkActionAccess">checkActionAccess</a></li><li data-type='method'><a href="access.html#.getAllDescendants">getAllDescendants</a></li><li data-type='method'><a href="access.html#.has">has</a></li><li data-type='method'><a href="access.html#.hasFeature">hasFeature</a></li><li data-type='method'><a href="access.html#.hashPermissions">hashPermissions</a></li><li data-type='method'><a href="access.html#.isAdministrator">isAdministrator</a></li><li data-type='method'><a href="access.html#.isAssignee">isAssignee</a></li><li data-type='method'><a href="access.html#.isOwner">isOwner</a></li></ul></li><li><a href="api.html">api</a><ul class='methods'><li data-type='method'><a href="api.html#.generateEndpointURL">generateEndpointURL</a></li></ul></li><li><a href="auth.html">auth</a><ul class='methods'><li data-type='method'><a href="auth.html#.changeOrganisation">changeOrganisation</a></li><li data-type='method'><a href="auth.html#.ensureValidToken">ensureValidToken</a></li><li data-type='method'><a href="auth.html#.getCurrentToken">getCurrentToken</a></li><li data-type='method'><a href="auth.html#.getCurrentUser">getCurrentUser</a></li><li data-type='method'><a href="auth.html#.impersonate">impersonate</a></li><li data-type='method'><a href="auth.html#.login">login</a></li><li data-type='method'><a href="auth.html#.logout">logout</a></li><li data-type='method'><a href="auth.html#.retrieveUserFromResetToken">retrieveUserFromResetToken</a></li><li data-type='method'><a href="auth.html#.sendResetPasswordRequest">sendResetPasswordRequest</a></li><li data-type='method'><a href="auth.html#.set">set</a></li><li data-type='method'><a href="auth.html#.sync">sync</a></li><li data-type='method'><a href="auth.html#.updateUserWithToken">updateUserWithToken</a></li></ul></li><li><a href="cache.html">cache</a><ul class='methods'><li data-type='method'><a href="cache.html#.get">get</a></li><li data-type='method'><a href="cache.html#.reset">reset</a></li></ul></li><li><a href="content.html">content</a><ul class='methods'><li data-type='method'><a href="content.html#.create">create</a></li><li data-type='method'><a href="content.html#.delete">delete</a></li><li data-type='method'><a href="content.html#.get">get</a></li><li data-type='method'><a href="content.html#.getFromSlug">getFromSlug</a></li><li data-type='method'><a href="content.html#.glossary">glossary</a></li><li data-type='method'><a href="content.html#.list">list</a></li><li data-type='method'><a href="content.html#.patch">patch</a></li><li data-type='method'><a href="content.html#.restore">restore</a></li><li data-type='method'><a href="content.html#.scopeGlossary">scopeGlossary</a></li><li data-type='method'><a href="content.html#.update">update</a></li><li data-type='method'><a href="content.html#.validateField">validateField</a></li><li data-type='method'><a href="content.html#.variables">variables</a></li></ul></li><li><a href="files.html">files</a><ul class='methods'><li data-type='method'><a href="files.html#.downloadUrl">downloadUrl</a></li><li data-type='method'><a href="files.html#.duration">duration</a></li><li data-type='method'><a href="files.html#.filesize">filesize</a></li><li data-type='method'><a href="files.html#.getBinaryTypeFromMime">getBinaryTypeFromMime</a></li><li data-type='method'><a href="files.html#.mediaUrl">mediaUrl</a></li></ul></li><li><a href="filter.html">filter</a><ul class='methods'><li data-type='method'><a href="filter.html#.activeFilterComparators">activeFilterComparators</a></li><li data-type='method'><a href="filter.html#.activeFilterKeys">activeFilterKeys</a></li><li data-type='method'><a href="filter.html#.activeFilterOperators">activeFilterOperators</a></li><li data-type='method'><a href="filter.html#.activeFilters">activeFilters</a></li><li data-type='method'><a href="filter.html#.activeFilterValues">activeFilterValues</a></li><li data-type='method'><a href="filter.html#.filterChangeString">filterChangeString</a></li><li data-type='method'><a href="filter.html#.isValidFilter">isValidFilter</a></li></ul></li><li><a href="geo.html">geo</a><ul class='methods'><li data-type='method'><a href="geo.html#.distance">distance</a></li><li data-type='method'><a href="geo.html#.getDefaultCountry">getDefaultCountry</a></li><li data-type='method'><a href="geo.html#.getDefaultTimezone">getDefaultTimezone</a></li><li data-type='method'><a href="geo.html#.getPosition">getPosition</a></li><li data-type='method'><a href="geo.html#.stopWatchPosition">stopWatchPosition</a></li><li data-type='method'><a href="geo.html#.watchPosition">watchPosition</a></li></ul></li><li><a href="module-QikStorage-CookieStorageAdapter.html">CookieStorageAdapter</a><ul class='methods'><li data-type='method'><a href="module-QikStorage-CookieStorageAdapter.html#getCookieOptions">getCookieOptions</a></li><li data-type='method'><a href="module-QikStorage-CookieStorageAdapter.html#isCookieMode">isCookieMode</a></li></ul></li><li><a href="module-QikStorage-LocalStorageAdapter.html">LocalStorageAdapter</a></li><li><a href="module-QikStorage-StorageAdapter.html">StorageAdapter</a><ul class='methods'><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#clearUser">clearUser</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#getAccessToken">getAccessToken</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#getRefreshToken">getRefreshToken</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#getTokenExpiry">getTokenExpiry</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#getUser">getUser</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#isAvailable">isAvailable</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#setUser">setUser</a></li></ul></li><li><a href="socket.html">socket</a><ul class='methods'><li data-type='method'><a href="socket.html#.channel">channel</a></li><li data-type='method'><a href="socket.html#.close">close</a></li><li data-type='method'><a href="socket.html#.connect">connect</a></li><li data-type='method'><a href="socket.html#.reconnect">reconnect</a></li><li data-type='method'><a href="socket.html#.subscribe">subscribe</a></li><li data-type='method'><a href="socket.html#.unsubscribe">unsubscribe</a></li></ul></li><li><a href="system.html">system</a><ul class='methods'><li data-type='method'><a href="system.html#.countries">countries</a></li></ul></li><li><a href="utils.html">utils</a><ul class='methods'><li data-type='method'><a href="utils.html#.cleanValue">cleanValue</a></li><li data-type='method'><a href="utils.html#.comma">comma</a></li><li data-type='method'><a href="utils.html#.errorMessage">errorMessage</a></li><li data-type='method'><a href="utils.html#.exists">exists</a></li><li data-type='method'><a href="utils.html#.extractFromArray">extractFromArray</a></li><li data-type='method'><a href="utils.html#.formatCurrency">formatCurrency</a></li><li data-type='method'><a href="utils.html#.getTypeFromID">getTypeFromID</a></li><li data-type='method'><a href="utils.html#.guid">guid</a></li><li data-type='method'><a href="utils.html#.hash">hash</a></li><li data-type='method'><a href="utils.html#.id">id</a></li><li data-type='method'><a href="utils.html#.ids">ids</a></li><li data-type='method'><a href="utils.html#.isValidEmailAddress">isValidEmailAddress</a></li><li data-type='method'><a href="utils.html#.loadExternalScript">loadExternalScript</a></li><li data-type='method'><a href="utils.html#.loadExternalStyle">loadExternalStyle</a></li><li data-type='method'><a href="utils.html#.machineName">machineName</a></li><li data-type='method'><a href="utils.html#.mapParameters">mapParameters</a></li><li data-type='method'><a href="utils.html#.matchInArray">matchInArray</a></li><li data-type='method'><a href="utils.html#.parseBoolean">parseBoolean</a></li><li data-type='method'><a href="utils.html#.parseDate">parseDate</a></li><li data-type='method'><a href="utils.html#.parseEmail">parseEmail</a></li><li data-type='method'><a href="utils.html#.parseInt">parseInt</a></li><li data-type='method'><a href="utils.html#.parseNumber">parseNumber</a></li><li data-type='method'><a href="utils.html#.parseURL">parseURL</a></li></ul></li></ul><h3>Modules</h3><ul><li><a href="module-QikStorage.html">QikStorage</a><ul class='methods'><li data-type='method'><a href="module-QikStorage.html#.createStorageAdapter">createStorageAdapter</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#EventDispatcher">EventDispatcher</a></li></ul>
|
|
31
31
|
</nav>
|
|
32
32
|
|
|
33
33
|
<div id="main">
|
|
@@ -82,7 +82,7 @@
|
|
|
82
82
|
|
|
83
83
|
<dt class="tag-source">Source:</dt>
|
|
84
84
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
85
|
-
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#
|
|
85
|
+
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#line248">line 248</a>
|
|
86
86
|
</li></ul></dd>
|
|
87
87
|
|
|
88
88
|
|
|
@@ -162,7 +162,7 @@ console.log(hash) // {equal:[{title:'Is equal to', operator:'equal'...}]}</code>
|
|
|
162
162
|
|
|
163
163
|
<dt class="tag-source">Source:</dt>
|
|
164
164
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
165
|
-
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#
|
|
165
|
+
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#line751">line 751</a>
|
|
166
166
|
</li></ul></dd>
|
|
167
167
|
|
|
168
168
|
|
|
@@ -333,7 +333,7 @@ console.log(hash) // {equal:[{title:'Is equal to', operator:'equal'...}]}</code>
|
|
|
333
333
|
|
|
334
334
|
<dt class="tag-source">Source:</dt>
|
|
335
335
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
336
|
-
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#
|
|
336
|
+
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#line850">line 850</a>
|
|
337
337
|
</li></ul></dd>
|
|
338
338
|
|
|
339
339
|
|
|
@@ -474,7 +474,7 @@ console.log(hash) // {equal:[{title:'Is equal to', operator:'equal'...}]}</code>
|
|
|
474
474
|
|
|
475
475
|
<dt class="tag-source">Source:</dt>
|
|
476
476
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
477
|
-
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#
|
|
477
|
+
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#line830">line 830</a>
|
|
478
478
|
</li></ul></dd>
|
|
479
479
|
|
|
480
480
|
|
|
@@ -615,7 +615,7 @@ console.log(hash) // {equal:[{title:'Is equal to', operator:'equal'...}]}</code>
|
|
|
615
615
|
|
|
616
616
|
<dt class="tag-source">Source:</dt>
|
|
617
617
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
618
|
-
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#
|
|
618
|
+
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#line882">line 882</a>
|
|
619
619
|
</li></ul></dd>
|
|
620
620
|
|
|
621
621
|
|
|
@@ -717,7 +717,7 @@ const result = await sdk.content.getFromSlug('article:toyota-landcruiser')</code
|
|
|
717
717
|
|
|
718
718
|
|
|
719
719
|
<td class="description last">The slug id of the record we want to retrieve
|
|
720
|
-
it must be provided as either `(type):(slug)`` or `(definition):(slug)`
|
|
720
|
+
it must be provided as either `(type):(slug)`` or `(definition):(slug)`
|
|
721
721
|
(if unsure use the `meta.abs` absolute slug property of the item you are wanting to retrieve).</td>
|
|
722
722
|
</tr>
|
|
723
723
|
|
|
@@ -760,7 +760,7 @@ it must be provided as either `(type):(slug)`` or `(definition):(slug)`
|
|
|
760
760
|
|
|
761
761
|
<dt class="tag-source">Source:</dt>
|
|
762
762
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
763
|
-
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#
|
|
763
|
+
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#line136">line 136</a>
|
|
764
764
|
</li></ul></dd>
|
|
765
765
|
|
|
766
766
|
|
|
@@ -800,7 +800,7 @@ it must be provided as either `(type):(slug)`` or `(definition):(slug)`
|
|
|
800
800
|
|
|
801
801
|
|
|
802
802
|
<div class="description usertext">
|
|
803
|
-
Retrieves the glossary of all content types visible to the requesting user.
|
|
803
|
+
Retrieves the glossary of all content types visible to the requesting user.
|
|
804
804
|
By default this will include all fields, validation, expressions and other configuration
|
|
805
805
|
</div>
|
|
806
806
|
|
|
@@ -814,7 +814,9 @@ it must be provided as either `(type):(slug)`` or `(definition):(slug)`
|
|
|
814
814
|
|
|
815
815
|
<h5>Example</h5>
|
|
816
816
|
|
|
817
|
-
<pre class="prettyprint"><code>const { article, profile } = await sdk.content.glossary({hash:true})
|
|
817
|
+
<pre class="prettyprint"><code>const { article, profile } = await sdk.content.glossary({hash:true});
|
|
818
|
+
// Use compressed endpoint for faster loading
|
|
819
|
+
const glossary = await sdk.content.glossary({compressed:true});</code></pre>
|
|
818
820
|
|
|
819
821
|
|
|
820
822
|
|
|
@@ -902,7 +904,7 @@ it must be provided as either `(type):(slug)`` or `(definition):(slug)`
|
|
|
902
904
|
|
|
903
905
|
|
|
904
906
|
|
|
905
|
-
<td class="description last">Whether to return the data as a keyed object
|
|
907
|
+
<td class="description last">Whether to return the data as a keyed object
|
|
906
908
|
allowing for fast selection of specific content types, by default will return as an array</td>
|
|
907
909
|
</tr>
|
|
908
910
|
|
|
@@ -931,6 +933,29 @@ it must be provided as either `(type):(slug)`` or `(definition):(slug)`
|
|
|
931
933
|
</tr>
|
|
932
934
|
|
|
933
935
|
|
|
936
|
+
|
|
937
|
+
<tr>
|
|
938
|
+
|
|
939
|
+
<td class="name"><code>uncompressed</code></td>
|
|
940
|
+
|
|
941
|
+
|
|
942
|
+
<td class="type">
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
<span class="param-type">Boolean</span>
|
|
946
|
+
|
|
947
|
+
|
|
948
|
+
|
|
949
|
+
</td>
|
|
950
|
+
|
|
951
|
+
|
|
952
|
+
|
|
953
|
+
|
|
954
|
+
|
|
955
|
+
<td class="description last">Use the uncompressed endpoint</td>
|
|
956
|
+
</tr>
|
|
957
|
+
|
|
958
|
+
|
|
934
959
|
</tbody>
|
|
935
960
|
</table>
|
|
936
961
|
|
|
@@ -976,7 +1001,7 @@ it must be provided as either `(type):(slug)`` or `(definition):(slug)`
|
|
|
976
1001
|
|
|
977
1002
|
<dt class="tag-source">Source:</dt>
|
|
978
1003
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
979
|
-
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#
|
|
1004
|
+
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#line700">line 700</a>
|
|
980
1005
|
</li></ul></dd>
|
|
981
1006
|
|
|
982
1007
|
|
|
@@ -1444,7 +1469,7 @@ it must be provided as either `(type):(slug)`` or `(definition):(slug)`
|
|
|
1444
1469
|
|
|
1445
1470
|
<dt class="tag-source">Source:</dt>
|
|
1446
1471
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1447
|
-
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#
|
|
1472
|
+
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#line807">line 807</a>
|
|
1448
1473
|
</li></ul></dd>
|
|
1449
1474
|
|
|
1450
1475
|
|
|
@@ -1611,7 +1636,7 @@ it must be provided as either `(type):(slug)`` or `(definition):(slug)`
|
|
|
1611
1636
|
|
|
1612
1637
|
<dt class="tag-source">Source:</dt>
|
|
1613
1638
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1614
|
-
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#
|
|
1639
|
+
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#line864">line 864</a>
|
|
1615
1640
|
</li></ul></dd>
|
|
1616
1641
|
|
|
1617
1642
|
|
|
@@ -1752,7 +1777,7 @@ it must be provided as either `(type):(slug)`` or `(definition):(slug)`
|
|
|
1752
1777
|
|
|
1753
1778
|
<dt class="tag-source">Source:</dt>
|
|
1754
1779
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1755
|
-
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#
|
|
1780
|
+
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#line206">line 206</a>
|
|
1756
1781
|
</li></ul></dd>
|
|
1757
1782
|
|
|
1758
1783
|
|
|
@@ -1967,7 +1992,7 @@ it must be provided as either `(type):(slug)`` or `(definition):(slug)`
|
|
|
1967
1992
|
|
|
1968
1993
|
<dt class="tag-source">Source:</dt>
|
|
1969
1994
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1970
|
-
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#
|
|
1995
|
+
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#line780">line 780</a>
|
|
1971
1996
|
</li></ul></dd>
|
|
1972
1997
|
|
|
1973
1998
|
|
|
@@ -2138,7 +2163,7 @@ it must be provided as either `(type):(slug)`` or `(definition):(slug)`
|
|
|
2138
2163
|
|
|
2139
2164
|
<dt class="tag-source">Source:</dt>
|
|
2140
2165
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2141
|
-
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#
|
|
2166
|
+
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#line352">line 352</a>
|
|
2142
2167
|
</li></ul></dd>
|
|
2143
2168
|
|
|
2144
2169
|
|
|
@@ -2192,11 +2217,11 @@ it must be provided as either `(type):(slug)`` or `(definition):(slug)`
|
|
|
2192
2217
|
<h5>Example</h5>
|
|
2193
2218
|
|
|
2194
2219
|
<pre class="prettyprint"><code>const validationResult = await sdk.content.validateField('Johnny Bobbins', {title:'Name', key:'firstName', type:'string', minimum:1, maximum:1, ...});
|
|
2195
|
-
console.log(validationResult)
|
|
2220
|
+
console.log(validationResult)
|
|
2196
2221
|
// Results in { valid:true }
|
|
2197
2222
|
|
|
2198
2223
|
const validationResult = await sdk.content.validateField('Johnny Bobbins', {title:'Number', key:'number', type:'integer', minimum:1, maximum:1, ...});
|
|
2199
|
-
console.log(validationResult)
|
|
2224
|
+
console.log(validationResult)
|
|
2200
2225
|
// Results in { valid:false, status:400, message:'Invalid number input for field' }</code></pre>
|
|
2201
2226
|
|
|
2202
2227
|
|
|
@@ -2331,7 +2356,7 @@ console.log(validationResult)
|
|
|
2331
2356
|
|
|
2332
2357
|
<dt class="tag-source">Source:</dt>
|
|
2333
2358
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2334
|
-
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#
|
|
2359
|
+
<a href="qik.content.js.html">qik.content.js</a>, <a href="qik.content.js.html#line40">line 40</a>
|
|
2335
2360
|
</li></ul></dd>
|
|
2336
2361
|
|
|
2337
2362
|
|
|
@@ -2547,7 +2572,7 @@ console.log(validationResult)
|
|
|
2547
2572
|
<br class="clear">
|
|
2548
2573
|
|
|
2549
2574
|
<footer>
|
|
2550
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
|
|
2575
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Mon Jul 13 2026 18:47:22 GMT+1000 (Australian Eastern Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
2551
2576
|
</footer>
|
|
2552
2577
|
|
|
2553
2578
|
<script>prettyPrint();</script>
|