Xojo Conferences
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

IOBluetoothDeviceMBS.addressString as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Bluetooth MBS Bluetooth Plugin 18.3 Yes No No Yes, macOS only No
Function: Get the Bluetooth device address for the target device.
Notes: (Read only property)

Feedback, Comments & Corrections

IOBluetoothDeviceMBS.classOfDevice as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Bluetooth MBS Bluetooth Plugin 18.3 Yes No No Yes, macOS only No
Function: Gets the full class of device value for the remote device.
Notes:
This value is only meaningful if the target device has been seen during an inquiry. This can be by checking the result of LastInquiryUpdate. If nil is returned, then the device hasn't been seen.
(Read only property)

Feedback, Comments & Corrections

IOBluetoothDeviceMBS.ClockOffset as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Bluetooth MBS Bluetooth Plugin 18.3 Yes No No Yes, macOS only No
Function: Get the clock offset value of the device.
Notes:
This value is only meaningful if the target device has been seen during an inquiry. This can be by checking the result of LastInquiryUpdate. If nil is returned, then the device hasn't been seen.
(Read only property)

Feedback, Comments & Corrections

IOBluetoothDeviceMBS.deviceClassMajor as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Bluetooth MBS Bluetooth Plugin 18.3 Yes No No Yes, macOS only No
Function: Get the major device class of the device.
Notes:
This value is only meaningful if the target device has been seen during an inquiry. This can be by checking the result of LastInquiryUpdate. If nil is returned, then the device hasn't been seen.
(Read only property)

Feedback, Comments & Corrections

IOBluetoothDeviceMBS.deviceClassMinor as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Bluetooth MBS Bluetooth Plugin 18.3 Yes No No Yes, macOS only No
Function: Get the minor service class of the device.
Notes:
This value is only meaningful if the target device has been seen during an inquiry. This can be by checking the result of LastInquiryUpdate. If nil is returned, then the device hasn't been seen.
(Read only property)

Feedback, Comments & Corrections

IOBluetoothDeviceMBS.EncryptionMode as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Bluetooth MBS Bluetooth Plugin 18.3 Yes No No Yes, macOS only No
Function: Get the encryption mode for the baseband connection.
Notes:
Returns the encryption mode for the baseband connection. If no baseband connection is present, kEncryptionDisabled is returned.

This method only returns a valid result if a baseband connection is present (isConnected returns true).
(Read only property)

Feedback, Comments & Corrections

IOBluetoothDeviceMBS.Handle as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Bluetooth MBS Bluetooth Plugin 18.3 Yes No No Yes, macOS only No
Function: The internal object reference.
Notes: (Read and Write property)

Feedback, Comments & Corrections

IOBluetoothDeviceMBS.isConnected as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Bluetooth MBS Bluetooth Plugin 18.3 Yes No No Yes, macOS only No
Function: Indicates whether a baseband connection to the device exists.
Notes:
Returns true if a baseband connection to the device exists.
(Read only property)

Feedback, Comments & Corrections

IOBluetoothDeviceMBS.isFavorite as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Bluetooth MBS Bluetooth Plugin 18.3 Yes No No Yes, macOS only No
Function: Reports whether the target device is a favorite for the user.
Notes:
Returns true if the target device is a favorite for the user, false if not.
(Read only property)

Feedback, Comments & Corrections

IOBluetoothDeviceMBS.isIncoming as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Bluetooth MBS Bluetooth Plugin 18.3 Yes No No Yes, macOS only No
Function: Returns true if the device connection was generated by the remote host.
Notes:
Returns true if the device connection was generated by the remote host. False if the connection was generated by some other device that connected to the local host.
(Read only property)

Feedback, Comments & Corrections

IOBluetoothDeviceMBS.isPaired as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Bluetooth MBS Bluetooth Plugin 18.3 Yes No No Yes, macOS only No
Function: Returns whether the target device is paired.
Notes:
Returns true if the target device is paired, false if not.
(Read only property)

Feedback, Comments & Corrections

IOBluetoothDeviceMBS.Lasterror as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Bluetooth MBS Bluetooth Plugin 18.3 Yes No No Yes, macOS only No
Function: The last error code.
Notes: (Read and Write property)

Feedback, Comments & Corrections

IOBluetoothDeviceMBS.LastInquiryUpdate as Date
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Bluetooth MBS Bluetooth Plugin 18.3 Yes No No Yes, macOS only No
Function: Get the date/time of the last time the device was returned during an inquiry.
Notes:
Returns the date/time of the last time the device was seen during an inquiry. If the device has never been seen during an inquiry, nil is returned.
(Read only property)

Feedback, Comments & Corrections

IOBluetoothDeviceMBS.lastNameUpdate as Date
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Bluetooth MBS Bluetooth Plugin 18.3 Yes No No Yes, macOS only No
Function: Get the date/time of the last successful remote name request.
Notes: (Read only property)

Feedback, Comments & Corrections

