com.symbol.emdk.scanandpair

Class ScanAndPairManager

java.lang.Object

com.symbol.emdk.EMDKBase

com.symbol.emdk.scanandpair.ScanAndPairManager

public class ScanAndPairManager
extends EMDKBase

The ScanAndPair provides simple methods to scan a Bluetooth barcode (name or address) of a remote Bluetooth device and pair/unpair with the remote Bluetooth device.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ScanAndPairManager.StatusListener An interface for notifying client applications to notify scan and pair or unpair events.

Field Summary

Fields

Modifier and Type	Field and Description
ScanAndPairConfig	config The ScanAndPairManager.config provides a way to configure the settings to use it in scanAndPair() or scanAnUnpair() methods.

Method Summary

Modifier and Type	Method and Description
void	addStatusListener(ScanAndPairManager.StatusListener listener) The client can register to get status notification via callbacks.
StatusData	getStatus() This method provides an option to get the current or recent status of scanAndPair or scanAndUnpair calls
boolean	isPreviousCommandPending() This method provides information if any of the previous request is pending.
void	removeStatusListener(ScanAndPairManager.StatusListener listener) The client can un-register to get status notification via callbacks.
ScanAndPairResults	scanAndPair(java.lang.String pin) This is an asynchronous method.
ScanAndPairResults	scanAndUnpair() This is an asynchronous method.

Methods inherited from class com.symbol.emdk.EMDKBase

getType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

config

public ScanAndPairConfig config

The ScanAndPairManager.config provides a way to configure the settings to use it in scanAndPair() or scanAnUnpair() methods. These settings must be done before calling the scanAndPair() or scanAnUnpair() methods and do not modify the this while the method is processing its job.

Method Detail

isPreviousCommandPending

public boolean isPreviousCommandPending()

This method provides information if any of the previous request is pending. If this method returns true, the client application must wait for the current complete before calling the issuing the next request.

Returns:

Boolean value

scanAndPair

public ScanAndPairResults scanAndPair(java.lang.String pin)

This is an asynchronous method. The status of the scanAndPair() method will be returned if the callback is registered. If the always scan is enabled in the configuration, this method scans a barcode to get the Bluetooth address or name of a remote device, and pairs with that remote device. If a Bluetooth address is scanned, the remote device is paired without performing a discovery. If a Bluetooth name is scanned, then a discovery is done to find the address of the device and then the pairing is done. The provided authentication PIN is used for pairing. The maximum allowed length for the authentication PIN is 15 characters.

Parameters:

pin - Pin required to pair with the Bluetooth device.

Returns:

Returns success if the scan and pair request is successfully initiated.

scanAndUnpair

public ScanAndPairResults scanAndUnpair()

This is an asynchronous method. The status of the scanAndUnpair() method will be returned if the callback is registered. If the always scan is enabled in the configuration, this method scans a barcode to get the Bluetooth address or name of a remote device, and pairs with that remote device. If a Bluetooth address was scanned for pairing during scanAndPair calls, then the same address can be scanned for unpairing during the ScanAndUnPair call.

Returns:

Returns success if the scan and unpair request is successfully initiated.

getStatus

public StatusData getStatus()

This method provides an option to get the current or recent status of scanAndPair or scanAndUnpair calls

Returns:

StatusData object.

addStatusListener

public void addStatusListener(ScanAndPairManager.StatusListener listener)
                       throws ScanAndPairException

The client can register to get status notification via callbacks.

Parameters:

listener -

Throws:

ScanAndPairException

removeStatusListener

public void removeStatusListener(ScanAndPairManager.StatusListener listener)
                          throws ScanAndPairException

The client can un-register to get status notification via callbacks.

Parameters:

listener -

Throws:

ScanAndPairException