_config_asteroidinterfaces_.icollectionresult.html 14.4 KB
Newer Older
1
<!doctype html>
2
<html class="default no-js">
3
4
5
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
6
	<title>ICollectionResult | @rocket.chat/sdk</title>
7
8
	<meta name="description" content="">
	<meta name="viewport" content="width=device-width, initial-scale=1">
9
	<link rel="stylesheet" href="../assets/css/main.css">
10
11
12
13
14
15
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
16
17
18
19
20
21
22
23
24
				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
25
					<a href="../index.html" class="title">@rocket.chat/sdk</a>
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
							<input type="checkbox" id="tsd-filter-only-exported" />
							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
						</div>
					</div>
45
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
46
47
48
49
				</div>
			</div>
		</div>
	</div>
50
51
52
53
54
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="../globals.html">Globals</a>
55
				</li>
56
57
				<li>
					<a href="../modules/_config_asteroidinterfaces_.html">&quot;config/asteroidInterfaces&quot;</a>
58
59
				</li>
				<li>
60
					<a href="_config_asteroidinterfaces_.icollectionresult.html">ICollectionResult</a>
61
62
				</li>
			</ul>
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
			<h1>Interface ICollectionResult</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<section class="tsd-panel tsd-comment">
				<div class="tsd-comment tsd-typography">
					<div class="lead">
						<p>The <code>local</code> promise is immediately resolved with the <code>_id</code> of the updated
							item. That is, unless an error occurred. In that case, an exception will be
							raised.
							The <code>remote</code> promise is resolved with the <code>_id</code> of the updated item if the
							remote update is successful. Otherwise it&#39;s rejected with the reason of the
						failure.</p>
					</div>
80
81
				</div>
			</section>
82
83
84
85
86
87
88
			<section class="tsd-panel tsd-hierarchy">
				<h3>Hierarchy</h3>
				<ul class="tsd-hierarchy">
					<li>
						<span class="target">ICollectionResult</span>
					</li>
				</ul>
89
			</section>
90
91
92
93
94
95
96
97
98
99
100
101
102
			<section class="tsd-panel-group tsd-index-group">
				<h2>Index</h2>
				<section class="tsd-panel tsd-index-panel">
					<div class="tsd-index-content">
						<section class="tsd-index-section ">
							<h3>Properties</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_config_asteroidinterfaces_.icollectionresult.html#local" class="tsd-kind-icon">local</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_config_asteroidinterfaces_.icollectionresult.html#remote" class="tsd-kind-icon">remote</a></li>
							</ul>
						</section>
					</div>
				</section>
103
			</section>
104
105
106
107
108
109
110
111
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Properties</h2>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="local" class="tsd-anchor"></a>
					<h3>local</h3>
					<div class="tsd-signature tsd-kind-icon">local<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></div>
					<aside class="tsd-sources">
						<ul>
112
							<li>Defined in <a href="https://github.com/RocketChat/Rocket.Chat.js.SDK/blob/c8bf796/src/config/asteroidInterfaces.ts#L103">config/asteroidInterfaces.ts:103</a></li>
113
114
115
116
117
118
119
120
121
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="remote" class="tsd-anchor"></a>
					<h3>remote</h3>
					<div class="tsd-signature tsd-kind-icon">remote<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></div>
					<aside class="tsd-sources">
						<ul>