IOBluetoothDeviceMBS.LastServicesUpdate as Date
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Bluetooth MBS Bluetooth Plugin 18.3 Yes No No Yes, macOS only No
Function: Get the date/time of the last SDP query.
Notes:
Returns the date/time of the last SDP query. If an SDP query has never been performed on the device, nil is returned.
(Read only property)

Feedback, Comments & Corrections

IOBluetoothDeviceMBS.LinkType as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Bluetooth MBS Bluetooth Plugin 18.3 Yes No No Yes, macOS only No
Function: Get the link type for the baseband connection.
Notes:
Returns the link type for the baseband connection. If no baseband connection is present, kBluetoothLinkTypeNone is returned.
(Read only property)

Feedback, Comments & Corrections

IOBluetoothDeviceMBS.name as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Bluetooth MBS Bluetooth Plugin 18.3 Yes No No Yes, macOS only No
Function: Get the human readable name of the remote device.
Notes:
This only returns a value if a remote name request has been performed on the target device. If a successful remote name request has not been completed, nil is returned. To perform a remote name request, call remoteNameRequest. If a remote name request has been successfully completed, the method LastNameUpdate will return the date/time of the last successful request.
(Read only property)

Feedback, Comments & Corrections

IOBluetoothDeviceMBS.nameOrAddress as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Bluetooth MBS Bluetooth Plugin 18.3 Yes No No Yes, macOS only No
Function: Get the human readable name of the remote device.
Notes:
If the name is not present, it will return a string containing the device's address.

If a remote name request has been successfully completed, the device name will be returned. If not, a string containg the device address in the format of "XX-XX-XX-XX-XX-XX" will be returned.
(Read only property)

Feedback, Comments & Corrections

IOBluetoothDeviceMBS.PageScanMode as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Bluetooth MBS Bluetooth Plugin 18.3 Yes No No Yes, macOS only No
Function: Get the page scan mode for the device.
Notes:
Returns the value for the page scan mode for the device.

This value is only meaningful if the target device has been seen during an inquiry. This can be by checking the result of LastInquiryUpdate. If nil is returned, then the device hasn't been seen.
(Read only property)

Feedback, Comments & Corrections

IOBluetoothDeviceMBS.PageScanPeriodMode as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Bluetooth MBS Bluetooth Plugin 18.3 Yes No No Yes, macOS only No
Function: Get the value of the page scan period mode for the device.
Notes:
Returns page scan period mode value for the device.

This value is only meaningful if the target device has been seen during an inquiry. This can be by checking the result of getLastInquiryUpdate. If nil is returned, then the device hasn't been seen.
(Read only property)

Feedback, Comments & Corrections

IOBluetoothDeviceMBS.PageScanRepetitionMode as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Bluetooth MBS Bluetooth Plugin 18.3 Yes No No Yes, macOS only No
Function: Get the value of the page scan repetition mode for the device.
Notes:
Returns the page scan repetition mode value for this device.

This value is only meaningful if the target device has been seen during an inquiry. This can be by checking the result of LastInquiryUpdate. If nil is returned, then the device hasn't been seen.
(Read only property)

Feedback, Comments & Corrections

IOBluetoothDeviceMBS.rawRSSI as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Bluetooth MBS Bluetooth Plugin 18.3 Yes No No Yes, macOS only No
Function: Get the raw RSSI device (if connected).
Notes:
This value is the perceived RSSI value, not relative the the golden range (see RSSI for that value). This value will not available on all Bluetooth modules. If the value cannot be read (e.g. the device is disconnected) or is not available on a module, a value of +127 will be returned.
(Read only property)

Feedback, Comments & Corrections

IOBluetoothDeviceMBS.RecentAccessDate as Date
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Bluetooth MBS Bluetooth Plugin 18.3 Yes No No Yes, macOS only No
Function: Returns the date/time of the most recent access of the target device.
Notes:
Returns the date/time of the most recent access of the target device. If the device has not been accessed, nil is returned.

This is the date that recentDevices uses to sort its list of the most recently accessed devices.
This method is only available in macOS 10.2.4 (Bluetooth v1.1) or later.
(Read only property)

Feedback, Comments & Corrections

IOBluetoothDeviceMBS.RSSI as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Bluetooth MBS Bluetooth Plugin 18.3 Yes No No Yes, macOS only No
Function: Get the RSSI device (if connected), above or below the golden range.
Notes:
If the RSSI is within the golden range, a value of 0 is returned. For the actual RSSI value, use getRawRSSI. For more information, see the Bluetooth 4.0 Core Specification.

Returns the RSSI of the device. If the value cannot be read (e.g. the device is disconnected), a value of +127 will be returned.
(Read only property)

Feedback, Comments & Corrections

IOBluetoothDeviceMBS.serviceClassMajor as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Bluetooth MBS Bluetooth Plugin 18.3 Yes No No Yes, macOS only No
Function: Get the major service class of the device.
Notes:
This value is only meaningful if the target device has been seen during an inquiry. This can be by checking the result of LastInquiryUpdate. If nil is returned, then the device hasn't been seen.
(Read only property)

Feedback, Comments & Corrections

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




Links
MBS Xojo Plugins