Mac Developer Library

Developer

IOBluetoothPairingController Class Reference

Options
Deployment Target:

On This Page
Language:

IOBluetoothPairingController

Inheritance


Conforms To


Import Statement


Swift

import IOBluetoothUI

Objective-C

@import IOBluetoothUI;

Availability


Available in OS X v10.2 and later.

A NSWindowController subclass to display a window to initiate pairing to other bluetooth devices.

Implementation of a window controller to handle pairing with a bluetooth device. This class will handle connecting to the Bluetooth Daemon for the purposes of searches, and displaying the results. When necessary this class will display a sheet asking the user for a PIN code. This window will not return anything to the caller if it is canceled or if pairing occurs.

  • Adds a UUID to the list of UUIDs that are used to validate the user's selection.

    Declaration

    Swift

    func addAllowedUUID(_ allowedUUID: IOBluetoothSDPUUID!)

    Objective-C

    - (void)addAllowedUUID:(IOBluetoothSDPUUID *)allowedUUID

    Parameters

    allowedUUID

    UUID that a device may contain to be selected

    Discussion

    The user's device selection gets validated against the UUIDs passed to -addAllowedUUID: 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 Mac OS X 10.2.4 (Bluetooth v1.1) or later.

    Import Statement

    Objective-C

    @import IOBluetoothUI;

    Swift

    import IOBluetoothUI

    Availability

    Available in OS X v10.2 and later.

  • Adds an array of UUIDs to the list of UUIDs that are used to validate the user's selection.

    Declaration

    Swift

    func addAllowedUUIDArray(_ allowedUUIDArray: [AnyObject]!)

    Objective-C

    - (void)addAllowedUUIDArray:(NSArray *)allowedUUIDArray

    Parameters

    allowedUUIDArray

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

    Discussion

    The user's device selection gets validated against the UUIDs passed to -addAllowedUUID: 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 Mac OS X 10.2.4 (Bluetooth v1.1) or later.

    Import Statement

    Objective-C

    @import IOBluetoothUI;

    Swift

    import IOBluetoothUI

    Availability

    Available in OS X v10.2 and later.

  • Resets the controller back to the default state where it will accept any device the user selects.

    Declaration

    Swift

    func clearAllowedUUIDs()

    Objective-C

    - (void)clearAllowedUUIDs

    Discussion

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

    Import Statement

    Objective-C

    @import IOBluetoothUI;

    Swift

    import IOBluetoothUI

    Availability

    Available in OS X v10.2 and later.

  • Returns the description text that appears in the device selector panel (i.e. what was set in -setDescriptionText:).

    Declaration

    Swift

    func getDescriptionText() -> String!

    Objective-C

    - (NSString *)getDescriptionText

    Return Value

    Returns the description text of the device selector panel.

    Discussion

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

    Import Statement

    Objective-C

    @import IOBluetoothUI;

    Swift

    import IOBluetoothUI

    Availability

    Available in OS X v10.2 and later.

  • Returns the option bits that control the panel's behavior.

    Declaration

    Swift

    func getOptions() -> IOBluetoothServiceBrowserControllerOptions

    Objective-C

    - (IOBluetoothServiceBrowserControllerOptions)getOptions

    Return Value

    Returns the option bits set by setOptions:

    Discussion

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

    Import Statement

    Objective-C

    @import IOBluetoothUI;

    Swift

    import IOBluetoothUI

    Availability

    Available in OS X v10.2 and later.

  • Returns an IOBluetoothPairingControllerRef representation of the target IOBluetoothPairingController object.

    Declaration

    Objective-C

    - (IOBluetoothPairingControllerRef)getPairingControllerRef

    Return Value

    Returns an IOBluetoothPairingControllerRef representation of the target IOBluetoothPairingController object.

    Import Statement

    Objective-C

    @import IOBluetoothUI;

    Availability

    Available in OS X v10.0 and later.

    Deprecated in OS X v10.7.

  • Returns the title of the default/select button in the device selector panel (i.e. what was set in -setPrompt:).

    Declaration

    Swift

    func getPrompt() -> String!

    Objective-C

    - (NSString *)getPrompt

    Return Value

    Returns the default button title of the device selector panel.

    Discussion

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

    Import Statement

    Objective-C

    @import IOBluetoothUI;

    Swift

    import IOBluetoothUI

    Availability

    Available in OS X v10.2 and later.

  • Returns an NSArray of the devices that were paired.

    Declaration

    Swift

    func getResults() -> [AnyObject]!

    Objective-C

    - (NSArray *)getResults

    Return Value

    Returns an NSArray of IOBluetoothDevice objects of devices that were paired. If the user cancelled the panel, nil will be returned.

    Discussion

    There will only be results if the panel has been run, the user has successfully made a selection, that selection has been validated and the selected device paired. 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 may be supported.

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

    Import Statement

    Objective-C

    @import IOBluetoothUI;

    Swift

    import IOBluetoothUI

    Availability

    Available in OS X v10.2 and later.

  • Returns the search attributes that control the panel's search/inquiry behavior.

    Declaration

    Swift

    func getSearchAttributes() -> UnsafePointer<IOBluetoothDeviceSearchAttributes>

    Objective-C

    - (const IOBluetoothDeviceSearchAttributes *)getSearchAttributes

    Return Value

    Returns the search attributes set by setSearchAttributes:

    Discussion

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

    Import Statement

    Objective-C

    @import IOBluetoothUI;

    Swift

    import IOBluetoothUI

    Availability

    Available in OS X v10.2 and later.

  • Returns the title of the device selector panel (i.e. what was set in -setTitle:).

    Declaration

    Swift

    func getTitle() -> String!

    Objective-C

    - (NSString *)getTitle

    Return Value

    Returns the title of the device selector panel.

    Discussion

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

    Import Statement

    Objective-C

    @import IOBluetoothUI;

    Swift

    import IOBluetoothUI

    Availability

    Available in OS X v10.2 and later.

  • Runs the pairing panel in a modal session to allow the user to select a Bluetooth device.

    Declaration

    Swift

    func runModal() -> Int32

    Objective-C

    - (int)runModal

    Return Value

    Returns kIOBluetoothUISuccess if a successful, validated device selection was made by the user and that device successfully paired. 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.

    Discussion

    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) and the device paired, will this method return.

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

    Import Statement

    Objective-C

    @import IOBluetoothUI;

    Swift

    import IOBluetoothUI

    Availability

    Available in OS X v10.2 and later.

  • Sets the description text that appears in the device selector panel.

    Declaration

    Swift

    func setDescriptionText(_ descriptionText: String!)

    Objective-C

    - (void)setDescriptionText:(NSString *)descriptionText

    Parameters

    descriptionText

    String that appears in the description section of the device selector panel.

    Discussion

    The description text should be localized for best user experience.

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

    Import Statement

    Objective-C

    @import IOBluetoothUI;

    Swift

    import IOBluetoothUI

    Availability

    Available in OS X v10.2 and later.

  • Sets the option bits that control the panel's behavior.

    Declaration

    Swift

    func setOptions(_ options: IOBluetoothServiceBrowserControllerOptions)

    Objective-C

    - (void)setOptions:(IOBluetoothServiceBrowserControllerOptions)options

    Parameters

    options

    Options to control the panel's behavior.

    Discussion

    The pairing controller options control the behavior of the panel. Currently kIOBluetoothServiceBrowserControllerOptionsAutoStartInquiry is the only supported option. In the future more options will be added to control things like whether the connection to the device is closed when the controller is finished or if multiple selection is allowed.

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

    Import Statement

    Objective-C

    @import IOBluetoothUI;

    Swift

    import IOBluetoothUI

    Availability

    Available in OS X v10.2 and later.

  • Sets the title of the default/select button in the device selector panel.

    Declaration

    Swift

    func setPrompt(_ prompt: String!)

    Objective-C

    - (void)setPrompt:(NSString *)prompt

    Parameters

    prompt

    String that appears in the default/select button in the device selector panel.

    Discussion

    The prompt text should be localized for best user experience.

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

    Import Statement

    Objective-C

    @import IOBluetoothUI;

    Swift

    import IOBluetoothUI

    Availability

    Available in OS X v10.2 and later.

  • Sets the search attributes that control the panel's search/inquiry behavior.

    Declaration

    Swift

    func setSearchAttributes(_ searchAttributes: UnsafePointer<IOBluetoothDeviceSearchAttributes>)

    Objective-C

    - (void)setSearchAttributes:(const IOBluetoothDeviceSearchAttributes *)searchAttributes

    Parameters

    searchAttributes

    Attributes to control the panel's inquiry behavior.

    Discussion

    The device search attributes control the inquiry behavior of the panel. They allow only devices that match the specified attributes (i.e. class of device) to be displayed to the user. Note that this only covers attributes returned in an inquiry result and not actual SDP services on the device.

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

    Import Statement

    Objective-C

    @import IOBluetoothUI;

    Swift

    import IOBluetoothUI

    Availability

    Available in OS X v10.2 and later.

  • Sets the title of the panel when not run as a sheet.

    Declaration

    Swift

    func setTitle(_ windowTitle: String!)

    Objective-C

    - (void)setTitle:(NSString *)windowTitle

    Parameters

    windowTitle

    Title of the device selector panel.

    Discussion

    The panel title should be localized for best user experience.

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

    Import Statement

    Objective-C

    @import IOBluetoothUI;

    Swift

    import IOBluetoothUI

    Availability

    Available in OS X v10.2 and later.

  • Declaration

    Objective-C

    + (IOBluetoothPairingController *)pairingController

    Return Value

    An IOBluetoothPairingController instance. Call runPanelWithAttributes

    Success - a new instance of the Pairing Controller Failure - nil

    Discussion

    Method call to instantiate a new IOBluetoothPairingController object.

    Import Statement

    Objective-C

    @import IOBluetoothUI;

    Availability

    Available in OS X v10.2 and later.

  • Method call to convert an IOBluetoothPairingControllerRef into an IOBluetoothPairingController *.

    Declaration

    Objective-C

    + (IOBluetoothPairingController *)withPairingControllerRef:(IOBluetoothPairingControllerRef)pairingControllerRef

    Parameters

    pairingControllerRef

    IOBluetoothPairingControllerRef for which an IOBluetoothPairingController * is desired.

    Return Value

    Returns the IOBluetoothPairingController * for the given IOBluetoothPairingControllerRef.

    Import Statement

    Objective-C

    @import IOBluetoothUI;

    Availability

    Available in OS X v10.0 and later.

    Deprecated in OS X v10.7.