@eui/core 16.2.1 → 17.0.0-next.2

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.
Files changed (222) hide show
  1. package/esm2022/lib/eui-core.module.mjs +5 -5
  2. package/esm2022/lib/interceptors/add-lang-param.interceptor.mjs +4 -4
  3. package/esm2022/lib/interceptors/cache-prevention.interceptor.mjs +4 -4
  4. package/esm2022/lib/interceptors/cors-security.interceptor.mjs +4 -4
  5. package/esm2022/lib/interceptors/csrf-prevention.interceptor.mjs +4 -4
  6. package/esm2022/lib/interceptors/eu-login-session-timeout-handling.interceptor.mjs +4 -4
  7. package/esm2022/lib/interceptors/openid/openid-connect.interceptor.mjs +4 -4
  8. package/esm2022/lib/interceptors/openid/openid-connect.service.mjs +4 -4
  9. package/esm2022/lib/interceptors/ux-request-error-model.interceptor.mjs +4 -4
  10. package/esm2022/lib/services/dynamic-menu/dynamic-menu.service.mjs +66 -0
  11. package/esm2022/lib/services/errors/global-error-handler.mjs +4 -4
  12. package/esm2022/lib/services/errors/http-error-handler-callback-functions.mjs +5 -4
  13. package/esm2022/lib/services/errors/http-error-handler.interceptor.mjs +4 -4
  14. package/esm2022/lib/services/eui-timezone.service.mjs +716 -0
  15. package/esm2022/lib/services/i18n/i18n.loader.mjs +4 -4
  16. package/esm2022/lib/services/i18n/i18n.service.mjs +8 -8
  17. package/esm2022/lib/services/i18n/i18n.service.mock.mjs +4 -4
  18. package/esm2022/lib/services/index.mjs +3 -3
  19. package/esm2022/lib/services/locale/locale.service.mjs +4 -4
  20. package/esm2022/lib/services/locale/locale.service.mock.mjs +4 -4
  21. package/esm2022/lib/services/log/log.module.mjs +5 -5
  22. package/esm2022/lib/services/log/log.service.mjs +4 -4
  23. package/esm2022/lib/services/permission/permission.service.mjs +5 -5
  24. package/esm2022/lib/services/queue/api-queue.service.mjs +4 -4
  25. package/esm2022/lib/services/storage/local-forage.service.mjs +4 -4
  26. package/esm2022/lib/services/storage/local-storage.service.mjs +4 -4
  27. package/esm2022/lib/services/storage/session-storage.service.mjs +4 -4
  28. package/esm2022/lib/services/store/actions/user.actions.mjs +1 -1
  29. package/esm2022/lib/services/store/effects/app.effects.mjs +16 -6
  30. package/esm2022/lib/services/store/store.service.mjs +4 -4
  31. package/esm2022/lib/services/store/store.service.mock.mjs +4 -4
  32. package/esm2022/lib/services/user/user.service.mjs +4 -4
  33. package/esm2022/lib/services/user/user.service.mock.mjs +4 -4
  34. package/esm2022/lib/services/ux-app-shell.service.mjs +6 -152
  35. package/esm2022/lib/services/ux-dynamic-component/ux-dynamic-component.service.mjs +4 -4
  36. package/esm2022/lib/services/ux-error-feedback/ux-error-feedback.service.mjs +29 -20
  37. package/fesm2022/eui-core.mjs +158 -284
  38. package/fesm2022/eui-core.mjs.map +1 -1
  39. package/lib/services/dynamic-menu/dynamic-menu.service.d.ts +15 -0
  40. package/lib/services/dynamic-menu/dynamic-menu.service.d.ts.map +1 -0
  41. package/lib/services/errors/http-error-handler-callback-functions.d.ts.map +1 -1
  42. package/lib/services/{ux-timezone.service.d.ts → eui-timezone.service.d.ts} +9 -9
  43. package/lib/services/eui-timezone.service.d.ts.map +1 -0
  44. package/lib/services/index.d.ts +2 -2
  45. package/lib/services/index.d.ts.map +1 -1
  46. package/lib/services/permission/permission.service.d.ts +7 -7
  47. package/lib/services/permission/permission.service.d.ts.map +1 -1
  48. package/lib/services/store/actions/user.actions.d.ts +3 -3
  49. package/lib/services/store/actions/user.actions.d.ts.map +1 -1
  50. package/lib/services/store/effects/app.effects.d.ts.map +1 -1
  51. package/lib/services/ux-app-shell.service.d.ts +8 -31
  52. package/lib/services/ux-app-shell.service.d.ts.map +1 -1
  53. package/lib/services/ux-error-feedback/ux-error-feedback.service.d.ts.map +1 -1
  54. package/package.json +2 -2
  55. package/docs/classes/ActivatedRouteAction.html +0 -282
  56. package/docs/classes/AddApiQueueItemAction.html +0 -282
  57. package/docs/classes/AddAppLoadedConfigModulesAction.html +0 -282
  58. package/docs/classes/ApiQueueServiceMock.html +0 -553
  59. package/docs/classes/AsyncStorageService.html +0 -941
  60. package/docs/classes/AsyncStorageServiceMock.html +0 -427
  61. package/docs/classes/EmptyApiQueueAction.html +0 -282
  62. package/docs/classes/EuiCoreRootGuardClass.html +0 -167
  63. package/docs/classes/EuiError.html +0 -227
  64. package/docs/classes/I18nResourceImpl.html +0 -510
  65. package/docs/classes/InitStoreAction.html +0 -282
  66. package/docs/classes/LogServiceMock.html +0 -223
  67. package/docs/classes/OpenIdConnectServiceMock.html +0 -223
  68. package/docs/classes/RemoveApiQueueItemAction.html +0 -282
  69. package/docs/classes/RouterMock.html +0 -499
  70. package/docs/classes/StorageService.html +0 -640
  71. package/docs/classes/StorageServiceMock.html +0 -325
  72. package/docs/classes/StoreMock.html +0 -406
  73. package/docs/classes/TranslateServiceMock.html +0 -917
  74. package/docs/classes/UpdateAppConnectionAction.html +0 -282
  75. package/docs/classes/UpdateAppStatusAction.html +0 -282
  76. package/docs/classes/UpdateAppVersionAction.html +0 -282
  77. package/docs/classes/UpdateCurrentModuleAction.html +0 -282
  78. package/docs/classes/UpdateI18nStateAction.html +0 -282
  79. package/docs/classes/UpdateLocaleStateAction.html +0 -282
  80. package/docs/classes/UpdateNotificationsListAction.html +0 -282
  81. package/docs/classes/UpdateUserDashboardAction.html +0 -282
  82. package/docs/classes/UpdateUserDetailsAction.html +0 -282
  83. package/docs/classes/UpdateUserPreferencesAction.html +0 -282
  84. package/docs/classes/UpdateUserRightsAction.html +0 -282
  85. package/docs/classes/UpdateUserStateAction.html +0 -282
  86. package/docs/classes/UxErrorManager.html +0 -536
  87. package/docs/classes/UxRootInjectorGuard.html +0 -197
  88. package/docs/dependencies.html +0 -319
  89. package/docs/directives/TranslateMockDirective.html +0 -266
  90. package/docs/fonts/ionicons.eot +0 -0
  91. package/docs/fonts/ionicons.svg +0 -2090
  92. package/docs/fonts/ionicons.ttf +0 -0
  93. package/docs/fonts/ionicons.woff +0 -0
  94. package/docs/fonts/ionicons.woff2 +0 -0
  95. package/docs/fonts/roboto-v15-latin-300.eot +0 -0
  96. package/docs/fonts/roboto-v15-latin-300.svg +0 -314
  97. package/docs/fonts/roboto-v15-latin-300.ttf +0 -0
  98. package/docs/fonts/roboto-v15-latin-300.woff +0 -0
  99. package/docs/fonts/roboto-v15-latin-300.woff2 +0 -0
  100. package/docs/fonts/roboto-v15-latin-700.eot +0 -0
  101. package/docs/fonts/roboto-v15-latin-700.svg +0 -310
  102. package/docs/fonts/roboto-v15-latin-700.ttf +0 -0
  103. package/docs/fonts/roboto-v15-latin-700.woff +0 -0
  104. package/docs/fonts/roboto-v15-latin-700.woff2 +0 -0
  105. package/docs/fonts/roboto-v15-latin-italic.eot +0 -0
  106. package/docs/fonts/roboto-v15-latin-italic.svg +0 -323
  107. package/docs/fonts/roboto-v15-latin-italic.ttf +0 -0
  108. package/docs/fonts/roboto-v15-latin-italic.woff +0 -0
  109. package/docs/fonts/roboto-v15-latin-italic.woff2 +0 -0
  110. package/docs/fonts/roboto-v15-latin-regular.eot +0 -0
  111. package/docs/fonts/roboto-v15-latin-regular.svg +0 -308
  112. package/docs/fonts/roboto-v15-latin-regular.ttf +0 -0
  113. package/docs/fonts/roboto-v15-latin-regular.woff +0 -0
  114. package/docs/fonts/roboto-v15-latin-regular.woff2 +0 -0
  115. package/docs/images/compodoc-vectorise-inverted.png +0 -0
  116. package/docs/images/compodoc-vectorise-inverted.svg +0 -201
  117. package/docs/images/compodoc-vectorise.png +0 -0
  118. package/docs/images/compodoc-vectorise.svg +0 -201
  119. package/docs/images/favicon.ico +0 -0
  120. package/docs/index.html +0 -171
  121. package/docs/injectables/ApiQueueService.html +0 -806
  122. package/docs/injectables/CoreAppEffects.html +0 -390
  123. package/docs/injectables/EuiPermissionService.html +0 -652
  124. package/docs/injectables/GlobalErrorHandler.html +0 -293
  125. package/docs/injectables/I18nLoader.html +0 -597
  126. package/docs/injectables/I18nService.html +0 -945
  127. package/docs/injectables/I18nServiceMock.html +0 -634
  128. package/docs/injectables/LocalForageService.html +0 -773
  129. package/docs/injectables/LocalStorageService.html +0 -554
  130. package/docs/injectables/LocaleService.html +0 -799
  131. package/docs/injectables/LocaleServiceMock.html +0 -493
  132. package/docs/injectables/LogService.html +0 -354
  133. package/docs/injectables/OpenIdConnectService.html +0 -225
  134. package/docs/injectables/SessionStorageService.html +0 -554
  135. package/docs/injectables/StoreService.html +0 -651
  136. package/docs/injectables/StoreServiceMock.html +0 -457
  137. package/docs/injectables/UserService.html +0 -752
  138. package/docs/injectables/UserServiceMock.html +0 -641
  139. package/docs/injectables/UxAppShellService.html +0 -3338
  140. package/docs/injectables/UxDynamicComponentService.html +0 -437
  141. package/docs/injectables/UxDynamicMenuService.html +0 -379
  142. package/docs/injectables/UxErrorFeedbackService.html +0 -591
  143. package/docs/injectables/UxTimezoneService.html +0 -382
  144. package/docs/interceptors/AddLangParamInterceptor.html +0 -305
  145. package/docs/interceptors/CachePreventionInterceptor.html +0 -254
  146. package/docs/interceptors/CorsSecurityInterceptor.html +0 -254
  147. package/docs/interceptors/CsrfPreventionInterceptor.html +0 -254
  148. package/docs/interceptors/EuLoginSessionTimeoutHandlingInterceptor.html +0 -254
  149. package/docs/interceptors/HttpErrorHandlerInterceptor.html +0 -321
  150. package/docs/interceptors/OpenIdConnectInterceptor.html +0 -347
  151. package/docs/interceptors/UxRequestErrorModelInterceptor.html +0 -297
  152. package/docs/interfaces/LoadedResources.html +0 -292
  153. package/docs/interfaces/LoadedResourcesError.html +0 -247
  154. package/docs/interfaces/ModuleLoadEvent.html +0 -292
  155. package/docs/interfaces/OpenIdConnectUserDetails.html +0 -439
  156. package/docs/interfaces/ResourceError.html +0 -298
  157. package/docs/interfaces/TimeZone.html +0 -247
  158. package/docs/interfaces/UIState.html +0 -1900
  159. package/docs/js/compodoc.js +0 -14
  160. package/docs/js/lazy-load-graphs.js +0 -44
  161. package/docs/js/libs/EventDispatcher.js +0 -5
  162. package/docs/js/libs/bootstrap-native.js +0 -1
  163. package/docs/js/libs/clipboard.min.js +0 -7
  164. package/docs/js/libs/custom-elements-es5-adapter.js +0 -15
  165. package/docs/js/libs/custom-elements.min.js +0 -38
  166. package/docs/js/libs/d3.v3.min.js +0 -2
  167. package/docs/js/libs/deep-iterator.js +0 -2
  168. package/docs/js/libs/es6-shim.min.js +0 -11
  169. package/docs/js/libs/htmlparser.js +0 -23
  170. package/docs/js/libs/innersvg.js +0 -9
  171. package/docs/js/libs/lit-html.js +0 -1
  172. package/docs/js/libs/prism.js +0 -46
  173. package/docs/js/libs/promise.min.js +0 -6
  174. package/docs/js/libs/svg-pan-zoom.min.js +0 -3
  175. package/docs/js/libs/tablesort.min.js +0 -6
  176. package/docs/js/libs/tablesort.number.min.js +0 -6
  177. package/docs/js/libs/vis.min.js +0 -47
  178. package/docs/js/libs/zepto.min.js +0 -2
  179. package/docs/js/menu-wc.js +0 -380
  180. package/docs/js/menu.js +0 -325
  181. package/docs/js/routes.js +0 -301
  182. package/docs/js/search/lunr.min.js +0 -6
  183. package/docs/js/search/search-lunr.js +0 -67
  184. package/docs/js/search/search.js +0 -268
  185. package/docs/js/search/search_index.js +0 -4
  186. package/docs/js/sourceCode.js +0 -58
  187. package/docs/js/svg-pan-zoom.controls.js +0 -53
  188. package/docs/js/tabs.js +0 -21
  189. package/docs/js/tree.js +0 -147
  190. package/docs/license.html +0 -379
  191. package/docs/miscellaneous/enumerations.html +0 -418
  192. package/docs/miscellaneous/functions.html +0 -1864
  193. package/docs/miscellaneous/typealiases.html +0 -258
  194. package/docs/miscellaneous/variables.html +0 -3965
  195. package/docs/modules/CoreModule.html +0 -256
  196. package/docs/modules/I18nModule.html +0 -198
  197. package/docs/modules/LogModule.html +0 -305
  198. package/docs/modules/TranslateMockModule.html +0 -176
  199. package/docs/modules.html +0 -168
  200. package/docs/pipes/TranslateMockPipe.html +0 -227
  201. package/docs/properties.html +0 -124
  202. package/docs/styles/bootstrap-card.css +0 -219
  203. package/docs/styles/bootstrap.min.css +0 -6
  204. package/docs/styles/compodoc.css +0 -1121
  205. package/docs/styles/dark.css +0 -121
  206. package/docs/styles/ionicons.min.css +0 -11
  207. package/docs/styles/laravel.css +0 -113
  208. package/docs/styles/material.css +0 -131
  209. package/docs/styles/original.css +0 -51
  210. package/docs/styles/postmark.css +0 -238
  211. package/docs/styles/prism.css +0 -301
  212. package/docs/styles/readthedocs.css +0 -117
  213. package/docs/styles/reset.css +0 -129
  214. package/docs/styles/stripe.css +0 -106
  215. package/docs/styles/style.css +0 -7
  216. package/docs/styles/tablesort.css +0 -33
  217. package/docs/styles/vagrant.css +0 -130
  218. package/esm2022/lib/services/ux-dynamic-menu/ux-dynamic-menu.service.mjs +0 -66
  219. package/esm2022/lib/services/ux-timezone.service.mjs +0 -717
  220. package/lib/services/ux-dynamic-menu/ux-dynamic-menu.service.d.ts +0 -15
  221. package/lib/services/ux-dynamic-menu/ux-dynamic-menu.service.d.ts.map +0 -1
  222. package/lib/services/ux-timezone.service.d.ts.map +0 -1
