SHOW Signed

net.rim.device.api.bluetooth
Class BluetoothSerialPortInfo

java.lang.Object
  |
  +--net.rim.device.api.bluetooth.BluetoothSerialPortInfo

public class BluetoothSerialPortInfo
extends Object

Encapsulates information about the current connection through the Bluetooth serial port.

Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:
JDE 4.0.0

Constructor Summary
 Category: Signed BluetoothSerialPortInfo(byte[] address, int serverID, String serviceName)
          Creates a new BluetoothSerialPortInfo instance.
 Category: Signed BluetoothSerialPortInfo(byte[] address, int pageScanInfo, String name, int serverID, String serviceName)
          Creates a new BluetoothSerialPortInfo instance.
 Category: Signed BluetoothSerialPortInfo(byte[] address, String name, int serverID, String serviceName)
          Creates a new BluetoothSerialPortInfo instance.
 
Method Summary
 Category: Signed  byte[] getDeviceAddress()
          Retrieves this connection's device address in raw form.
 Category: Signed  String getDeviceName()
          Retrieves this connection's device name.
 Category: Signed  int getDevicePageScanInfo()
          Retrieves this connection's device page scan info.
 Category: Signed  int getServerID()
          Retrieves this connection's server ID.
 Category: Signed  String getServiceName()
          Retrieves this connection's service name.
 Category: Signed  String toString()
          Retrieves this information object in string form.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

BluetoothSerialPortInfo

public BluetoothSerialPortInfo(byte[] address,
                               int serverID,
                               String serviceName)
Creates a new BluetoothSerialPortInfo instance.
Parameters:
address - Device address for new connection.
serverID - Server ID for the new connection.
serviceName - Name for the service provided through the new connection.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

BluetoothSerialPortInfo

public BluetoothSerialPortInfo(byte[] address,
                               int pageScanInfo,
                               String name,
                               int serverID,
                               String serviceName)
Creates a new BluetoothSerialPortInfo instance.
Parameters:
address - Device address for new connection.
pageScanInfo - Page scan info for the device, or 0 if unknown.
name - Device name, or null if device name is not known.
serverID - Server ID for the new connection.
serviceName - Name for the service provided through the new connection.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

BluetoothSerialPortInfo

public BluetoothSerialPortInfo(byte[] address,
                               String name,
                               int serverID,
                               String serviceName)
Creates a new BluetoothSerialPortInfo instance.
Parameters:
address - Device address for new connection.
name - Device name, or null if device name is not known.
serverID - Server ID for the new connection.
serviceName - Name for the service provided through the new connection.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.
Method Detail

getDeviceAddress

public byte[] getDeviceAddress()
Retrieves this connection's device address in raw form.
Returns:
Raw device address for this connection.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getDeviceName

public String getDeviceName()
Retrieves this connection's device name.
Returns:
Device name, or null if the device name is not known.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getDevicePageScanInfo

public int getDevicePageScanInfo()
Retrieves this connection's device page scan info.
Returns:
The page scan info, or 0 if unknown.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getServerID

public int getServerID()
Retrieves this connection's server ID.
Returns:
Server ID for this connection.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getServiceName

public String getServiceName()
Retrieves this connection's service name.
Returns:
Name of the service provided through this connection.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

toString

public String toString()
Retrieves this information object in string form.

Expect retrieved strings to be of the form:

    btspp://DeviceAddressAsString:ServerIdAsinteger
 

This method uses the Bluetooth management entity to convert the device address to a string from the raw form provided to this object's constructor.

Overrides:
toString in class Object
Returns:
String form of this information object.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.


Copyright 1999-2007 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.