# PairingParams Summary:[Constants](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#constants)\|[Inherited Constants](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#inhconstants)\|[Fields](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#lfields)\|[Methods](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#inhmethods)\|[\[Expand All\]](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#) # PairingParams ` public final class PairingParams ` ` extends `[Object](https://developer.android.com/reference/java/lang/Object)` `` implements `[Parcelable](https://developer.android.com/reference/android/os/Parcelable.html)` ` |---|---------------------------------------------------| | [java.lang.Object](https://developer.android.com/reference/java/lang/Object) || | ↳ | com.google.android.things.bluetooth.PairingParams |
*** ** * ** *** This class encapsulates the data for a particular pairing attempt. The caller can use it to determine the pairing approach and choose a suitable way to obtain user consent conclude the pairing process. ## Summary | ### Constants || |-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | [PAIRING_VARIANT_CONSENT](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#PAIRING_VARIANT_CONSENT) Pairing variant where the user is expected to consent to the pairing process. | | `int` | [PAIRING_VARIANT_DISPLAY_PASSKEY](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#PAIRING_VARIANT_DISPLAY_PASSKEY) Pairing variant where the user is notified of a pairing passkey. | | `int` | [PAIRING_VARIANT_DISPLAY_PIN](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#PAIRING_VARIANT_DISPLAY_PIN) Same as[PAIRING_VARIANT_DISPLAY_PASSKEY](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#PAIRING_VARIANT_DISPLAY_PASSKEY), except that the pairing key format is different. | | `int` | [PAIRING_VARIANT_PASSKEY_CONFIRMATION](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#PAIRING_VARIANT_PASSKEY_CONFIRMATION) Pairing variant where the user must confirm pairing after verifying a passkey which is provided to them. | | `int` | [PAIRING_VARIANT_PIN](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#PAIRING_VARIANT_PIN) Pairing variant where the user is supposed to enter a pin to confirm and authenticate the pairing process. | | `int` | [PAIRING_VARIANT_PIN_16_DIGITS](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#PAIRING_VARIANT_PIN_16_DIGITS) Same as[PAIRING_VARIANT_PIN](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#PAIRING_VARIANT_PIN), with the additional caveat that the pin is 16 digits in size. | | ### Inherited constants | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#)From interface` android.os.Parcelable ` |-------|----------------------------------------| | `int` | `CONTENTS_FILE_DESCRIPTOR`
| | `int` | `PARCELABLE_ELIDE_DUPLICATES`
| | `int` | `PARCELABLE_WRITE_RETURN_VALUE`
| | | ### Fields || |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------| | ` public static final `[Creator](https://developer.android.com/reference/android/os/Parcelable.Creator.html)`<`[PairingParams](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams)`>` | [CREATOR](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#CREATOR)
| | ### Public methods || |-----------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` int` | ` `[describeContents](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#describeContents())`() ` | | ` boolean` | ` `[equals](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` o) ` Indicates whether some other object is "equal to" this one. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[getPairingPin](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#getPairingPin())`() ` | | ` int` | ` `[getPairingType](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#getPairingType())`() ` | | ` int` | ` `[hashCode](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#hashCode())`() ` Returns a hash code value for the object. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#toString())`() ` Returns a string representation of the object. | | ` void` | ` `[writeToParcel](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#writeToParcel(android.os.Parcel, int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel.html)` dest, int flags) ` | | ### Inherited methods | |-----------------------|---| | [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#)From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object) | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`. | | ` int` | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long, int))`(long millis, int nanos) ` Causes the current thread to wait until another thread invokes the[notify()](https://developer.android.com/reference/java/lang/Object.html#notify())method or the[notifyAll()](https://developer.android.com/reference/java/lang/Object.html#notifyAll())method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long))`(long millis) ` Causes the current thread to wait until either another thread invokes the[notify()](https://developer.android.com/reference/java/lang/Object.html#notify())method or the[notifyAll()](https://developer.android.com/reference/java/lang/Object.html#notifyAll())method for this object, or a specified amount of time has elapsed. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until another thread invokes the[notify()](https://developer.android.com/reference/java/lang/Object.html#notify())method or the[notifyAll()](https://developer.android.com/reference/java/lang/Object.html#notifyAll())method for this object. | || | [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#)From interface` `[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable.html)` ` |------------------|--------------------------------------------------------------------------------------------------------------| | ` abstract int` | ` describeContents() ` | | ` abstract void` | ` writeToParcel(`[Parcel](https://developer.android.com/reference/android/os/Parcel.html)` arg0, int arg1) ` | || ## Constants ### PAIRING_VARIANT_CONSENT ``` int PAIRING_VARIANT_CONSENT ``` Pairing variant where the user is expected to consent to the pairing process. The caller is responsible for ensuring the user is prompted appropriately and user consent obtained for pairing. To conclude the pairing process, you must call[finishPairing(BluetoothDevice)](https://developer.android.com/reference/com/google/android/things/bluetooth/BluetoothConnectionManager#finishPairing(android.bluetooth.BluetoothDevice))after obtaining user consent.
Constant Value: 3 (0x00000003) ### PAIRING_VARIANT_DISPLAY_PASSKEY ``` int PAIRING_VARIANT_DISPLAY_PASSKEY ``` Pairing variant where the user is notified of a pairing passkey.**No action**needs to be taken by the user on the local device. It is expected that the user will use the passkey information to perform pairing on the remote device.
Constant Value: 4 (0x00000004) ### PAIRING_VARIANT_DISPLAY_PIN ``` int PAIRING_VARIANT_DISPLAY_PIN ``` Same as[PAIRING_VARIANT_DISPLAY_PASSKEY](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#PAIRING_VARIANT_DISPLAY_PASSKEY), except that the pairing key format is different. This variant can be thought of as the opposite of[PAIRING_VARIANT_PIN](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#PAIRING_VARIANT_PIN). On one device the pin is displayed. On the other, the user enters it.
Constant Value: 5 (0x00000005) ### PAIRING_VARIANT_PASSKEY_CONFIRMATION ``` int PAIRING_VARIANT_PASSKEY_CONFIRMATION ``` Pairing variant where the user must confirm pairing after verifying a passkey which is provided to them. It is expected the user should be able to verify it by matching the provided pairing key with the key displayed on the remote device. The pin is available using[getPairingPin()](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#getPairingPin()). The pairing process can be completed using[finishPairing(BluetoothDevice)](https://developer.android.com/reference/com/google/android/things/bluetooth/BluetoothConnectionManager#finishPairing(android.bluetooth.BluetoothDevice)).
Constant Value: 2 (0x00000002) ### PAIRING_VARIANT_PIN ``` int PAIRING_VARIANT_PIN ``` Pairing variant where the user is supposed to enter a pin to confirm and authenticate the pairing process. It is expected the pin has been displayed in some way on the remote device. To conclude the pairing process for this variant, you must call[finishPairing(BluetoothDevice, String)](https://developer.android.com/reference/com/google/android/things/bluetooth/BluetoothConnectionManager#finishPairing(android.bluetooth.BluetoothDevice, java.lang.String))after obtaining the pin from the user through suitable user input.
Constant Value: 0 (0x00000000) ### PAIRING_VARIANT_PIN_16_DIGITS ``` int PAIRING_VARIANT_PIN_16_DIGITS ``` Same as[PAIRING_VARIANT_PIN](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams#PAIRING_VARIANT_PIN), with the additional caveat that the pin is 16 digits in size. To conclude the pairing process for this variant, you must call[finishPairing(BluetoothDevice, String)](https://developer.android.com/reference/com/google/android/things/bluetooth/BluetoothConnectionManager#finishPairing(android.bluetooth.BluetoothDevice, java.lang.String))after obtaining the pin from the user through suitable user input.
Constant Value: 7 (0x00000007) ## Fields ### CREATOR ``` Creator CREATOR ```

