Skip to content

Commit 4690eb0

Browse files
fbenevidesfbenevides
authored
Merge pull request #383 from pusher/update-docs
Update SDK docs to 10.1.0 version
2 parents 22196c2 + 6d3fc1f commit 4690eb0

Some content is hidden

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

75 files changed

+2557
-1732
lines changed

‎Scripts/generate-api-docs.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ read -p 'Enter release tag (without quotes): ' RELEASE_TAG
1616

1717
AUTHOR_NAME="Pusher Limited"
1818
AUTHOR_URL="https://pusher.com"
19-
GITHUB_ORIGIN=$(git remote get-url origin)
19+
GITHUB_ORIGIN="https://github.com/pusher/pusher-websocket-swift"
2020
GITHUB_URL=${GITHUB_ORIGIN%".git"}
2121
MODULE_NAME=$(swift package dump-package | jq --raw-output '.name')
2222

‎docs/Classes.html

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,19 @@
1717
<a title="Classes Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="index.html">PusherSwift 9.2.2 Docs</a> (25% documented)</p>
21-
<p class="header-right"><a href="https://github.com/pusher/pusher-websocket-swift"><img src="img/gh.png"/>View on GitHub</a></p>
22-
<p class="header-right">
20+
<p><a href="index.html">PusherSwift 10.1.0 Docs</a> (24% documented)</p>
21+
<p class="header-right"><a href="https://github.com/pusher/pusher-websocket-swift"><img src="img/gh.png" alt="GitHub"/>View on GitHub</a></p>
22+
<div class="header-right">
2323
<form role="search" action="search.json">
2424
<input type="text" placeholder="Search documentation" data-typeahead>
2525
</form>
26-
</p>
26+
</div>
2727
</div>
2828
</header>
2929
<div class="content-wrapper">
3030
<p id="breadcrumbs">
3131
<a href="index.html">PusherSwift Reference</a>
32-
<img id="carat" src="img/carat.png" />
32+
<img id="carat" src="img/carat.png" alt=""/>
3333
Classes Reference
3434
</p>
3535
</div>
@@ -171,7 +171,7 @@ <h4>Declaration</h4>
171171
</div>
172172
</div>
173173
<div class="slightly-smaller">
174-
<a href="https://github.com/pusher/pusher-websocket-swift/tree/9.2.2/Sources/Services/PusherConnection.swift#L7-L933">Show on GitHub</a>
174+
<a href="https://github.com/pusher/pusher-websocket-swift/tree/10.1.0/Sources/Services/PusherConnection.swift#L7-L948">Show on GitHub</a>
175175
</div>
176176
</section>
177177
</div>
@@ -203,7 +203,7 @@ <h4>Declaration</h4>
203203
</div>
204204
</div>
205205
<div class="slightly-smaller">
206-
<a href="https://github.com/pusher/pusher-websocket-swift/tree/9.2.2/Sources/Models/PusherAuth.swift#L3-L13">Show on GitHub</a>
206+
<a href="https://github.com/pusher/pusher-websocket-swift/tree/10.1.0/Sources/Models/PusherAuth.swift#L3-L13">Show on GitHub</a>
207207
</div>
208208
</section>
209209
</div>
@@ -235,7 +235,7 @@ <h4>Declaration</h4>
235235
</div>
236236
</div>
237237
<div class="slightly-smaller">
238-
<a href="https://github.com/pusher/pusher-websocket-swift/tree/9.2.2/Sources/Models/PusherChannel.swift#L4-L180">Show on GitHub</a>
238+
<a href="https://github.com/pusher/pusher-websocket-swift/tree/10.1.0/Sources/Models/PusherChannel.swift#L4-L158">Show on GitHub</a>
239239
</div>
240240
</section>
241241
</div>
@@ -268,7 +268,7 @@ <h4>Declaration</h4>
268268
</div>
269269
</div>
270270
<div class="slightly-smaller">
271-
<a href="https://github.com/pusher/pusher-websocket-swift/tree/9.2.2/Sources/Models/PusherChannels.swift#L4-L129">Show on GitHub</a>
271+
<a href="https://github.com/pusher/pusher-websocket-swift/tree/10.1.0/Sources/Models/PusherChannels.swift#L4-L135">Show on GitHub</a>
272272
</div>
273273
</section>
274274
</div>
@@ -301,7 +301,7 @@ <h4>Declaration</h4>
301301
</div>
302302
</div>
303303
<div class="slightly-smaller">
304-
<a href="https://github.com/pusher/pusher-websocket-swift/tree/9.2.2/Sources/Models/PusherClientOptions.swift#L4-L33">Show on GitHub</a>
304+
<a href="https://github.com/pusher/pusher-websocket-swift/tree/10.1.0/Sources/Models/PusherClientOptions.swift#L4-L33">Show on GitHub</a>
305305
</div>
306306
</section>
307307
</div>
@@ -333,7 +333,7 @@ <h4>Declaration</h4>
333333
</div>
334334
</div>
335335
<div class="slightly-smaller">
336-
<a href="https://github.com/pusher/pusher-websocket-swift/tree/9.2.2/Sources/Models/PusherError.swift#L4-L29">Show on GitHub</a>
336+
<a href="https://github.com/pusher/pusher-websocket-swift/tree/10.1.0/Sources/Models/PusherError.swift#L4-L25">Show on GitHub</a>
337337
</div>
338338
</section>
339339
</div>
@@ -365,7 +365,7 @@ <h4>Declaration</h4>
365365
</div>
366366
</div>
367367
<div class="slightly-smaller">
368-
<a href="https://github.com/pusher/pusher-websocket-swift/tree/9.2.2/Sources/Models/PusherEvent.swift#L4-L88">Show on GitHub</a>
368+
<a href="https://github.com/pusher/pusher-websocket-swift/tree/10.1.0/Sources/Models/PusherEvent.swift#L4-L88">Show on GitHub</a>
369369
</div>
370370
</section>
371371
</div>
@@ -398,7 +398,7 @@ <h4>Declaration</h4>
398398
</div>
399399
</div>
400400
<div class="slightly-smaller">
401-
<a href="https://github.com/pusher/pusher-websocket-swift/tree/9.2.2/Sources/Models/PusherGlobalChannel.swift#L4-L85">Show on GitHub</a>
401+
<a href="https://github.com/pusher/pusher-websocket-swift/tree/10.1.0/Sources/Models/PusherGlobalChannel.swift#L4-L58">Show on GitHub</a>
402402
</div>
403403
</section>
404404
</div>
@@ -431,7 +431,7 @@ <h4>Declaration</h4>
431431
</div>
432432
</div>
433433
<div class="slightly-smaller">
434-
<a href="https://github.com/pusher/pusher-websocket-swift/tree/9.2.2/Sources/Models/PusherPresenceChannel.swift#L6-L178">Show on GitHub</a>
434+
<a href="https://github.com/pusher/pusher-websocket-swift/tree/10.1.0/Sources/Models/PusherPresenceChannel.swift#L6-L179">Show on GitHub</a>
435435
</div>
436436
</section>
437437
</div>
@@ -464,7 +464,7 @@ <h4>Declaration</h4>
464464
</div>
465465
</div>
466466
<div class="slightly-smaller">
467-
<a href="https://github.com/pusher/pusher-websocket-swift/tree/9.2.2/Sources/Models/PusherPresenceChannelMember.swift#L4-L12">Show on GitHub</a>
467+
<a href="https://github.com/pusher/pusher-websocket-swift/tree/10.1.0/Sources/Models/PusherPresenceChannelMember.swift#L4-L12">Show on GitHub</a>
468468
</div>
469469
</section>
470470
</div>
@@ -497,7 +497,7 @@ <h4>Declaration</h4>
497497
</div>
498498
</div>
499499
<div class="slightly-smaller">
500-
<a href="https://github.com/pusher/pusher-websocket-swift/tree/9.2.2/Sources/ObjC/OCAuthMethod.swift#L4-L34">Show on GitHub</a>
500+
<a href="https://github.com/pusher/pusher-websocket-swift/tree/10.1.0/Sources/ObjC/OCAuthMethod.swift#L4-L34">Show on GitHub</a>
501501
</div>
502502
</section>
503503
</div>
@@ -530,7 +530,7 @@ <h4>Declaration</h4>
530530
</div>
531531
</div>
532532
<div class="slightly-smaller">
533-
<a href="https://github.com/pusher/pusher-websocket-swift/tree/9.2.2/Sources/ObjC/OCPusherHost.swift#L4-L22">Show on GitHub</a>
533+
<a href="https://github.com/pusher/pusher-websocket-swift/tree/10.1.0/Sources/ObjC/OCPusherHost.swift#L4-L22">Show on GitHub</a>
534534
</div>
535535
</section>
536536
</div>
@@ -563,7 +563,7 @@ <h4>Declaration</h4>
563563
</div>
564564
</div>
565565
<div class="slightly-smaller">
566-
<a href="https://github.com/pusher/pusher-websocket-swift/tree/9.2.2/Sources/PusherSwift.swift#L10-L172">Show on GitHub</a>
566+
<a href="https://github.com/pusher/pusher-websocket-swift/tree/10.1.0/Sources/PusherSwift.swift#L10-L163">Show on GitHub</a>
567567
</div>
568568
</section>
569569
</div>
@@ -573,11 +573,10 @@ <h4>Declaration</h4>
573573
</section>
574574
</section>
575575
<section id="footer">
576-
<p>&copy; 2021 <a class="link" href="https://pusher.com" target="_blank" rel="external">Pusher</a>. All rights reserved. (Last updated: 2021-07-07)</p>
577-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
576+
<p>&copy; 2022 <a class="link" href="https://pusher.com" target="_blank" rel="external noopener">Pusher</a>. All rights reserved. (Last updated: 2022-07-15)</p>
577+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
578578
</section>
579579
</article>
580580
</div>
581581
</body>
582-
</div>
583582
</html>

