BluetoothRemoteDevice

java.lang.Object
- ohos.bluetooth.BluetoothRemoteDevice

所有已实现的接口:

Sequenceable
```
public final class BluetoothRemoteDevice
extends Object
implements Sequenceable
```
Provides methods to perform operations on a peer Bluetooth device.
The BluetoothRemoteDevice object can be used to set up a connection with a peer device and query information such as the name, device type, and pairing status.
BluetoothHost#getRemoteDev(String) is used to create a remote Bluetooth device.

从以下版本开始:

1

嵌套类概要
- 从接口继承的嵌套类/接口 ohos.utils.Sequenceable
  Sequenceable.Producer<T>

字段概要

字段
限定符和类型	字段	说明
`static String`	`EVENT_DEVICE_DISCOVERED`	Indicates the event reported when a remote Bluetooth device is discovered.
`static String`	`EVENT_DEVICE_PAIR_STATE`	Indicates the event reported when a remote Bluetooth device is paired.
`static String`	`EVENT_DEVICE_PAIRING_REQ`	Indicates the event of a pairing request from a remote Bluetooth device.
`static int`	`PAIR_STATE_NONE`	Indicates that the peer device is not paired.
`static int`	`PAIR_STATE_PAIRED`	Indicates that the peer device is paired.
`static int`	`PAIR_STATE_PAIRING`	Indicates that the peer device is being paired.
`static String`	`REMOTE_DEVICE_PARAM_DEVICE`	Indicates the remote device in an event message.
`static String`	`REMOTE_DEVICE_PARAM_PAIR_STATE`	Indicates the pairing state of the remote device in an event message.
`static String`	`REMOTE_DEVICE_PARAM_PAIRING_FORMAT`	Indicates the pairing format of the remote device in an event message.
`static String`	`REMOTE_DEVICE_PARAM_PAIRING_KEY`	Indicates the pairing key of the remote device in an event message.
`static String`	`REMOTE_DEVICE_PARAM_PREV_PAIR_STATE`	Indicates the previous pairing state of the remote device in an event message.
`static int`	`TYPE_CLASSIC`	Indicates a classic Bluetooth device.
`static int`	`TYPE_DUAL`	Indicates a dual-mode Bluetooth device.
`static int`	`TYPE_LE`	Indicates a BLE Bluetooth device.
`static int`	`TYPE_UNKNOWN`	Indicates an unknown Bluetooth device.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`boolean`	`equals(Object object)`	Indicates whether some other object is "equal to" this one.
`String`	`getDeviceAddr()`	Obtains the Bluetooth MAC address.
`Optional<BluetoothDeviceClass>`	`getDeviceClass()`	Obtains the class of a peer Bluetooth device.
`Optional<String>`	`getDeviceName()`	Obtains the name of a peer Bluetooth device.
`int`	`getDeviceType()`	Obtains the type of a peer Bluetooth device.
`SequenceUuid[]`	`getDeviceUuids()`	Obtains the supported UUIDs of the remote Bluetooth device.
`int`	`getPairState()`	Obtains the pairing status of a peer Bluetooth device.
`int`	`hashCode()`	Returns a hash code value for the object.
`boolean`	`marshalling(Parcel out)`	Marshals this `Sequenceable` object into a `Parcel`.
`boolean`	`setDevicePin(byte[] pin)`	Inputs the PIN during pairing.
`boolean`	`startPair()`	Starts pairing with a remote Bluetooth device.
`String`	`toString()`	Returns a string representation of the object.
`boolean`	`unmarshalling(Parcel in)`	Unmarshals this `Sequenceable` object from a `Parcel`.

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 ohos.utils.Sequenceable
hasFileDescriptor

- 字段详细资料
  - EVENT_DEVICE_DISCOVERED
```
public static final String EVENT_DEVICE_DISCOVERED
```
    Indicates the event reported when a remote Bluetooth device is discovered. You can register this event to listen for discovered Bluetooth devices.
    EVENT_DEVICE_DISCOVERED contains detailed information about the discovered remote Bluetooth device.
    
    Output: REMOTE_DEVICE_PARAM_DEVICE indicates information about the discovered remote Bluetooth device.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    EVENT_DEVICE_DISCOVERED, REMOTE_DEVICE_PARAM_DEVICE, 常量字段值
  - EVENT_DEVICE_PAIRING_REQ