## Public methods ### describeContents ``` int describeContents () ```

| Returns || |-------|--------| | `int` |
| ### equals ``` boolean equals (Object o) ``` 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.
| Parameters || |-----|--------------------------------------------------------------| | `o` | `Object`: the reference object with which to compare.
| | Returns || |-----------|-------------------------------------------------------------------------------| | `boolean` | `true`if this object is the same as the obj argument;`false`otherwise.
| ### getPairingPin ``` String getPairingPin () ```

| Returns || |--------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| | [String](https://developer.android.com/reference/java/lang/String) | Pairing pin to notify the user for the pairing process. If not relevant to the current pairing process, it's null.
| ### getPairingType ``` int getPairingType () ```

| Returns || |-------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | Pairing type for this pairing attempt. The Pairing type is based on the User Interface capabilities of both the pairing devices, and determines the process of pairing.
| ### hashCode ``` int hashCode () ``` Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by[HashMap](https://developer.android.com/reference/java/util/HashMap.html). 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[equals(java.lang.Object)](https://developer.android.com/reference/java/lang/Object.html#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.)
| Returns || |-------|-------------------------------------------| | `int` | a hash code value for this object.
| ### toString ``` String toString () ``` 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()) > > ```

| Returns || |--------------------------------------------------------------------|-----------------------------------------------| | [String](https://developer.android.com/reference/java/lang/String) | a string representation of the object.
| ### writeToParcel ``` void writeToParcel (Parcel dest, int flags) ```

| Parameters || |---------|-----------------| | `dest` | `Parcel`
| | `flags` | `int`
| - ## Interfaces - [BluetoothConnectionCallback](https://developer.android.com/reference/com/google/android/things/bluetooth/BluetoothConnectionCallback) - [BluetoothPairingCallback](https://developer.android.com/reference/com/google/android/things/bluetooth/BluetoothPairingCallback) - ## Classes - [BluetoothClassFactory](https://developer.android.com/reference/com/google/android/things/bluetooth/BluetoothClassFactory) - [BluetoothConfigManager](https://developer.android.com/reference/com/google/android/things/bluetooth/BluetoothConfigManager) - [BluetoothConnectionManager](https://developer.android.com/reference/com/google/android/things/bluetooth/BluetoothConnectionManager) - [BluetoothPairingCallback.PairingError](https://developer.android.com/reference/com/google/android/things/bluetooth/BluetoothPairingCallback.PairingError) - [BluetoothProfile](https://developer.android.com/reference/com/google/android/things/bluetooth/BluetoothProfile) - [BluetoothProfileManager](https://developer.android.com/reference/com/google/android/things/bluetooth/BluetoothProfileManager) - [ConnectionParams](https://developer.android.com/reference/com/google/android/things/bluetooth/ConnectionParams) - [PairingParams](https://developer.android.com/reference/com/google/android/things/bluetooth/PairingParams)