Mac Developer Library

Developer

IOBluetoothDeviceSelectorController Class Reference

Options
Deployment Target:

On This Page

IOBluetoothDeviceSelectorController

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

Implementation of a window controller to return a NSArray of selected bluetooth devices. This class will handle connecting to the Bluetooth Daemon for the purposes of searches, and displaying the results. This controller will return a NSArray of IOBluetoothDevice objects to the user.

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

    Declaration

    - (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.

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

    Declaration

    - (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.

  • Runs the device selector panel as a sheet on the target window.

    Declaration

    - (IOReturn)beginSheetModalForWindow:(NSWindow *)sheetWindow modalDelegate:(id)modalDelegate didEndSelector:(SEL)didEndSelector contextInfo:(void *)contextInfo;

    Parameters

    sheetWindow

    NSWindow to attach the device selector panel to as a sheet.

    modalDelegate

    Delegate object that gets sent the didEndSelector when the sheet modal session is finished.

    didEndSelector

    Selector sent to the modalDelegate when the sheet modal session is finished.

    contextInfo

    User-definied value passed to the modalDelegate in the didEndSelector.

    Return Value

    Returns kIOReturnSuccess if the sheet modal session was started.

    Discussion

    This function works the same way as -[NSApplication beginSheet:modalForWindow:modalDelegate:didEndSelector:contextInfo:]. The didEndSelector has a similar prototype as in NSApplication except that the first argument is the IOBluetoothDeviceSelectorController object instead of the window: -(void)sheetDidEnd:(IOBluetoothDeviceSelectorController *)controller returnCode:(int)returnCode contextInfo:(void *)contextInfo. The returnCode parameter will either be kIOBluetoothUISuccess or kIOBluetoothUIUserCancelledErr as described in -runModal.

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

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

    Declaration

    - (void)clearAllowedUUIDs;

    Discussion

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

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

    Declaration

    - (NSString *)getCancel;

    Return Value

    Returns the default cancel button title of the device selector panel.

    Discussion

    NOTE: This method is only available in Mac OS X 10.9 or later.

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

    Declaration

    - (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.

  • Returns an IOBluetoothDeviceSelectorControllerRef representation of the target IOBluetoothDeviceSelectorController object.

    Declaration

    - (IOBluetoothDeviceSelectorControllerRef)getDeviceSelectorControllerRef;

    Return Value

    Returns an IOBluetoothDeviceSelectorControllerRef representation of the target IOBluetoothDeviceSelectorController object.

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

    Declaration

    - (NSString *)getHeader;

    Return Value

    Returns the header text of the device selector panel.

    Discussion

    NOTE: This method is only available in Mac OS X 10.9 or later.

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

    Declaration

    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.

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

    Declaration

    - (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.

  • Returns the result of the user's selection.

    Declaration

    - (NSArray *)getResults;

    Return Value

    Returns an NSArray of IOBluetoothDevice objects corresponding to the user's selection. 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 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 Mac OS X 10.2.4 (Bluetooth v1.1) or later.

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

    Declaration

    - (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.

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

    Declaration

    - (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.

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

    Declaration

    - (int)runModal;

    Return Value

    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.

    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), will this method return.

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

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

    Declaration

    - (void)setCancel:(NSString *)prompt;

    Parameters

    prompt

    String that appears in the default/cancel 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.9 or later.

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

    Declaration

    - (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.

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

    Declaration

    - (void)setHeader:(NSString *)headerText;

    Parameters

    headerText

    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.9 or later.

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

    Declaration

    - (void)setOptions:(IOBluetoothServiceBrowserControllerOptions)options;

    Parameters

    options

    Options to control the panel's behavior.

    Discussion

    The service browser 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.

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

    Declaration

    - (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.

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

    Declaration

    - (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.

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

    Declaration

    - (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.

  • Declaration

    + (IOBluetoothDeviceSelectorController *)deviceSelector;

    Return Value

    Success - a new instance of the device selector Controller Failure - nil

    Discussion

    Method call to instantiate a new IOBluetoothDeviceSelectorController object.

  • Method call to convert an IOBluetoothDeviceSelectorControllerRef into an IOBluetoothDeviceSelectorController *.

    Declaration

    + (IOBluetoothDeviceSelectorController *) withDeviceSelectorControllerRef:(IOBluetoothDeviceSelectorControllerRef)deviceSelectorControllerRef;

    Parameters

    deviceSelectorControllerRef

    IOBluetoothDeviceSelectorControllerRef for which an IOBluetoothDeviceSelectorController * is desired.

    Return Value

    Returns the IOBluetoothDeviceSelectorController * for the given IOBluetoothDeviceSelectorControllerRef.