```
public static final String EVENT_DEVICE_PAIRING_REQ
```
    Indicates the event of a pairing request from a remote Bluetooth device. You can register this event to listen for pairing requests from remote Bluetooth devices.
    EVENT_DEVICE_PAIRING_REQ contains detailed information about the pairing request from a remote Bluetooth device.
    
    Output: REMOTE_DEVICE_PARAM_DEVICE indicates the remote Bluetooth device; REMOTE_DEVICE_PARAM_PAIRING_KEY indicates the pairing key; REMOTE_DEVICE_PARAM_PAIRING_FORMAT indicates the pairing format.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    EVENT_DEVICE_PAIRING_REQ, REMOTE_DEVICE_PARAM_DEVICE, REMOTE_DEVICE_PARAM_PAIRING_KEY, REMOTE_DEVICE_PARAM_PAIRING_FORMAT, 常量字段值
  - EVENT_DEVICE_PAIR_STATE
```
public static final String EVENT_DEVICE_PAIR_STATE
```
    Indicates the event reported when a remote Bluetooth device is paired. You can register this event to listen for paired Bluetooth devices.
    EVENT_DEVICE_PAIR_STATE contains detailed information about the paired remote Bluetooth device.
    
    Output: REMOTE_DEVICE_PARAM_PREV_PAIR_STATE indicates the state of the remote Bluetooth device before it is paired; REMOTE_DEVICE_PARAM_PAIR_STATE indicates the state of the remote Bluetooth device after it is paired.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    EVENT_DEVICE_PAIR_STATE, REMOTE_DEVICE_PARAM_PREV_PAIR_STATE, REMOTE_DEVICE_PARAM_PAIR_STATE, 常量字段值
  - PAIR_STATE_NONE
```
public static final int PAIR_STATE_NONE
```
    Indicates that the peer device is not paired.
    
    另请参阅:
    
    常量字段值
  - PAIR_STATE_PAIRED
```
public static final int PAIR_STATE_PAIRED
```
    Indicates that the peer device is paired.
    
    另请参阅:
    
    常量字段值
  - PAIR_STATE_PAIRING
```
public static final int PAIR_STATE_PAIRING
```
    Indicates that the peer device is being paired.
    
    另请参阅:
    
    常量字段值
  - REMOTE_DEVICE_PARAM_DEVICE
```
public static final String REMOTE_DEVICE_PARAM_DEVICE
```
    Indicates the remote device in an event message.
    
    另请参阅:
    
    常量字段值
  - REMOTE_DEVICE_PARAM_PAIRING_FORMAT
```
public static final String REMOTE_DEVICE_PARAM_PAIRING_FORMAT
```
    Indicates the pairing format of the remote device in an event message.
    
    另请参阅:
    
    常量字段值
  - REMOTE_DEVICE_PARAM_PAIRING_KEY
```
public static final String REMOTE_DEVICE_PARAM_PAIRING_KEY
```
    Indicates the pairing key of the remote device in an event message.
    
    另请参阅:
    
    常量字段值
  - REMOTE_DEVICE_PARAM_PAIR_STATE
```
public static final String REMOTE_DEVICE_PARAM_PAIR_STATE
```
    Indicates the pairing state of the remote device in an event message.
    
    另请参阅:
    
    常量字段值
  - REMOTE_DEVICE_PARAM_PREV_PAIR_STATE
```
public static final String REMOTE_DEVICE_PARAM_PREV_PAIR_STATE
```
    Indicates the previous pairing state of the remote device in an event message.
    
    另请参阅:
    
    常量字段值
  - TYPE_CLASSIC
```
public static final int TYPE_CLASSIC
```
    Indicates a classic Bluetooth device.
    
    另请参阅:
    
    常量字段值
  - TYPE_DUAL
```
public static final int TYPE_DUAL
```
    Indicates a dual-mode Bluetooth device.
    
    另请参阅:
    
    常量字段值
  - TYPE_LE
```
public static final int TYPE_LE
```
    Indicates a BLE Bluetooth device.
    
    另请参阅:
    
    常量字段值
  - TYPE_UNKNOWN
```
public static final int TYPE_UNKNOWN
```
    Indicates an unknown Bluetooth device.
    
    另请参阅:
    
    常量字段值
- 方法详细资料
  - getDeviceAddr
```
public String getDeviceAddr()
```
    Obtains the Bluetooth MAC address.
    
    返回:
    
    Returns the Bluetooth MAC address, for example, 00:11:22:33:44:55.
  - getDeviceName
```
public Optional<String> getDeviceName()
```
    Obtains the name of a peer Bluetooth device.
    
    返回:
    
    Returns the device name in character string format; returns Optional#empty() if an error occurs.
  - getDeviceType
```
public int getDeviceType()
```
    Obtains the type of a peer Bluetooth device.
    
    返回:
    
    Returns the device type, which can be TYPE_UNKNOWN, TYPE_CLASSIC, TYPE_LE, or TYPE_DUAL.
  - getDeviceClass