122
							<li>Defined in <a href="https://github.com/RocketChat/Rocket.Chat.js.SDK/blob/c8bf796/src/config/asteroidInterfaces.ts#L104">config/asteroidInterfaces.ts:104</a></li>
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
						</ul>
					</aside>
				</section>
			</section>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class="globals  ">
						<a href="../globals.html"><em>Globals</em></a>
					</li>
					<li class="current tsd-kind-external-module">
						<a href="../modules/_config_asteroidinterfaces_.html">"config/asteroid<wbr>Interfaces"</a>
					</li>
					<li class=" tsd-kind-external-module">
						<a href="../modules/_config_driverinterfaces_.html">"config/driver<wbr>Interfaces"</a>
					</li>
					<li class=" tsd-kind-external-module">
						<a href="../modules/_config_messageinterfaces_.html">"config/message<wbr>Interfaces"</a>
					</li>
					<li class=" tsd-kind-external-module">
						<a href="../modules/_index_.html">"index"</a>
					</li>
					<li class=" tsd-kind-external-module">
						<a href="../modules/_lib_driver_.html">"lib/driver"</a>
					</li>
					<li class=" tsd-kind-external-module">
						<a href="../modules/_lib_log_.html">"lib/log"</a>
					</li>
					<li class=" tsd-kind-external-module">
						<a href="../modules/_lib_message_.html">"lib/message"</a>
					</li>
					<li class=" tsd-kind-external-module">
						<a href="../modules/_lib_methodcache_.html">"lib/method<wbr>Cache"</a>
					</li>
					<li class=" tsd-kind-external-module">
						<a href="../modules/_types_asteroid_d_.html">"types/<wbr>Asteroid.d"</a>
					</li>
					<li class=" tsd-kind-external-module">
						<a href="../modules/_types_client_d_.html">"types/<wbr>Client.d"</a>
					</li>
					<li class=" tsd-kind-external-module">
						<a href="../modules/_types_immutablecollectionmixin_d_.html">"types/immutable<wbr>Collection<wbr>Mixin.d"</a>
					</li>
					<li class=" tsd-kind-external-module">
						<a href="../modules/_utils_api_.html">"utils/api"</a>
					</li>
					<li class=" tsd-kind-external-module">
						<a href="../modules/_utils_config_.html">"utils/config"</a>
					</li>
					<li class=" tsd-kind-external-module">
						<a href="../modules/_utils_interfaces_.html">"utils/interfaces"</a>
					</li>
					<li class=" tsd-kind-external-module">
						<a href="../modules/_utils_start_.html">"utils/start"</a>
					</li>
					<li class=" tsd-kind-external-module">
						<a href="../modules/_utils_testing_.html">"utils/testing"</a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
					<li class=" tsd-kind-interface tsd-parent-kind-external-module">
						<a href="_config_asteroidinterfaces_.iasteroid.html" class="tsd-kind-icon">IAsteroid</a>
					</li>
					<li class=" tsd-kind-interface tsd-parent-kind-external-module">
						<a href="_config_asteroidinterfaces_.icollection.html" class="tsd-kind-icon">ICollection</a>
					</li>
				</ul>
				<ul class="current">
					<li class="current tsd-kind-interface tsd-parent-kind-external-module">
						<a href="_config_asteroidinterfaces_.icollectionresult.html" class="tsd-kind-icon">ICollection<wbr>Result</a>
						<ul>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_config_asteroidinterfaces_.icollectionresult.html#local" class="tsd-kind-icon">local</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_config_asteroidinterfaces_.icollectionresult.html#remote" class="tsd-kind-icon">remote</a>
							</li>
						</ul>
					</li>
				</ul>
				<ul class="after-current">
					<li class=" tsd-kind-interface tsd-parent-kind-external-module">
						<a href="_config_asteroidinterfaces_.icredentials.html" class="tsd-kind-icon">ICredentials</a>
					</li>
					<li class=" tsd-kind-interface tsd-parent-kind-external-module">
						<a href="_config_asteroidinterfaces_.imethodresult.html" class="tsd-kind-icon">IMethod<wbr>Result</a>
					</li>
					<li class=" tsd-kind-interface tsd-parent-kind-external-module">
						<a href="_config_asteroidinterfaces_.ireactivequery.html" class="tsd-kind-icon">IReactive<wbr>Query</a>
					</li>
					<li class=" tsd-kind-interface tsd-parent-kind-external-module">
						<a href="_config_asteroidinterfaces_.iready.html" class="tsd-kind-icon">IReady</a>
					</li>
					<li class=" tsd-kind-interface tsd-parent-kind-external-module">
						<a href="_config_asteroidinterfaces_.isubscription.html" class="tsd-kind-icon">ISubscription</a>
					</li>
					<li class=" tsd-kind-interface tsd-parent-kind-external-module">
						<a href="_config_asteroidinterfaces_.iuseroptions.html" class="tsd-kind-icon">IUser<wbr>Options</a>
					</li>
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer class="with-border-bottom">
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
			</ul>
286
287
		</div>
	</div>
288
289
290
</footer>
<div class="container tsd-generator">
	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
291
</div>
292
293
294
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
295
296
</body>
</html>