Platforms to show: All Mac Windows Linux Cross-Platform

Back to IOBluetoothDeviceSelectorControllerMBS class.

IOBluetoothDeviceSelectorControllerMBS.addAllowedUUID(allowedUUID as IOBluetoothSDPUUIDMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Bluetooth MBS Bluetooth Plugin 18.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Adds a UUID to the list of UUIDs that are used to validate the user's selection.

allowedUUID: UUID that a device may contain to be selected

The user's device selection gets validated against the UUIDs passed to addAllowedUUID or addAllowedUUIDArray. Each call to those methods essentially adds a filter that the selected device gets validated with. If any of the filters match, the device is considered valid. If they all fail, the device is not valid and the user is presented with an error code that the device does not support the required services. The UUID passed to addAllowedUUID is the only UUID that must be present in the device's SDP service records. Alternatively, all of the UUIDs in the UUID array passed to addAllowedUUIDArray must be present.

NOTE: This method is only available in macOS 10.2.4 (Bluetooth v1.1) or later.

IOBluetoothDeviceSelectorControllerMBS.addAllowedUUIDArray(allowedUUIDs() as IOBluetoothSDPUUIDMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Bluetooth MBS Bluetooth Plugin 18.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Adds an array of UUIDs to the list of UUIDs that are used to validate the user's selection.

allowedUUIDArray: An NSArray of UUIDs that all must be present in a device for it to be selectable.

The user's device selection gets validated against the UUIDs passed to addAllowedUUID or addAllowedUUIDArray. Each call to those methods essentially adds a filter that the selected device gets validated with. If any of the filters match, the device is considered valid. If they all fail, the device is not valid and the user is presented with an error code that the device does not support the required services. The UUID passed to addAllowedUUID is the only UUID that must be present in the device's SDP service records. Alternatively, all of the UUIDs in the UUID array passed to addAllowedUUIDArray must be present.

NOTE: This method is only available in macOS 10.2.4 (Bluetooth v1.1) or later.

IOBluetoothDeviceSelectorControllerMBS.beginSheetModalForWindow(win as DesktopWindow, tag as variant = nil)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Bluetooth MBS Bluetooth Plugin 22.0 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Runs the device selector panel as a sheet on the target window.

win: Window to attach the device selector panel to as a sheet.

Returns kIOReturnSuccess if the sheet modal session was started.

NOTE: This method is only available in macOS 10.2.4 (Bluetooth v1.1) or later.

See also:

IOBluetoothDeviceSelectorControllerMBS.beginSheetModalForWindow(win as window, tag as variant = nil)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Bluetooth MBS Bluetooth Plugin 18.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Runs the device selector panel as a sheet on the target window.

win: Window to attach the device selector panel to as a sheet.

Returns kIOReturnSuccess if the sheet modal session was started.

NOTE: This method is only available in macOS 10.2.4 (Bluetooth v1.1) or later.

See also:

IOBluetoothDeviceSelectorControllerMBS.clearAllowedUUIDs

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Bluetooth MBS Bluetooth Plugin 18.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Resets the controller back to the default state where it will accept any device the user selects.

This method is only available in macOS 10.2.4 (Bluetooth v1.1) or later.

IOBluetoothDeviceSelectorControllerMBS.Constructor

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Bluetooth MBS Bluetooth Plugin 18.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Creates a new device selector controller.

IOBluetoothDeviceSelectorControllerMBS.Destructor

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Bluetooth MBS Bluetooth Plugin 18.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The destructor.

IOBluetoothDeviceSelectorControllerMBS.Results as IOBluetoothDeviceMBS()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Bluetooth MBS Bluetooth Plugin 18.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Returns the result of the user's selection.

Returns an array of IOBluetoothDevice objects corresponding to the user's selection. If the user cancelled the panel, nil will be returned.

There will only be results if the panel has been run, the user has successfully made a selection and that selection has been validated. If kIOBluetoothUISuccess was returned for the session, there should be valid results. Currently only a single device is allowed to be selected, so the results array will only contain one object. However in the future multiple selection will be supported.

NOTE: This method is only available in macOS 10.2.4 (Bluetooth v1.1) or later.

IOBluetoothDeviceSelectorControllerMBS.runModal as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Bluetooth MBS Bluetooth Plugin 18.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Runs the device selector panel in a modal session to allow the user to select a Bluetooth device.

Returns kIOBluetoothUISuccess if a successful, validated device selection was made by the user. Returns kIOBluetoothUIUserCanceledErr if the user cancelled the panel. These return values are the same as NSRunStoppedResponse and NSRunAbortedResponse respectively. They are the standard values used in a modal session.

The controller will use the panel attributes to filter what devices the user sees. The allowed UUIDs will be used to validate the selection the user makes. Only when a selection has been validated (or the panel cancelled), will this method return.

NOTE: This method is only available in macOS 10.2.4 (Bluetooth v1.1) or later.

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


The biggest plugin in space...