Xojo Conferences
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

CBCentralManagerMBS.Available as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method Bluetooth MBS Bluetooth Plugin 18.1 Yes No No Yes, macOS only No
Function: Whether this class is available.
Notes: Returns true on MacOS 10.7 or later.

Feedback, Comments & Corrections

CBCentralManagerMBS.CBATTErrorDomain as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method Bluetooth MBS Bluetooth Plugin 18.1 Yes No No Yes, macOS only No
Function: The domain for Core Bluetooth ATT errors.
Notes: This value is used in the NSError class.

Feedback, Comments & Corrections

CBCentralManagerMBS.CBCentralManagerOptionRestoreIdentifierKey as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method Bluetooth MBS Bluetooth Plugin 18.1 Yes No No Yes, macOS only No
Function: One of the keys used to pass options to the CBCentralManager method.
Notes:
A string containing a unique identifier (UID) for the central manager that is being instantiated.
The system uses this UID to identify a specific central manager. As a result, the UID must remain the same for subsequent executions of the app in order for the central manager to be successfully restored.

Feedback, Comments & Corrections

CBCentralManagerMBS.CBCentralManagerOptionShowPowerAlertKey as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method Bluetooth MBS Bluetooth Plugin 18.1 Yes No No Yes, macOS only No
Function: One of the keys used to pass options to the CBCentralManager method.
Notes:
A Boolean value that specifies whether the system should display a warning dialog to the user if Bluetooth is powered off when the central manager is instantiated.
The value for this key is a number. If the key is not specified, the default value is false.

Feedback, Comments & Corrections

CBCentralManagerMBS.CBCentralManagerRestoredStatePeripheralsKey as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method Bluetooth MBS Bluetooth Plugin 18.1 Yes No No Yes, macOS only No
Function: One of the options keys.
Notes:
See connectPeripheral method.
An array of CBPeripheral objects containing all peripherals that were connected or pending connection at the time the application was terminated by the system. When possible, all known information for each peripheral will be restored, including any discovered services, characteristics and descriptors, as well as characteristic notification states.

Feedback, Comments & Corrections

CBCentralManagerMBS.CBCentralManagerRestoredStateScanOptionsKey as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method Bluetooth MBS Bluetooth Plugin 18.1 Yes No No Yes, macOS only No
Function: One of the options keys.
Notes:
A dictionary containing the scan options at the time the application was terminated by the system.
See also scanForPeripheralsWithServices method.

Feedback, Comments & Corrections

CBCentralManagerMBS.CBCentralManagerRestoredStateScanServicesKey as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method Bluetooth MBS Bluetooth Plugin 18.1 Yes No No Yes, macOS only No
Function: One of the options keys.
Notes:
An array of CBUUID objects containing the service(s) being scanned for at the time the application was terminated by the system.
See also scanForPeripheralsWithServices method.

Feedback, Comments & Corrections

CBCentralManagerMBS.CBCentralManagerScanOptionAllowDuplicatesKey as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method Bluetooth MBS Bluetooth Plugin 18.1 Yes No No Yes, macOS only No
Function: One of the keys used to pass options to the scanForPeripheralsWithServices method.
Notes:
A Boolean value that specifies whether the scan should run without duplicate filtering.
The value for this key is a number. If true, filtering is disabled and a discovery event is generated each time the central receives an advertising packet from the peripheral. Disabling this filtering can have an adverse effect on battery life and should be used only if necessary. If false, multiple discoveries of the same peripheral are coalesced into a single discovery event. If the key is not specified, the default value is false.

Feedback, Comments & Corrections

CBCentralManagerMBS.CBCentralManagerScanOptionSolicitedServiceUUIDsKey as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method Bluetooth MBS Bluetooth Plugin 18.1 Yes No No Yes, macOS only No
Function: One of the keys used to pass options to the scanForPeripheralsWithServices method.
Notes:
An array of service UUIDs (represented by CBUUID objects) that you want to scan for.
Specifying this scan option causes the central manager to also scan for peripherals soliciting any of the services contained in the array.

Feedback, Comments & Corrections

CBCentralManagerMBS.CBConnectPeripheralOptionNotifyOnConnectionKey as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method Bluetooth MBS Bluetooth Plugin 18.1 Yes No No Yes, macOS only No
Function: One of the keys used to pass options to the connectPeripheral method.
Notes:
A Boolean value that specifies whether the system should display an alert for a given peripheral if the app is suspended when a successful connection is made.
The value for this key is a number. This key is useful for apps that have not specified the bluetooth-central background mode and cannot display their own alert. If more than one app has requested notification for a given peripheral, the one that was most recently in the foreground receives the alert. If the key is not specified, the default value is false.

Feedback, Comments & Corrections

CBCentralManagerMBS.CBConnectPeripheralOptionNotifyOnDisconnectionKey as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method Bluetooth MBS Bluetooth Plugin 18.1 Yes No No Yes, macOS only No
Function: One of the keys used to pass options to the connectPeripheral method.
Notes:
A Boolean value that specifies whether the system should display a disconnection alert for a given peripheral if the app is suspended at the time of the disconnection.
The value for this key is a number. This key is useful for apps that have not specified the bluetooth-central background mode and cannot display their own alert. If more than one app has requested notification for a given peripheral, the one that was most recently in the foreground receives the alert. If the key is not specified, the default value is false.

Feedback, Comments & Corrections

CBCentralManagerMBS.CBConnectPeripheralOptionNotifyOnNotificationKey as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method Bluetooth MBS Bluetooth Plugin 18.1 Yes No No Yes, macOS only No
Function: One of the keys used to pass options to the connectPeripheral method.
Notes:
A Boolean value that specifies whether the system should display an alert for all notifications received from a given peripheral if the app is suspended at the time.
The value for this key is a number. This key is useful for apps that have not specified the bluetooth-central background mode and cannot display their own alert. If more than one app has requested notification for a given peripheral, the one that was most recently in the foreground receives the alert. If the key is not specified, the default value is false.

Feedback, Comments & Corrections

CBCentralManagerMBS.CBErrorDomain as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method Bluetooth MBS Bluetooth Plugin 18.1 Yes No No Yes, macOS only No
Function: The domain for Core Bluetooth errors.
Notes: This value is used in the NSError class.

Feedback, Comments & Corrections

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




Links
MBS Xojo blog