8
8
< script src ="js/jquery.min.js " defer > </ script >
9
9
< script src ="js/jazzy.js " defer > </ script >
10
10
11
+ < script src ="js/lunr.min.js " defer > </ script >
12
+ < script src ="js/typeahead.jquery.js " defer > </ script >
13
+ < script src ="js/jazzy.search.js " defer > </ script >
11
14
</ head >
12
15
< body >
13
16
< a name ="//apple_ref/swift/Section/Classes " class ="dashAnchor "> </ a >
14
17
< a title ="Classes Reference "> </ a >
15
18
< header >
16
19
< div class ="content-wrapper ">
17
- < p > < a href ="index.html "> RxBluetoothKit 5.3 .0 Docs</ a > (80 % documented)</ p >
20
+ < p > < a href ="index.html "> RxBluetoothKit 6.0 .0 Docs</ a > (82 % documented)</ p >
18
21
< p class ="header-right "> < a href ="https://github.com/Polidea/RxBluetoothKit "> < img src ="img/gh.png "/> View on GitHub</ a > </ p >
22
+ < p class ="header-right ">
23
+ < form role ="search " action ="search.json ">
24
+ < input type ="text " placeholder ="Search documentation " data-typeahead >
25
+ </ form >
26
+ </ p >
19
27
</ div >
20
28
</ header >
21
29
< div class ="content-wrapper ">
@@ -190,10 +198,10 @@ <h1>Classes</h1>
190
198
< p > CentralManager is a class implementing ReactiveX API which wraps all Core Bluetooth Manager’s functions allowing to
191
199
discover, connect to remote peripheral devices and more.
192
200
You can start using this class by discovering available services of nearby peripherals. Before calling any
193
- public < code > CentralManager</ code > ‘s functions you should make sure that Bluetooth is turned on and powered on. It can be done
194
- by calling and observing returned value of < code > observeState ()</ code > and then chaining it with < code > scanForPeripherals(_:options:) </ code > : </ p >
195
- < pre class =" highlight swift " > < code > < span class =" k " > let </ span > < span class =" nv " > disposable </ span > < span class =" o " > = </ span > < span class =" n " > centralManager </ span > < span class =" o " > . </ span > < span class =" n " > observeState </ span >
196
- < span class ="o " > . </ span > < span class ="nf " > startWith </ span > < span class ="p " > ( </ span > < span class ="n "> centralManager</ span > < span class ="o "> .</ span > < span class ="n " > state </ span > < span class ="p "> )</ span >
201
+ public < code > CentralManager</ code > ‘s functions you should make sure that Bluetooth is turned on and powered on.
202
+ It can be done by calling and observing returned value of < code > observeStateWithInitialValue ()</ code > and then
203
+ chaining it with < code > scanForPeripherals(_:options:) </ code > : </ p >
204
+ < pre class =" highlight swift " > < code > < span class ="k " > let </ span > < span class ="nv " > disposable </ span > < span class ="o " > = </ span > < span class ="n "> centralManager</ span > < span class ="o "> .</ span > < span class ="nf " > observeStateWithInitialValue </ span > < span class ="p "> ( )</ span >
197
205
< span class ="o "> .</ span > < span class ="n "> filter</ span > < span class ="p "> {</ span > < span class ="nv "> $0</ span > < span class ="o "> ==</ span > < span class ="o "> .</ span > < span class ="n "> poweredOn</ span > < span class ="p "> }</ span >
198
206
< span class ="o "> .</ span > < span class ="nf "> take</ span > < span class ="p "> (</ span > < span class ="mi "> 1</ span > < span class ="p "> )</ span >
199
207
< span class ="o "> .</ span > < span class ="n "> flatMap</ span > < span class ="p "> {</ span > < span class ="n "> centralManager</ span > < span class ="o "> .</ span > < span class ="nf "> scanForPeripherals</ span > < span class ="p "> (</ span > < span class ="kc "> nil</ span > < span class ="p "> )</ span > < span class ="p "> }</ span >
@@ -221,15 +229,11 @@ <h4>Declaration</h4>
221
229
</ div >
222
230
</ div >
223
231
< div class ="slightly-smaller ">
224
- < a href ="https://github.com/Polidea/RxBluetoothKit/tree/5.3 .0/Source/CentralManager.swift#L27-L309 "> Show on GitHub</ a >
232
+ < a href ="https://github.com/Polidea/RxBluetoothKit/tree/6.0 .0/Source/CentralManager.swift#L27-L342 "> Show on GitHub</ a >
225
233
</ div >
226
234
</ section >
227
235
</ div >
228
236
</ li >
229
- </ ul >
230
- </ div >
231
- < div class ="task-group ">
232
- < ul >
233
237
< li class ="item ">
234
238
< div >
235
239
< code >
@@ -252,19 +256,16 @@ <h4>Declaration</h4>
252
256
< div class ="language ">
253
257
< p class ="aside-title "> Swift</ p >
254
258
< pre class ="highlight swift "> < code > < span class ="kd "> public</ span > < span class ="kd "> class</ span > < span class ="kt "> Characteristic</ span > </ code > </ pre >
259
+ < pre class ="highlight swift "> < code > < span class ="kd "> extension</ span > < span class ="kt "> Characteristic</ span > < span class ="p "> :</ span > < span class ="kt "> Equatable</ span > </ code > </ pre >
255
260
256
261
</ div >
257
262
</ div >
258
263
< div class ="slightly-smaller ">
259
- < a href ="https://github.com/Polidea/RxBluetoothKit/tree/5.3 .0/Source/Characteristic.swift#L6-L180 "> Show on GitHub</ a >
264
+ < a href ="https://github.com/Polidea/RxBluetoothKit/tree/6.0 .0/Source/Characteristic.swift#L6-L180 "> Show on GitHub</ a >
260
265
</ div >
261
266
</ section >
262
267
</ div >
263
268
</ li >
264
- </ ul >
265
- </ div >
266
- < div class ="task-group ">
267
- < ul >
268
269
< li class ="item ">
269
270
< div >
270
271
< code >
@@ -289,19 +290,16 @@ <h4>Declaration</h4>
289
290
< div class ="language ">
290
291
< p class ="aside-title "> Swift</ p >
291
292
< pre class ="highlight swift "> < code > < span class ="kd "> public</ span > < span class ="kd "> class</ span > < span class ="kt "> Descriptor</ span > </ code > </ pre >
293
+ < pre class ="highlight swift "> < code > < span class ="kd "> extension</ span > < span class ="kt "> Descriptor</ span > < span class ="p "> :</ span > < span class ="kt "> Equatable</ span > </ code > </ pre >
292
294
293
295
</ div >
294
296
</ div >
295
297
< div class ="slightly-smaller ">
296
- < a href ="https://github.com/Polidea/RxBluetoothKit/tree/5.3 .0/Source/Descriptor.swift#L8-L104 "> Show on GitHub</ a >
298
+ < a href ="https://github.com/Polidea/RxBluetoothKit/tree/6.0 .0/Source/Descriptor.swift#L8-L104 "> Show on GitHub</ a >
297
299
</ div >
298
300
</ section >
299
301
</ div >
300
302
</ li >
301
- </ ul >
302
- </ div >
303
- < div class ="task-group ">
304
- < ul >
305
303
< li class ="item ">
306
304
< div >
307
305
< code >
@@ -328,15 +326,11 @@ <h4>Declaration</h4>
328
326
</ div >
329
327
</ div >
330
328
< div class ="slightly-smaller ">
331
- < a href ="https://github.com/Polidea/RxBluetoothKit/tree/5.3 .0/Source/Logging.swift#L6-L105 "> Show on GitHub</ a >
329
+ < a href ="https://github.com/Polidea/RxBluetoothKit/tree/6.0 .0/Source/Logging.swift#L6-L105 "> Show on GitHub</ a >
332
330
</ div >
333
331
</ section >
334
332
</ div >
335
333
</ li >
336
- </ ul >
337
- </ div >
338
- < div class ="task-group ">
339
- < ul >
340
334
< li class ="item ">
341
335
< div >
342
336
< code >
@@ -360,19 +354,16 @@ <h4>Declaration</h4>
360
354
< div class ="language ">
361
355
< p class ="aside-title "> Swift</ p >
362
356
< pre class ="highlight swift "> < code > < span class ="kd "> public</ span > < span class ="kd "> class</ span > < span class ="kt "> Peripheral</ span > </ code > </ pre >
357
+ < pre class ="highlight swift "> < code > < span class ="kd "> extension</ span > < span class ="kt "> Peripheral</ span > < span class ="p "> :</ span > < span class ="kt "> Equatable</ span > </ code > </ pre >
363
358
364
359
</ div >
365
360
</ div >
366
361
< div class ="slightly-smaller ">
367
- < a href ="https://github.com/Polidea/RxBluetoothKit/tree/5.3 .0/Source/Peripheral.swift#L10-L873 "> Show on GitHub</ a >
362
+ < a href ="https://github.com/Polidea/RxBluetoothKit/tree/6.0 .0/Source/Peripheral.swift#L10-L873 "> Show on GitHub</ a >
368
363
</ div >
369
364
</ section >
370
365
</ div >
371
366
</ li >
372
- </ ul >
373
- </ div >
374
- < div class ="task-group ">
375
- < ul >
376
367
< li class ="item ">
377
368
< div >
378
369
< code >
@@ -390,9 +381,8 @@ <h4>Declaration</h4>
390
381
advertise, to publish L2CAP channels and more.
391
382
You can start using this class by adding services and starting advertising.
392
383
Before calling any public < code > PeripheralManager</ code > ‘s functions you should make sure that Bluetooth is turned on and powered on. It can be done
393
- by < code > observeState()</ code > , observing it’s value and then chaining it with < code > add(_:)</ code > and < code > startAdvertising(_:)</ code > :</ p >
394
- < pre class ="highlight swift "> < code > < span class ="k "> let</ span > < span class ="nv "> disposable</ span > < span class ="o "> =</ span > < span class ="n "> centralManager</ span > < span class ="o "> .</ span > < span class ="n "> observeState</ span >
395
- < span class ="o "> .</ span > < span class ="nf "> startWith</ span > < span class ="p "> (</ span > < span class ="n "> centralManager</ span > < span class ="o "> .</ span > < span class ="n "> state</ span > < span class ="p "> )</ span >
384
+ by < code > observeStateWithInitialValue()</ code > , observing it’s value and then chaining it with < code > add(_:)</ code > and < code > startAdvertising(_:)</ code > :</ p >
385
+ < pre class ="highlight swift "> < code > < span class ="k "> let</ span > < span class ="nv "> disposable</ span > < span class ="o "> =</ span > < span class ="n "> centralManager</ span > < span class ="o "> .</ span > < span class ="nf "> observeStateWithInitialValue</ span > < span class ="p "> ()</ span >
396
386
< span class ="o "> .</ span > < span class ="n "> filter</ span > < span class ="p "> {</ span > < span class ="nv "> $0</ span > < span class ="o "> ==</ span > < span class ="o "> .</ span > < span class ="n "> poweredOn</ span > < span class ="p "> }</ span >
397
387
< span class ="o "> .</ span > < span class ="nf "> take</ span > < span class ="p "> (</ span > < span class ="mi "> 1</ span > < span class ="p "> )</ span >
398
388
< span class ="o "> .</ span > < span class ="n "> flatMap</ span > < span class ="p "> {</ span > < span class ="n "> centralManager</ span > < span class ="o "> .</ span > < span class ="nf "> add</ span > < span class ="p "> (</ span > < span class ="n "> myService</ span > < span class ="p "> )</ span > < span class ="p "> }</ span >
@@ -414,15 +404,11 @@ <h4>Declaration</h4>
414
404
</ div >
415
405
</ div >
416
406
< div class ="slightly-smaller ">
417
- < a href ="https://github.com/Polidea/RxBluetoothKit/tree/5.3 .0/Source/PeripheralManager.swift#L22-L376 "> Show on GitHub</ a >
407
+ < a href ="https://github.com/Polidea/RxBluetoothKit/tree/6.0 .0/Source/PeripheralManager.swift#L21-L387 "> Show on GitHub</ a >
418
408
</ div >
419
409
</ section >
420
410
</ div >
421
411
</ li >
422
- </ ul >
423
- </ div >
424
- < div class ="task-group ">
425
- < ul >
426
412
< li class ="item ">
427
413
< div >
428
414
< code >
@@ -450,15 +436,11 @@ <h4>Declaration</h4>
450
436
</ div >
451
437
</ div >
452
438
< div class ="slightly-smaller ">
453
- < a href ="https://github.com/Polidea/RxBluetoothKit/tree/5.3 .0/Source/ScannedPeripheral.swift#L6-L22 "> Show on GitHub</ a >
439
+ < a href ="https://github.com/Polidea/RxBluetoothKit/tree/6.0 .0/Source/ScannedPeripheral.swift#L6-L22 "> Show on GitHub</ a >
454
440
</ div >
455
441
</ section >
456
442
</ div >
457
443
</ li >
458
- </ ul >
459
- </ div >
460
- < div class ="task-group ">
461
- < ul >
462
444
< li class ="item ">
463
445
< div >
464
446
< code >
@@ -481,11 +463,12 @@ <h4>Declaration</h4>
481
463
< div class ="language ">
482
464
< p class ="aside-title "> Swift</ p >
483
465
< pre class ="highlight swift "> < code > < span class ="kd "> public</ span > < span class ="kd "> class</ span > < span class ="kt "> Service</ span > </ code > </ pre >
466
+ < pre class ="highlight swift "> < code > < span class ="kd "> extension</ span > < span class ="kt "> Service</ span > < span class ="p "> :</ span > < span class ="kt "> Equatable</ span > </ code > </ pre >
484
467
485
468
</ div >
486
469
</ div >
487
470
< div class ="slightly-smaller ">
488
- < a href ="https://github.com/Polidea/RxBluetoothKit/tree/5.3 .0/Source/Service.swift#L6-L81 "> Show on GitHub</ a >
471
+ < a href ="https://github.com/Polidea/RxBluetoothKit/tree/6.0 .0/Source/Service.swift#L6-L81 "> Show on GitHub</ a >
489
472
</ div >
490
473
</ section >
491
474
</ div >
@@ -495,8 +478,8 @@ <h4>Declaration</h4>
495
478
</ section >
496
479
</ section >
497
480
< section id ="footer ">
498
- < p > © 2019 < a class ="link " href ="https://polidea.com " target ="_blank " rel ="external "> Polidea</ a > . All rights reserved. (Last updated: 2019-07-26 )</ p >
499
- < p > Generated by < a class ="link " href ="https://github.com/realm/jazzy " target ="_blank " rel ="external "> jazzy ♪♫ v0.10.0 </ a > , a < a class ="link " href ="https://realm.io " target ="_blank " rel ="external "> Realm</ a > project.</ p >
481
+ < p > © 2020 < a class ="link " href ="https://polidea.com " target ="_blank " rel ="external "> Polidea</ a > . All rights reserved. (Last updated: 2020-09-04 )</ p >
482
+ < p > Generated by < a class ="link " href ="https://github.com/realm/jazzy " target ="_blank " rel ="external "> jazzy ♪♫ v0.13.5 </ a > , a < a class ="link " href ="https://realm.io " target ="_blank " rel ="external "> Realm</ a > project.</ p >
500
483
</ section >
501
484
</ article >
502
485
</ div >
0 commit comments