package/docs/injectables/ApiQueueService.html DELETED
@@ -1,806 +0,0 @@
1
- <!doctype html>
2
- <html class="no-js" lang="">
3
- <head>
4
- <meta charset="utf-8">
5
- <meta http-equiv="x-ua-compatible" content="ie=edge">
6
- <title>csdr documentation</title>
7
- <meta name="description" content="">
8
- <meta name="viewport" content="width=device-width, initial-scale=1">
9
-
10
- <link rel="icon" type="image/x-icon" href="../images/favicon.ico">
11
- <link rel="stylesheet" href="../styles/style.css">
12
- <link rel="stylesheet" href="../styles/dark.css">
13
- <link rel="stylesheet" href="../styles/material.css">
14
- </head>
15
- <body>
16
-
17
- <div class="navbar navbar-default navbar-fixed-top d-block d-sm-none">
18
- <a href="../" class="navbar-brand">csdr documentation</a>
19
- <button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
20
- </div>
21
-
22
- <div class="xs-menu menu" id="mobile-menu">
23
- <div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
24
- </div>
25
-
26
- <div class="container-fluid main">
27
- <div class="row main">
28
- <div class="hidden-xs menu">
29
- <compodoc-menu mode="normal"></compodoc-menu>
30
- </div>
31
- <!-- START CONTENT -->
32
- <div class="content injectable">
33
- <div class="content-data">
34
-
35
-
36
-
37
-
38
-
39
-
40
-
41
-
42
- <ol class="breadcrumb">
43
- <li class="breadcrumb-item">Injectables</li>
44
- <li class="breadcrumb-item" >ApiQueueService</li>
45
- </ol>
46
-
47
- <ul class="nav nav-tabs" role="tablist">
48
- <li class="nav-item">
49
- <a href="#info"
50
- class="nav-link"
51
- class="nav-link active"
52
- role="tab" id="info-tab" data-bs-toggle="tab" data-link="info">Info</a>
53
- </li>
54
- </ul>
55
-
56
- <div class="tab-content">
57
- <div class="tab-pane fade active in" id="info">
58
- <p class="comment">
59
- <h3>File</h3>
60
- </p>
61
- <p class="comment">
62
- <code>packages/eui/packages/core/src/lib/services/queue/api-queue.service.ts</code>
63
- </p>
64
-
65
-
66
-
67
-
68
-
69
- <section data-compodoc="block-index">
70
- <h3 id="index">Index</h3>
71
- <table class="table table-sm table-bordered index-table">
72
- <tbody>
73
-
74
- <tr>
75
- <td class="col-md-4">
76
- <h6><b>Methods</b></h6>
77
- </td>
78
- </tr>
79
- <tr>
80
- <td class="col-md-4">
81
- <ul class="index-list">
82
- <li>
83
- <a href="#addQueueItem" >addQueueItem</a>
84
- </li>
85
- <li>
86
- <a href="#getQueue" >getQueue</a>
87
- </li>
88
- <li>
89
- <a href="#getQueueItem" >getQueueItem</a>
90
- </li>
91
- <li>
92
- <a href="#processAllQueueItems" >processAllQueueItems</a>
93
- </li>
94
- <li>
95
- <a href="#processAllQueueItemsSequential" >processAllQueueItemsSequential</a>
96
- </li>
97
- <li>
98
- <a href="#processQueueItem" >processQueueItem</a>
99
- </li>
100
- <li>
101
- <a href="#removeAllQueueItem" >removeAllQueueItem</a>
102
- </li>
103
- <li>
104
- <a href="#removeQueueItem" >removeQueueItem</a>
105
- </li>
106
- </ul>
107
- </td>
108
- </tr>
109
-
110
-
111
-
112
-
113
-
114
- </tbody>
115
- </table>
116
- </section>
117
-
118
- <section data-compodoc="block-constructor">
119
- <h3 id="constructor">Constructor</h3>
120
- <table class="table table-sm table-bordered">
121
- <tbody>
122
- <tr>
123
- <td class="col-md-4">
124
- <code>constructor(store: <a href="../injectables/StoreService.html" target="_self">StoreService</a>, http: HttpClient, logService: <a href="../injectables/LogService.html" target="_self">LogService</a>)</code>
125
- </td>
126
- </tr>
127
-
128
- <tr>
129
- <td class="col-md-4">
130
- <div>
131
- <b>Parameters :</b>
132
- <table class="params">
133
- <thead>
134
- <tr>
135
- <td>Name</td>
136
- <td>Type</td>
137
- <td>Optional</td>
138
- </tr>
139
- </thead>
140
- <tbody>
141
- <tr>
142
- <td>store</td>
143
-
144
- <td>
145
- <code><a href="../injectables/StoreService.html" target="_self" >StoreService</a></code>
146
- </td>
147
-
148
- <td>
149
- No
150
- </td>
151
-
152
- </tr>
153
- <tr>
154
- <td>http</td>
155
-
156
- <td>
157
- <code>HttpClient</code>
158
- </td>
159
-
160
- <td>
161
- No
162
- </td>
163
-
164
- </tr>
165
- <tr>
166
- <td>logService</td>
167
-
168
- <td>
169
- <code><a href="../injectables/LogService.html" target="_self" >LogService</a></code>
170
- </td>
171
-
172
- <td>
173
- No
174
- </td>
175
-
176
- </tr>
177
- </tbody>
178
- </table>
179
- </div>
180
- </td>
181
- </tr>
182
- </tbody>
183
- </table>
184
- </section>
185
-
186
- <section data-compodoc="block-methods">
187
-
188
- <h3 id="methods">
189
- Methods
190
- </h3>
191
- <table class="table table-sm table-bordered">
192
- <tbody>
193
- <tr>
194
- <td class="col-md-4">
195
- <a name="addQueueItem"></a>
196
- <span class="name">
197
- <span ><b>addQueueItem</b></span>
198
- <a href="#addQueueItem"><span class="icon ion-ios-link"></span></a>
199
- </span>
200
- </td>
201
- </tr>
202
- <tr>
203
- <td class="col-md-4">
204
- <code>addQueueItem(id: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, item: ApiQueueItem)</code>
205
- </td>
206
- </tr>
207
-
208
-
209
-
210
-
211
- <tr>
212
- <td class="col-md-4">
213
- <div class="io-description"><p>Adds an item in the queue by dispatching an action to the store.
214
- WARNING if matches any other queue item id will overwrite it.</p>
215
- </div>
216
-
217
- <div class="io-description">
218
- <b>Parameters :</b>
219
-
220
- <table class="params">
221
- <thead>
222
- <tr>
223
- <td>Name</td>
224
- <td>Type</td>
225
- <td>Optional</td>
226
- <td>Description</td>
227
- </tr>
228
- </thead>
229
- <tbody>
230
- <tr>
231
- <td>id</td>
232
- <td>
233
- <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
234
- </td>
235
-
236
- <td>
237
- No
238
- </td>
239
-
240
-
241
- <td>
242
- <ul>
243
- <li>The id of the item inside the queue.
244
- WARNING if matches any other queue item id will overwrite it.</li>
245
- </ul>
246
-
247
- </td>
248
- </tr>
249
- <tr>
250
- <td>item</td>
251
- <td>
252
- <code>ApiQueueItem</code>
253
- </td>
254
-
255
- <td>
256
- No
257
- </td>
258
-
259
-
260
- <td>
261
- <ul>
262
- <li>an item for Queue</li>
263
- </ul>
264
-
265
- </td>
266
- </tr>
267
- </tbody>
268
- </table>
269
- </div>
270
- <div>
271
- </div>
272
- <div class="io-description">
273
- <b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
274
-
275
- </div>
276
- <div class="io-description">
277
-
278
- </div>
279
- </td>
280
- </tr>
281
- </tbody>
282
- </table>
283
- <table class="table table-sm table-bordered">
284
- <tbody>
285
- <tr>
286
- <td class="col-md-4">
287
- <a name="getQueue"></a>
288
- <span class="name">
289
- <span ><b>getQueue</b></span>
290
- <a href="#getQueue"><span class="icon ion-ios-link"></span></a>
291
- </span>
292
- </td>
293
- </tr>
294
- <tr>
295
- <td class="col-md-4">
296
- <code>getQueue()</code>
297
- </td>
298
- </tr>
299
-
300
-
301
-
302
-
303
- <tr>
304
- <td class="col-md-4">
305
- <div class="io-description"><p>Subscribes to the store to retrieve queue and then converts the queue object to an array of items.</p>
306
- </div>
307
-
308
- <div>
309
- </div>
310
- <div class="io-description">
311
- <b>Returns : </b> <code>Observable&lt;ApiQueueItem[]&gt;</code>
312
-
313
- </div>
314
- <div class="io-description">
315
- <p>An Observable of array of all items inside the current queue (ApiQueueItem[])</p>
316
-
317
- </div>
318
- </td>
319
- </tr>
320
- </tbody>
321
- </table>
322
- <table class="table table-sm table-bordered">
323
- <tbody>
324
- <tr>
325
- <td class="col-md-4">
326
- <a name="getQueueItem"></a>
327
- <span class="name">
328
- <span ><b>getQueueItem</b></span>
329
- <a href="#getQueueItem"><span class="icon ion-ios-link"></span></a>
330
- </span>
331
- </td>
332
- </tr>
333
- <tr>
334
- <td class="col-md-4">
335
- <code>getQueueItem(id: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>)</code>
336
- </td>
337
- </tr>
338
-
339
-
340
-
341
-
342
- <tr>
343
- <td class="col-md-4">
344
- <div class="io-description"><p>Subscribes to the store to retrieve an item from the queue.</p>
345
- </div>
346
-
347
- <div class="io-description">
348
- <b>Parameters :</b>
349
-
350
- <table class="params">
351
- <thead>
352
- <tr>
353
- <td>Name</td>
354
- <td>Type</td>
355
- <td>Optional</td>
356
- <td>Description</td>
357
- </tr>
358
- </thead>
359
- <tbody>
360
- <tr>
361
- <td>id</td>
362
- <td>
363
- <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
364
- </td>
365
-
366
- <td>
367
- No
368
- </td>
369
-
370
-
371
- <td>
372
- <ul>
373
- <li>id of the item inside the queue</li>
374
- </ul>
375
-
376
- </td>
377
- </tr>
378
- </tbody>
379
- </table>
380
- </div>
381
- <div>
382
- </div>
383
- <div class="io-description">
384
- <b>Returns : </b> <code>Observable&lt;ApiQueueItem&gt;</code>
385
-
386
- </div>
387
- <div class="io-description">
388
- <p>An Observable of ApiQueueItem type</p>
389
-
390
- </div>
391
- </td>
392
- </tr>
393
- </tbody>
394
- </table>
395
- <table class="table table-sm table-bordered">
396
- <tbody>
397
- <tr>
398
- <td class="col-md-4">
399
- <a name="processAllQueueItems"></a>
400
- <span class="name">
401
- <span ><b>processAllQueueItems</b></span>
402
- <a href="#processAllQueueItems"><span class="icon ion-ios-link"></span></a>
403
- </span>
404
- </td>
405
- </tr>
406
- <tr>
407
- <td class="col-md-4">
408
- <code>processAllQueueItems(continueOnError: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank">boolean</a>)</code>
409
- </td>
410
- </tr>
411
-
412
-
413
-
414
-
415
- <tr>
416
- <td class="col-md-4">
417
- <div class="io-description"><p>Process all the items inside the queue.</p>
418
- </div>
419
-
420
- <div class="io-description">
421
- <b>Parameters :</b>
422
-
423
- <table class="params">
424
- <thead>
425
- <tr>
426
- <td>Name</td>
427
- <td>Type</td>
428
- <td>Optional</td>
429
- <td>Default value</td>
430
- <td>Description</td>
431
- </tr>
432
- </thead>
433
- <tbody>
434
- <tr>
435
- <td>continueOnError</td>
436
- <td>
437
- <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
438
- </td>
439
-
440
- <td>
441
- No
442
- </td>
443
-
444
- <td>
445
- <code>true</code>
446
- </td>
447
-
448
- <td>
449
- <ul>
450
- <li>in case of an item request fails continue with the rest in queue</li>
451
- </ul>
452
-
453
- </td>
454
- </tr>
455
- </tbody>
456
- </table>
457
- </div>
458
- <div>
459
- </div>
460
- <div class="io-description">
461
- <b>Returns : </b> <code>Observable&lt;any[]&gt;</code>
462
-
463
- </div>
464
- <div class="io-description">
465
- <p>An Observable with an array which contains all responses from all items in queue.</p>
466
-
467
- </div>
468
- </td>
469
- </tr>
470
- </tbody>
471
- </table>
472
- <table class="table table-sm table-bordered">
473
- <tbody>
474
- <tr>
475
- <td class="col-md-4">
476
- <a name="processAllQueueItemsSequential"></a>
477
- <span class="name">
478
- <span ><b>processAllQueueItemsSequential</b></span>
479
- <a href="#processAllQueueItemsSequential"><span class="icon ion-ios-link"></span></a>
480
- </span>
481
- </td>
482
- </tr>
483
- <tr>
484
- <td class="col-md-4">
485
- <code>processAllQueueItemsSequential(ascending: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank">boolean</a>)</code>
486
- </td>
487
- </tr>
488
-
489
-
490
-
491
-
492
- <tr>
493
- <td class="col-md-4">
494
- <div class="io-description"><p>Process all items in queue after it order them based on their timestamp. Beware that order
495
- matter in execution of Http Request in queue. When a request completes only then next will begin. Emission
496
- or Http response follows order.</p>
497
- </div>
498
-
499
- <div class="io-description">
500
- <b>Parameters :</b>
501
-
502
- <table class="params">
503
- <thead>
504
- <tr>
505
- <td>Name</td>
506
- <td>Type</td>
507
- <td>Optional</td>
508
- <td>Default value</td>
509
- <td>Description</td>
510
- </tr>
511
- </thead>
512
- <tbody>
513
- <tr>
514
- <td>ascending</td>
515
- <td>
516
- <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
517
- </td>
518
-
519
- <td>
520
- No
521
- </td>
522
-
523
- <td>
524
- <code>true</code>
525
- </td>
526
-
527
- <td>
528
- <ul>
529
- <li>sets the order of queue items based on timestamp</li>
530
- </ul>
531
-
532
- </td>
533
- </tr>
534
- </tbody>
535
- </table>
536
- </div>
537
- <div>
538
- </div>
539
- <div class="io-description">
540
- <b>Returns : </b> <code>Observable&lt;any&gt;</code>
541
-
542
- </div>
543
- <div class="io-description">
544
-
545
- </div>
546
- </td>
547
- </tr>
548
- </tbody>
549
- </table>
550
- <table class="table table-sm table-bordered">
551
- <tbody>
552
- <tr>
553
- <td class="col-md-4">
554
- <a name="processQueueItem"></a>
555
- <span class="name">
556
- <span ><b>processQueueItem</b></span>
557
- <a href="#processQueueItem"><span class="icon ion-ios-link"></span></a>
558
- </span>
559
- </td>
560
- </tr>
561
- <tr>
562
- <td class="col-md-4">
563
- <code>processQueueItem(id: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>)</code>
564
- </td>
565
- </tr>
566
-
567
-
568
-
569
-
570
- <tr>
571
- <td class="col-md-4">
572
- <div class="io-description"><p>Process an item from the queue.</p>
573
- </div>
574
-
575
- <div class="io-description">
576
- <b>Parameters :</b>
577
-
578
- <table class="params">
579
- <thead>
580
- <tr>
581
- <td>Name</td>
582
- <td>Type</td>
583
- <td>Optional</td>
584
- <td>Description</td>
585
- </tr>
586
- </thead>
587
- <tbody>
588
- <tr>
589
- <td>id</td>
590
- <td>
591
- <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
592
- </td>
593
-
594
- <td>
595
- No
596
- </td>
597
-
598
-
599
- <td>
600
- <ul>
601
- <li>id of the item inside the queue</li>
602
- </ul>
603
-
604
- </td>
605
- </tr>
606
- </tbody>
607
- </table>
608
- </div>
609
- <div>
610
- </div>
611
- <div class="io-description">
612
- <b>Returns : </b> <code>Observable&lt;any&gt;</code>
613
-
614
- </div>
615
- <div class="io-description">
616
- <p>An Observable of type any</p>
617
-
618
- </div>
619
- </td>
620
- </tr>
621
- </tbody>
622
- </table>
623
- <table class="table table-sm table-bordered">
624
- <tbody>
625
- <tr>
626
- <td class="col-md-4">
627
- <a name="removeAllQueueItem"></a>
628
- <span class="name">
629
- <span ><b>removeAllQueueItem</b></span>
630
- <a href="#removeAllQueueItem"><span class="icon ion-ios-link"></span></a>
631
- </span>
632
- </td>
633
- </tr>
634
- <tr>
635
- <td class="col-md-4">
636
- <code>removeAllQueueItem()</code>
637
- </td>
638
- </tr>
639
-
640
-
641
-
642
-
643
- <tr>
644
- <td class="col-md-4">
645
- <div class="io-description"><p>Removes all items placed in the queue.</p>
646
- </div>
647
-
648
- <div class="io-description">
649
- <b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
650
-
651
- </div>
652
- </td>
653
- </tr>
654
- </tbody>
655
- </table>
656
- <table class="table table-sm table-bordered">
657
- <tbody>
658
- <tr>
659
- <td class="col-md-4">
660
- <a name="removeQueueItem"></a>
661
- <span class="name">
662
- <span ><b>removeQueueItem</b></span>
663
- <a href="#removeQueueItem"><span class="icon ion-ios-link"></span></a>
664
- </span>
665
- </td>
666
- </tr>
667
- <tr>
668
- <td class="col-md-4">
669
- <code>removeQueueItem(id: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>)</code>
670
- </td>
671
- </tr>
672
-
673
-
674
-
675
-
676
- <tr>
677
- <td class="col-md-4">
678
- <div class="io-description"><p>Removes a given item from the queue.</p>
679
- </div>
680
-
681
- <div class="io-description">
682
- <b>Parameters :</b>
683
-
684
- <table class="params">
685
- <thead>
686
- <tr>
687
- <td>Name</td>
688
- <td>Type</td>
689
- <td>Optional</td>
690
- <td>Description</td>
691
- </tr>
692
- </thead>
693
- <tbody>
694
- <tr>
695
- <td>id</td>
696
- <td>
697
- <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
698
- </td>
699
-
700
- <td>
701
- No
702
- </td>
703
-
704
-
705
- <td>
706
- <ul>
707
- <li>id of the item inside the queue</li>
708
- </ul>
709
-
710
- </td>
711
- </tr>
712
- </tbody>
713
- </table>
714
- </div>
715
- <div>
716
- </div>
717
- <div class="io-description">
718
- <b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
719
-
720
- </div>
721
- <div class="io-description">
722
-
723
- </div>
724
- </td>
725
- </tr>
726
- </tbody>
727
- </table>
728
- </section>
729
-
730
- </div>
731
-
732
-
733
-
734
- </div>
735
-
736
-
737
-
738
-
739
-
740
-
741
-
742
-
743
-
744
-
745
-
746
-
747
-
748
- </div><div class="search-results">
749
- <div class="has-results">
750
- <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
751
- <ul class="search-results-list"></ul>
752
- </div>
753
- <div class="no-results">
754
- <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
755
- </div>
756
- </div>
757
- </div>
758
- <!-- END CONTENT -->
759
- </div>
760
- </div>
761
-
762
- <label class="dark-mode-switch">
763
- <input type="checkbox">
764
- <span class="slider">
765
- <svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg">
766
- <path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path>
767
- </svg>
768
- </span>
769
- </label>
770
-
771
- <script>
772
- var COMPODOC_CURRENT_PAGE_DEPTH = 1;
773
- var COMPODOC_CURRENT_PAGE_CONTEXT = 'injectable';
774
- var COMPODOC_CURRENT_PAGE_URL = 'ApiQueueService.html';
775
- var MAX_SEARCH_RESULTS = 15;
776
- </script>
777
-
778
- <script src="../js/libs/custom-elements.min.js"></script>
779
- <script src="../js/libs/lit-html.js"></script>
780
-
781
- <script src="../js/menu-wc.js" defer></script>
782
- <script nomodule src="../js/menu-wc_es5.js" defer></script>
783
-
784
- <script src="../js/libs/bootstrap-native.js"></script>
785
-
786
- <script src="../js/libs/es6-shim.min.js"></script>
787
- <script src="../js/libs/EventDispatcher.js"></script>
788
- <script src="../js/libs/promise.min.js"></script>
789
- <script src="../js/libs/zepto.min.js"></script>
790
-
791
- <script src="../js/compodoc.js"></script>
792
-
793
- <script src="../js/tabs.js"></script>
794
- <script src="../js/menu.js"></script>
795
- <script src="../js/libs/clipboard.min.js"></script>
796
- <script src="../js/libs/prism.js"></script>
797
- <script src="../js/sourceCode.js"></script>
798
- <script src="../js/search/search.js"></script>
799
- <script src="../js/search/lunr.min.js"></script>
800
- <script src="../js/search/search-lunr.js"></script>
801
- <script src="../js/search/search_index.js"></script>
802
- <script src="../js/lazy-load-graphs.js"></script>
803
-
804
-
805
- </body>
806
- </html>