```
public Optional<BluetoothDeviceClass> getDeviceClass()
```
    Obtains the class of a peer Bluetooth device.
    
    返回:
    
    Returns the BluetoothDeviceClass instance indicating the device class; returns Optional#empty() if an error occurs.
  - getPairState
```
public int getPairState()
```
    Obtains the pairing status of a peer Bluetooth device.
    
    返回:
    
    Returns the pairing status, which can be PAIR_STATE_NONE, PAIR_STATE_PAIRING, or PAIR_STATE_PAIRED.
  - startPair
```
public boolean startPair()
```
    Starts pairing with a remote Bluetooth device.
    The caller can listen to the EVENT_DEVICE_PAIR_STATE event for the pairing result.
    
    返回:
    
    Returns true if the pairing process is started; returns false otherwise.
  - setDevicePin
```
public boolean setDevicePin(byte[] pin)
```
    Inputs the PIN during pairing.
    You can listen to the EVENT_DEVICE_PAIRING_REQ event for the dialog box for setting PIN.
    
    参数:
    
    pin - Indicates the device pin value.
    
    返回:
    
    Returns true if PIN is set successfully; returns false otherwise.
  - getDeviceUuids
```
public SequenceUuid[] getDeviceUuids()
```
    Obtains the supported UUIDs of the remote Bluetooth device.
    The local device bound with the remote Bluetooth device caches the supported UUIDs.
    
    返回:
    
    Returns the supported UUIDs of the remote device if they are found; returns null otherwise.
    
    从以下版本开始:
    
    3
  - toString
```
public String toString()
```
    从类复制的说明: Object
    Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.
    The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:
    getClass().getName() + '@' + Integer.toHexString(hashCode())
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    a string representation of the object.
  - marshalling
```
public boolean marshalling(Parcel out)
```
    从接口复制的说明: Sequenceable
    
    Marshals this Sequenceable object into a Parcel.
    
    指定者:
    
    marshalling 在接口中 Sequenceable
    
    参数:
    
    out - Indicates the Parcel object to which the Sequenceable object will be marshaled..
    
    返回:
    
    Returns true if the marshalling is successful; returns false otherwise.
  - unmarshalling
```
public boolean unmarshalling(Parcel in)
```
    从接口复制的说明: Sequenceable
    
    Unmarshals this Sequenceable object from a Parcel.
    
    指定者:
    
    unmarshalling 在接口中 Sequenceable
    
    参数:
    
    in - Indicates the Parcel object into which the Sequenceable object has been marshaled.
    
    返回:
    
    Returns true if the unmarshalling is successful; returns false otherwise.
  - hashCode
```
public int hashCode()
```
    从类复制的说明: Object
    Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.
    The general contract of hashCode is:
    - Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
    - If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
    - It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
    As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)
    覆盖:
    
    hashCode 在类中 Object
    
    返回:
    
    a hash code value for this object.
    
    另请参阅:
    
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)
  - equals
```
public boolean equals(Object object)
```
    从类复制的说明: Object
    Indicates whether some other object is "equal to" this one.
    The equals method implements an equivalence relation on non-null object references:
    - It is reflexive: for any non-null reference value x, x.equals(x) should return true.
    - It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
    - It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
    - It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
    - For any non-null reference value x, x.equals(null) should return false.
    The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).
    Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.
    覆盖:
    
    equals 在类中 Object
    
    参数:
    
    object - the reference object with which to compare.
    
    返回:
    
    true if this object is the same as the obj argument; false otherwise.
    
    另请参阅:
    
    Object.hashCode(), HashMap

类 BluetoothRemoteDevice

嵌套类概要

从接口继承的嵌套类/接口 ohos.utils.Sequenceable

字段概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 ohos.utils.Sequenceable

字段详细资料

EVENT_DEVICE_DISCOVERED

EVENT_DEVICE_PAIRING_REQ

EVENT_DEVICE_PAIR_STATE

PAIR_STATE_NONE

PAIR_STATE_PAIRED

PAIR_STATE_PAIRING

REMOTE_DEVICE_PARAM_DEVICE

REMOTE_DEVICE_PARAM_PAIRING_FORMAT

REMOTE_DEVICE_PARAM_PAIRING_KEY

REMOTE_DEVICE_PARAM_PAIR_STATE

REMOTE_DEVICE_PARAM_PREV_PAIR_STATE

TYPE_CLASSIC

TYPE_DUAL

TYPE_LE

TYPE_UNKNOWN

方法详细资料

getDeviceAddr

getDeviceName

getDeviceType

getDeviceClass

getPairState

startPair

setDevicePin

getDeviceUuids

toString

marshalling

unmarshalling

hashCode

equals