Monkeybread Xojo plugin - CBPeripheralManagerMBS class

Platforms to show: All Mac Windows Linux Cross-Platform

CBPeripheralManagerMBS class

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
class	Bluetooth	MBS Bluetooth Plugin	18.1	✅ Yes	❌ No	❌ No	✅ Yes	All

The CoreBluetooth peripheral manager class.

CBPeripheralManager objects are used to manage published services within the local peripheral device’s Generic Attribute Profile (GATT) database and to advertise these services to central devices (represented by CBCentral objects). While a service is in the database, it is visible to, and can be accessed by, any connected central. That said, if your app has not specified the bluetooth-peripheral background mode, the contents of its services become disabled when it is in the background or in a suspended state; any remote central trying to access the service’s characteristic value or characteristic descriptors receives an error.

Before you call CBPeripheralManager methods, the state of the peripheral manager object must be powered on, as indicated by the kStatePoweredOn. This state indicates that the peripheral device (your iPhone or iPad, for instance) supports Bluetooth low energy and that its Bluetooth is on and available to use.
Subclass of the CBManagerMBS class.

12 events
- event DidAddService(service as CBServiceMBS, error as NSErrorMBS)
- event DidOpenL2CAPChannel(channel as CBL2CAPChannelMBS, error as NSErrorMBS)
- event DidPublishL2CAPChannel(PSM as Integer, error as NSErrorMBS)
- event DidReceiveReadRequest(Request as CBATTRequestMBS)
- event DidReceiveWriteRequests(requests() as CBATTRequestMBS)
- event DidStartAdvertising(error as NSErrorMBS)
- event DidSubscribeToCharacteristic(central as CBCentralMBS, characteristic as CBCharacteristicMBS)
- event DidUnpublishL2CAPChannel(PSM as Integer, error as NSErrorMBS)
- event DidUnsubscribeFromCharacteristic(central as CBCentralMBS, characteristic as CBCharacteristicMBS)
- event DidUpdateState
- event IsReadyToUpdateSubscribers
- event WillRestoreState(dic as dictionary)
property isAdvertising as Boolean
10 methods
- method addService(service as CBMutableServiceMBS)
- method Constructor(options as Dictionary = nil)
- method Destructor
- method removeAllServices
- method removeService(service as CBMutableServiceMBS)
- method respondToRequest(request as CBATTRequestMBS, error as integer)
- method setDesiredConnectionLatency(latency as integer, central as CBCentralMBS)
- method startAdvertising(advertisementData as Dictionary)
- method stopAdvertising
- method updateValue(value as MemoryBlock, characteristic as CBMutableCharacteristicMBS, onSubscribedCentrals() as CBCentralMBS = nil) as Boolean
6 shared methods
- shared method authorizationStatus as integer
- shared method Available as boolean
- shared method CBPeripheralManagerOptionRestoreIdentifierKey as String
- shared method CBPeripheralManagerOptionShowPowerAlertKey as String
- shared method CBPeripheralManagerRestoredStateAdvertisementDataKey as String
- shared method CBPeripheralManagerRestoredStateServicesKey as String
13 constants

Authorization States

Constant	Value	Description
kAuthorizationStatusAuthorized	3	This app is authorized to share data using Bluetooth services while in the background state.
kAuthorizationStatusDenied	2	The user explicitly denied this app from sharing data using Bluetooth services while in the background state.
kAuthorizationStatusNotDetermined	0	The user has not yet made a choice regarding whether this app can share data using Bluetooth services while in the background state.
kAuthorizationStatusRestricted	1	This app is not authorized to share data using Bluetooth services while in the background state. The user cannot change this app’s status, possibly due to active restrictions such as parental controls being in place.

Latencies

Constant	Value	Description
kConnectionLatencyHigh	2	Extending battery life has priority over rapid communication.
kConnectionLatencyLow	0	Rapid communication has priority over battery life.
kConnectionLatencyMedium	1	A balance exits between communication frequency and battery life.

States

Constant	Value	Description
kStatePoweredOff	4	Bluetooth is currently powered off.
kStatePoweredOn	5	Bluetooth is currently powered on and is available to use.
kStateResetting	1	The connection with the system service was momentarily lost; an update is imminent.
kStateUnauthorized	3	The app is not authorized to use the Bluetooth low energy peripheral/server role.
kStateUnknown	0	The current state of the peripheral manager is unknown; an update is imminent.
kStateUnsupported	2	The platform doesn't support the Bluetooth low energy peripheral/server role.

Super class CBManagerMBS

3 properties
- property authorization as Integer
- property Handle as Integer
- property State as Integer
method Constructor Private
shared method Available as boolean
10 constants

Authorization States

Constant	Value	Description
kAuthorizationStatusAuthorized	3	This app is authorized to share data using Bluetooth services while in the background state.
kAuthorizationStatusDenied	2	The user explicitly denied this app from sharing data using Bluetooth services while in the background state.
kAuthorizationStatusNotDetermined	0	The user has not yet made a choice regarding whether this app can share data using Bluetooth services while in the background state.
kAuthorizationStatusRestricted	1	This app is not authorized to share data using Bluetooth services while in the background state. The user cannot change this app’s status, possibly due to active restrictions such as parental controls being in place.

States

Constant	Value	Description
kStatePoweredOff	4	Bluetooth is currently powered off.
kStatePoweredOn	5	Bluetooth is currently powered on and available to use.
kStateResetting	1	The connection with the system service was momentarily lost, update imminent.
kStateUnauthorized	3	The application is not authorized to use the Bluetooth Low Energy role.
kStateUnknown	0	State unknown, update imminent.
kStateUnsupported	2	The platform doesn't support the Bluetooth Low Energy Central/Client role.

This class has no sub classes.

The items on this page are in the following plugins: MBS Bluetooth Plugin.

CBPeerMBS - CBPeripheralMBS

💬 Ask a question or report a problem