Skip to content

Commit e1217ba

Browse files
committed
Docs updated.
1 parent 04ec176 commit e1217ba

File tree

130 files changed

+8367
-1431
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

130 files changed

+8367
-1431
lines changed

docs/Classes.html

Lines changed: 70 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<a title="Classes Reference"></a>
1515
<header>
1616
<div class="content-wrapper">
17-
<p><a href="index.html">GetStream Docs</a> (49% documented)</p>
17+
<p><a href="index.html">GetStream Docs</a> (48% documented)</p>
1818
</div>
1919
</header>
2020
<div class="content-wrapper">
@@ -66,6 +66,9 @@
6666
<li class="nav-group-task">
6767
<a href="Classes/NotificationGroup.html">NotificationGroup</a>
6868
</li>
69+
<li class="nav-group-task">
70+
<a href="Classes/Reaction.html">Reaction</a>
71+
</li>
6972
<li class="nav-group-task">
7073
<a href="Classes/SubscribedChannel.html">SubscribedChannel</a>
7174
</li>
@@ -121,6 +124,9 @@
121124
<li class="nav-group-task">
122125
<a href="Extensions/JSONEncoder.html">JSONEncoder</a>
123126
</li>
127+
<li class="nav-group-task">
128+
<a href="Extensions/ReactionKind.html">ReactionKind</a>
129+
</li>
124130
<li class="nav-group-task">
125131
<a href="Extensions/String.html">String</a>
126132
</li>
@@ -138,6 +144,9 @@
138144
<li class="nav-group-task">
139145
<a href="Protocols/Enrichable.html">Enrichable</a>
140146
</li>
147+
<li class="nav-group-task">
148+
<a href="Protocols/ReactionProtocol.html">ReactionProtocol</a>
149+
</li>
141150
<li class="nav-group-task">
142151
<a href="Protocols/UserProtocol.html">UserProtocol</a>
143152
</li>
@@ -155,6 +164,9 @@
155164
<li class="nav-group-task">
156165
<a href="Structs/BaseURL/Location.html">– Location</a>
157166
</li>
167+
<li class="nav-group-task">
168+
<a href="Structs/EmptyReactionExtraData.html">EmptyReactionExtraData</a>
169+
</li>
158170
<li class="nav-group-task">
159171
<a href="Structs/EnrichingActivityError.html">EnrichingActivityError</a>
160172
</li>
@@ -191,12 +203,6 @@
191203
<li class="nav-group-task">
192204
<a href="Structs/OGVideoResponse.html">OGVideoResponse</a>
193205
</li>
194-
<li class="nav-group-task">
195-
<a href="Structs/Reaction.html">Reaction</a>
196-
</li>
197-
<li class="nav-group-task">
198-
<a href="Structs.html#/s:9GetStream19ReactionNoExtraDataV">ReactionNoExtraData</a>
199-
</li>
200206
<li class="nav-group-task">
201207
<a href="Structs/Reactions.html">Reactions</a>
202208
</li>
@@ -226,6 +232,15 @@
226232
<li class="nav-group-task">
227233
<a href="Typealiases.html#/s:9GetStream26CollectionObjectCompletiona">CollectionObjectCompletion</a>
228234
</li>
235+
<li class="nav-group-task">
236+
<a href="Typealiases.html#/s:9GetStream15DefaultReactiona">DefaultReaction</a>
237+
</li>
238+
<li class="nav-group-task">
239+
<a href="Typealiases.html#/s:9GetStream25DefaultReactionCompletiona">DefaultReactionCompletion</a>
240+
</li>
241+
<li class="nav-group-task">
242+
<a href="Typealiases.html#/s:9GetStream26DefaultReactionsCompletiona">DefaultReactionsCompletion</a>
243+
</li>
229244
<li class="nav-group-task">
230245
<a href="Typealiases.html#/s:9GetStream7FeedIdsa">FeedIds</a>
231246
</li>
@@ -244,6 +259,9 @@
244259
<li class="nav-group-task">
245260
<a href="Typealiases.html#/s:9GetStream4JSONa">JSON</a>
246261
</li>
262+
<li class="nav-group-task">
263+
<a href="Typealiases.html#/s:9GetStream24MultipleUploadCompletiona">MultipleUploadCompletion</a>
264+
</li>
247265
<li class="nav-group-task">
248266
<a href="Typealiases.html#/s:9GetStream12OGCompletiona">OGCompletion</a>
249267
</li>
@@ -318,7 +336,10 @@ <h1>Classes</h1>
318336
<h4>Declaration</h4>
319337
<div class="language">
320338
<p class="aside-title">Swift</p>
321-
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">EnrichedActivity</span><span class="o">&lt;</span><span class="kt">ActorType</span><span class="p">,</span> <span class="kt">ObjectType</span><span class="p">,</span> <span class="kt">TargetType</span><span class="o">&gt;</span> <span class="p">:</span> <span class="kt"><a href="Protocols/ActivityProtocol.html">ActivityProtocol</a></span> <span class="k">where</span> <span class="kt">ActorType</span> <span class="p">:</span> <span class="kt"><a href="Protocols/Enrichable.html">Enrichable</a></span><span class="p">,</span> <span class="kt">ObjectType</span> <span class="p">:</span> <span class="kt"><a href="Protocols/Enrichable.html">Enrichable</a></span><span class="p">,</span> <span class="kt">TargetType</span> <span class="p">:</span> <span class="kt"><a href="Protocols/Enrichable.html">Enrichable</a></span></code></pre>
339+
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">EnrichedActivity</span><span class="o">&lt;</span><span class="kt">ActorType</span><span class="p">:</span> <span class="kt"><a href="Protocols/Enrichable.html">Enrichable</a></span><span class="p">,</span>
340+
<span class="kt">ObjectType</span><span class="p">:</span> <span class="kt"><a href="Protocols/Enrichable.html">Enrichable</a></span><span class="p">,</span>
341+
<span class="kt">TargetType</span><span class="p">:</span> <span class="kt"><a href="Protocols/Enrichable.html">Enrichable</a></span><span class="p">,</span>
342+
<span class="kt">ReactionType</span><span class="p">:</span> <span class="kt"><a href="Protocols/ReactionProtocol.html">ReactionProtocol</a></span><span class="o">&gt;</span><span class="p">:</span> <span class="kt"><a href="Protocols/ActivityProtocol.html">ActivityProtocol</a></span></code></pre>
322343