‎docs/Classes/GlobalChannel.html

Lines changed: 10 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,19 @@
1717
<a title="GlobalChannel Class Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="../index.html">PusherSwift 9.2.2 Docs</a> (25% documented)</p>
21-
<p class="header-right"><a href="https://github.com/pusher/pusher-websocket-swift"><img src="../img/gh.png"/>View on GitHub</a></p>
22-
<p class="header-right">
20+
<p><a href="../index.html">PusherSwift 10.1.0 Docs</a> (24% documented)</p>
21+
<p class="header-right"><a href="https://github.com/pusher/pusher-websocket-swift"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
22+
<div class="header-right">
2323
<form role="search" action="../search.json">
2424
<input type="text" placeholder="Search documentation" data-typeahead>
2525
</form>
26-
</p>
26+
</div>
2727
</div>
2828
</header>
2929
<div class="content-wrapper">
3030
<p id="breadcrumbs">
3131
<a href="../index.html">PusherSwift Reference</a>
32-
<img id="carat" src="../img/carat.png" />
32+
<img id="carat" src="../img/carat.png" alt=""/>
3333
GlobalChannel Class Reference
3434
</p>
3535
</div>
@@ -148,7 +148,7 @@ <h1>GlobalChannel</h1>
148148
<p>Undocumented</p>
149149