323344
</div>
324345
</div>
@@ -592,6 +613,45 @@ <h4>Declaration</h4>
592613
</li>
593614
</ul>
594615
</div>
616+
<div class="task-group">
617+
<div class="task-name-container">
618+
<a name="/Reaction"></a>
619+
<a name="//apple_ref/swift/Section/Reaction" class="dashAnchor"></a>
620+
<a href="#/Reaction">
621+
<h3 class="section-name">Reaction</h3>
622+
</a>
623+
</div>
624+
<ul>
625+
<li class="item">
626+
<div>
627+
<code>
628+
<a name="/s:9GetStream8ReactionC"></a>
629+
<a name="//apple_ref/swift/Class/Reaction" class="dashAnchor"></a>
630+
<a class="token" href="#/s:9GetStream8ReactionC">Reaction</a>
631+
</code>
632+
</div>
633+
<div class="height-container">
634+
<div class="pointer-container"></div>
635+
<section class="section">
636+
<div class="pointer"></div>
637+
<div class="abstract">
638+
<p>Undocumented</p>
639+
640+
<a href="Classes/Reaction.html" class="slightly-smaller">See more</a>
641+
</div>
642+
<div class="declaration">
643+
<h4>Declaration</h4>
644+
<div class="language">
645+
<p class="aside-title">Swift</p>
646+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">Reaction</span><span class="o">&lt;</span><span class="kt">T</span><span class="p">,</span> <span class="kt">U</span><span class="o">&gt;</span> <span class="p">:</span> <span class="kt"><a href="Protocols/ReactionProtocol.html">ReactionProtocol</a></span><span class="p">,</span> <span class="kt">Equatable</span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt">Decodable</span><span class="p">,</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt">Encodable</span><span class="p">,</span> <span class="kt">U</span> <span class="p">:</span> <span class="kt"><a href="Protocols/UserProtocol.html">UserProtocol</a></span></code></pre>
647+
648+
</div>
649+
</div>
650+
</section>
651+
</div>
652+
</li>
653+
</ul>
654+
</div>
595655
<div class="task-group">
596656
<ul>
597657
<li class="item">
@@ -621,7 +681,7 @@ <h4>Declaration</h4>
621681
<h4>Declaration</h4>
622682
<div class="language">
623683
<p class="aside-title">Swift</p>
624-
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">User</span> <span class="p">:</span> <span class="kt"><a href="Protocols/UserProtocol.html">UserProtocol</a></span><span class="p">,</span> <span class="kt">Equatable</span></code></pre>
684+
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">User</span> <span class="p">:</span> <span class="kt"><a href="Protocols/UserProtocol.html">UserProtocol</a></span></code></pre>
625685

626686
</div>
627687
</div>
@@ -672,7 +732,7 @@ <h4>Declaration</h4>
672732
</section>
673733
</section>
674734
<section id="footer">
675-
<p>&copy; 2019 <a class="link" href="https://github.com/GetStream/stream-swift" target="_blank" rel="external">Alexey Bukhtin</a>. All rights reserved. (Last updated: 2019-01-23)</p>
735+
<p>&copy; 2019 <a class="link" href="https://github.com/GetStream/stream-swift" target="_blank" rel="external">Alexey Bukhtin</a>. All rights reserved. (Last updated: 2019-02-07)</p>
676736
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
677737
</section>
678738
</article>

docs/Classes/AggregatedFeed.html

Lines changed: 28 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<a title="AggregatedFeed Class Reference"></a>
1515
<header>
1616
<div class="content-wrapper">
17-
<p><a href="../index.html">GetStream Docs</a> (49% documented)</p>
17+
<p><a href="../index.html">GetStream Docs</a> (48% documented)</p>
1818
</div>
1919
</header>
2020
<div class="content-wrapper">
@@ -66,6 +66,9 @@
6666
<li class="nav-group-task">
6767
<a href="../Classes/NotificationGroup.html">NotificationGroup</a>
6868
</li>
69+
<li class="nav-group-task">
70+
<a href="../Classes/Reaction.html">Reaction</a>
71+
</li>
6972
<li class="nav-group-task">
7073
<a href="../Classes/SubscribedChannel.html">SubscribedChannel</a>
7174
</li>
@@ -121,6 +124,9 @@
121124
<li class="nav-group-task">
122125
<a href="../Extensions/JSONEncoder.html">JSONEncoder</a>
123126
</li>
127+
<li class="nav-group-task">
128+
<a href="../Extensions/ReactionKind.html">ReactionKind</a>
129+
</li>
124130
<li class="nav-group-task">
125131
<a href="../Extensions/String.html">String</a>
126132
</li>
@@ -138,6 +144,9 @@
138144
<li class="nav-group-task">
139145
<a href="../Protocols/Enrichable.html">Enrichable</a>
140146
</li>
147+
<li class="nav-group-task">
148+
<a href="../Protocols/ReactionProtocol.html">ReactionProtocol</a>
149+
</li>
141150
<li class="nav-group-task">
142151
<a href="../Protocols/UserProtocol.html">UserProtocol</a>
143152
</li>
@@ -155,6 +164,9 @@
155164
<li class="nav-group-task">
156165
<a href="../Structs/BaseURL/Location.html">– Location</a>
157166
</li>
167+
<li class="nav-group-task">
168+
<a href="../Structs/EmptyReactionExtraData.html">EmptyReactionExtraData</a>
169+
</li>
158170
<li class="nav-group-task">
159171
<a href="../Structs/EnrichingActivityError.html">EnrichingActivityError</a>
160172
</li>
@@ -191,12 +203,6 @@
191203
<li class="nav-group-task">
192204
<a href="../Structs/OGVideoResponse.html">OGVideoResponse</a>
193205
</li>
194-
<li class="nav-group-task">
195-
<a href="../Structs/Reaction.html">Reaction</a>
196-
</li>
197-
<li class="nav-group-task">
198-
<a href="../Structs.html#/s:9GetStream19ReactionNoExtraDataV">ReactionNoExtraData</a>
199-
</li>
200206
<li class="nav-group-task">
201207
<a href="../Structs/Reactions.html">Reactions</a>
202208
</li>
@@ -226,6 +232,15 @@
226232
<li class="nav-group-task">
227233
<a href="../Typealiases.html#/s:9GetStream26CollectionObjectCompletiona">CollectionObjectCompletion</a>
228234
</li>
235+
<li class="nav-group-task">
236+
<a href="../Typealiases.html#/s:9GetStream15DefaultReactiona">DefaultReaction</a>
237+
</li>
238+
<li class="nav-group-task">
239+
<a href="../Typealiases.html#/s:9GetStream25DefaultReactionCompletiona">DefaultReactionCompletion</a>
240+
</li>
241+
<li class="nav-group-task">
242+
<a href="../Typealiases.html#/s:9GetStream26DefaultReactionsCompletiona">DefaultReactionsCompletion</a>
243+
</li>
229244
<li class="nav-group-task">
230245
<a href="../Typealiases.html#/s:9GetStream7FeedIdsa">FeedIds</a>
231246
</li>
@@ -244,6 +259,9 @@
244259
<li class="nav-group-task">
245260
<a href="../Typealiases.html#/s:9GetStream4JSONa">JSON</a>
246261
</li>
262+
<li class="nav-group-task">
263+
<a href="../Typealiases.html#/s:9GetStream24MultipleUploadCompletiona">MultipleUploadCompletion</a>
264+
</li>
247265
<li class="nav-group-task">
248266
<a href="../Typealiases.html#/s:9GetStream12OGCompletiona">OGCompletion</a>
249267
</li>
@@ -307,9 +325,9 @@ <h1>AggregatedFeed</h1>
307325
<li class="item">
308326
<div>
309327
<code>
310-
<a name="/s:9GetStream14AggregatedFeedC3get6enrich10pagination16includeReactions10completion4Moya11Cancellable_pSb_AA10PaginationOAA0dI7OptionsVy6ResultAOOyAA8ResponseVyAA5GroupCyAA16EnrichedActivityCyS3SGGGAA11ClientErrorOGctF"></a>
328+
<a name="/s:9GetStream14AggregatedFeedC3get6enrich10pagination16includeReactions10completion4Moya11Cancellable_pSb_AA10PaginationOAA0dI7OptionsVy6ResultAOOyAA8ResponseVyAA5GroupCyAA16EnrichedActivityCyS3SAA8ReactionCyAA05EmptyT9ExtraDataVAA4UserCGGGGAA11ClientErrorOGctF"></a>
311329
<a name="//apple_ref/swift/Method/get(enrich:pagination:includeReactions:completion:)" class="dashAnchor"></a>
312-
<a class="token" href="#/s:9GetStream14AggregatedFeedC3get6enrich10pagination16includeReactions10completion4Moya11Cancellable_pSb_AA10PaginationOAA0dI7OptionsVy6ResultAOOyAA8ResponseVyAA5GroupCyAA16EnrichedActivityCyS3SGGGAA11ClientErrorOGctF">get(enrich:pagination:includeReactions:completion:)</a>
330+
<a class="token" href="#/s:9GetStream14AggregatedFeedC3get6enrich10pagination16includeReactions10completion4Moya11Cancellable_pSb_AA10PaginationOAA0dI7OptionsVy6ResultAOOyAA8ResponseVyAA5GroupCyAA16EnrichedActivityCyS3SAA8ReactionCyAA05EmptyT9ExtraDataVAA4UserCGGGGAA11ClientErrorOGctF">get(enrich:pagination:includeReactions:completion:)</a>
313331
</code>
314332
</div>
315333
<div class="height-container">
@@ -502,7 +520,7 @@ <h4>Return Value</h4>
502520
</section>
503521
</section>
504522
<section id="footer">
505-
<p>&copy; 2019 <a class="link" href="https://github.com/GetStream/stream-swift" target="_blank" rel="external">Alexey Bukhtin</a>. All rights reserved. (Last updated: 2019-01-23)</p>
523+
<p>&copy; 2019 <a class="link" href="https://github.com/GetStream/stream-swift" target="_blank" rel="external">Alexey Bukhtin</a>. All rights reserved. (Last updated: 2019-02-07)</p>
506524
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
507525
</section>
508526
</article>

0 commit comments

Comments
 (0)