150150
<div class="slightly-smaller">
151-
<a href="https://github.com/pusher/pusher-websocket-swift/tree/9.2.2/Sources/Models/PusherGlobalChannel.swift#L4-L85">Show on GitHub</a>
151+
<a href="https://github.com/pusher/pusher-websocket-swift/tree/10.1.0/Sources/Models/PusherGlobalChannel.swift#L4-L58">Show on GitHub</a>
152152
</div>
153153
</section>
154154
<section class="section task-group-section">
@@ -179,37 +179,7 @@ <h4>Declaration</h4>
179179
</div>
180180
</div>
181181
<div class="slightly-smaller">
182-
<a href="https://github.com/pusher/pusher-websocket-swift/tree/9.2.2/Sources/Models/PusherGlobalChannel.swift#L">Show on GitHub</a>
183-
</div>
184-
</section>
185-
</div>
186-
</li>
187-
<li class="item">
188-
<div>
189-
<code>
190-
<a name="/s:11PusherSwift13GlobalChannelC21globalLegacyCallbacksSDySSyypSgcGvp"></a>
191-
<a name="//apple_ref/swift/Property/globalLegacyCallbacks" class="dashAnchor"></a>
192-
<a class="token" href="#/s:11PusherSwift13GlobalChannelC21globalLegacyCallbacksSDySSyypSgcGvp">globalLegacyCallbacks</a>
193-
</code>
194-
</div>
195-
<div class="height-container">
196-
<div class="pointer-container"></div>
197-
<section class="section">
198-
<div class="pointer"></div>
199-
<div class="abstract">
200-
<p>Undocumented</p>
201-
202-
</div>
203-
<div class="declaration">
204-
<h4>Declaration</h4>
205-
<div class="language">
206-
<p class="aside-title">Swift</p>
207-
<pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">globalLegacyCallbacks</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="p">(</span><span class="kt">Any</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">]</span></code></pre>
208-
209-
</div>
210-
</div>
211-
<div class="slightly-smaller">
212-
<a href="https://github.com/pusher/pusher-websocket-swift/tree/9.2.2/Sources/Models/PusherGlobalChannel.swift#L">Show on GitHub</a>
182+
<a href="https://github.com/pusher/pusher-websocket-swift/tree/10.1.0/Sources/Models/PusherGlobalChannel.swift#L5">Show on GitHub</a>
213183
</div>
214184
</section>
215185
</div>
@@ -239,7 +209,7 @@ <h4>Declaration</h4>
239209
</div>
240210
</div>
241211
<div class="slightly-smaller">
242-
<a href="https://github.com/pusher/pusher-websocket-swift/tree/9.2.2/Sources/Models/PusherGlobalChannel.swift#L81-L84">Show on GitHub</a>
212+
<a href="https://github.com/pusher/pusher-websocket-swift/tree/10.1.0/Sources/Models/PusherGlobalChannel.swift#L55-L57">Show on GitHub</a>
243213
</div>
244214
</section>
245215
</div>
@@ -249,11 +219,10 @@ <h4>Declaration</h4>
249219
</section>
250220
</section>
251221
<section id="footer">
252-
<p>&copy; 2021 <a class="link" href="https://pusher.com" target="_blank" rel="external">Pusher</a>. All rights reserved. (Last updated: 2021-07-07)</p>
253-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
222+
<p>&copy; 2022 <a class="link" href="https://pusher.com" target="_blank" rel="external noopener">Pusher</a>. All rights reserved. (Last updated: 2022-07-15)</p>
223+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
254224
</section>
255225
</article>
256226
</div>
257227
</body>
258-
</div>
259228
</html>

0 commit comments

Comments
 (0)