Added in API level 36

WifiP2pPairingBootstrappingConfig

Kotlin |Java

public final class WifiP2pPairingBootstrappingConfig
extends Object implements Parcelable

java.lang.Object
↳	android.net.wifi.p2p.WifiP2pPairingBootstrappingConfig

A class representing Wi-Fi Direct pairing bootstrapping configuration.

See also:

WifiP2pConfig

Summary

Constants
`int`	`PAIRING_BOOTSTRAPPING_METHOD_DISPLAY_PASSPHRASE` Pairing bootstrapping method display passphrase - The passphrase is displayed on the connection initiating device.
`int`	`PAIRING_BOOTSTRAPPING_METHOD_DISPLAY_PINCODE` Pairing bootstrapping method display pin-code - The pin-code is displayed on the connection initiating device.
`int`	`PAIRING_BOOTSTRAPPING_METHOD_KEYPAD_PASSPHRASE` Pairing bootstrapping method keypad passphrase - The passphrase is displayed on the other device.
`int`	`PAIRING_BOOTSTRAPPING_METHOD_KEYPAD_PINCODE` Pairing bootstrapping method keypad pin-code - The pin-code is displayed on the other device.
`int`	`PAIRING_BOOTSTRAPPING_METHOD_OPPORTUNISTIC` Pairing bootstrapping method opportunistic
`int`	`PAIRING_BOOTSTRAPPING_METHOD_OUT_OF_BAND` Pairing bootstrapping done out of band (For example: Over Bluetooth LE.

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<WifiP2pPairingBootstrappingConfig>`	`CREATOR` Implement the Parcelable interface

Public constructors
`WifiP2pPairingBootstrappingConfig(int method, String password)` Constructor for a WifiP2pPairingBootstrappingConfig.

Public methods
`int`	`describeContents()` Implement the Parcelable interface
`int`	`getPairingBootstrappingMethod()` Gets the current pairing bootstrapping method.
`String`	`getPairingBootstrappingPassword()` Retrieves the PIN or password used for the current pairing bootstrapping method.
`String`	`toString()` Generates a string of all the defined elements.
`void`	`writeToParcel(Parcel dest, int flags)` Implement the Parcelable interface

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

PAIRING_BOOTSTRAPPING_METHOD_DISPLAY_PASSPHRASE

Added in API level 36

public static final int PAIRING_BOOTSTRAPPING_METHOD_DISPLAY_PASSPHRASE

Pairing bootstrapping method display passphrase - The passphrase is displayed on the connection initiating device. The user enters the displayed passphrase on the other device.

Constant Value: 4 (0x00000004)

PAIRING_BOOTSTRAPPING_METHOD_DISPLAY_PINCODE

Added in API level 36

public static final int PAIRING_BOOTSTRAPPING_METHOD_DISPLAY_PINCODE

Pairing bootstrapping method display pin-code - The pin-code is displayed on the connection initiating device. The user enters the displayed pin-code on the other device.

Constant Value: 2 (0x00000002)

PAIRING_BOOTSTRAPPING_METHOD_KEYPAD_PASSPHRASE

Added in API level 36

public static final int PAIRING_BOOTSTRAPPING_METHOD_KEYPAD_PASSPHRASE

Pairing bootstrapping method keypad passphrase - The passphrase is displayed on the other device. The user enters the displayed passphrase on the connection initiating device.

Constant Value: 16 (0x00000010)

PAIRING_BOOTSTRAPPING_METHOD_KEYPAD_PINCODE

Added in API level 36

public static final int PAIRING_BOOTSTRAPPING_METHOD_KEYPAD_PINCODE

Pairing bootstrapping method keypad pin-code - The pin-code is displayed on the other device. The user enters the displayed pin-code on the connection initiating device.

Constant Value: 8 (0x00000008)

PAIRING_BOOTSTRAPPING_METHOD_OPPORTUNISTIC

Added in API level 36

public static final int PAIRING_BOOTSTRAPPING_METHOD_OPPORTUNISTIC

Pairing bootstrapping method opportunistic

Constant Value: 1 (0x00000001)

PAIRING_BOOTSTRAPPING_METHOD_OUT_OF_BAND

Added in API level 36

public static final int PAIRING_BOOTSTRAPPING_METHOD_OUT_OF_BAND

Pairing bootstrapping done out of band (For example: Over Bluetooth LE. Refer Wi-Fi Alliance Wi-Fi Direct R2 specification Section 3.9 for the details).

Constant Value: 32 (0x00000020)

Fields

CREATOR

Added in API level 36

public static final Creator<WifiP2pPairingBootstrappingConfig> CREATOR

Implement the Parcelable interface

Public constructors

WifiP2pPairingBootstrappingConfig

Added in API level 36

public WifiP2pPairingBootstrappingConfig (int method, 
                String password)

Constructor for a WifiP2pPairingBootstrappingConfig.

Parameters

Parameters
`method`	`int`: One of the `PAIRING_BOOTSTRAPPING_METHOD_*`. Value is either `0` or a combination of `PAIRING_BOOTSTRAPPING_METHOD_OPPORTUNISTIC`, `PAIRING_BOOTSTRAPPING_METHOD_DISPLAY_PINCODE`, `PAIRING_BOOTSTRAPPING_METHOD_DISPLAY_PASSPHRASE`, `PAIRING_BOOTSTRAPPING_METHOD_KEYPAD_PINCODE`, `PAIRING_BOOTSTRAPPING_METHOD_KEYPAD_PASSPHRASE`, and `PAIRING_BOOTSTRAPPING_METHOD_OUT_OF_BAND`
`password`	`String`: Password or PIN for pairing setup. if `method` is `PAIRING_BOOTSTRAPPING_METHOD_DISPLAY_PINCODE`, the password must be a string containing 4 or more digits (0-9). For example: "1234", "56789". if `method` is `PAIRING_BOOTSTRAPPING_METHOD_DISPLAY_PASSPHRASE` or `PAIRING_BOOTSTRAPPING_METHOD_OUT_OF_BAND`, the password must be a UTF-8 string of minimum of 1 character. The password must be set to null if the `method` is `PAIRING_BOOTSTRAPPING_METHOD_OPPORTUNISTIC`, `PAIRING_BOOTSTRAPPING_METHOD_KEYPAD_PINCODE` or `PAIRING_BOOTSTRAPPING_METHOD_KEYPAD_PASSPHRASE`.

method

int: One of the PAIRING_BOOTSTRAPPING_METHOD_*. Value is either 0 or a combination of PAIRING_BOOTSTRAPPING_METHOD_OPPORTUNISTIC, PAIRING_BOOTSTRAPPING_METHOD_DISPLAY_PINCODE, PAIRING_BOOTSTRAPPING_METHOD_DISPLAY_PASSPHRASE, PAIRING_BOOTSTRAPPING_METHOD_KEYPAD_PINCODE, PAIRING_BOOTSTRAPPING_METHOD_KEYPAD_PASSPHRASE, and PAIRING_BOOTSTRAPPING_METHOD_OUT_OF_BAND

password

String: Password or PIN for pairing setup. if method is PAIRING_BOOTSTRAPPING_METHOD_DISPLAY_PINCODE, the password must be a string containing 4 or more digits (0-9). For example: "1234", "56789". if method is PAIRING_BOOTSTRAPPING_METHOD_DISPLAY_PASSPHRASE or PAIRING_BOOTSTRAPPING_METHOD_OUT_OF_BAND, the password must be a UTF-8 string of minimum of 1 character. The password must be set to null if the method is PAIRING_BOOTSTRAPPING_METHOD_OPPORTUNISTIC, PAIRING_BOOTSTRAPPING_METHOD_KEYPAD_PINCODE or PAIRING_BOOTSTRAPPING_METHOD_KEYPAD_PASSPHRASE.

Throws
`IllegalArgumentException`	if the input pairing bootstrapping method is not one of the `PAIRING_BOOTSTRAPPING_METHOD_*`.
`IllegalArgumentException`	if a non-null password is set for pairing bootstrapping method `PAIRING_BOOTSTRAPPING_METHOD_OPPORTUNISTIC`, `PAIRING_BOOTSTRAPPING_METHOD_KEYPAD_PINCODE` or `PAIRING_BOOTSTRAPPING_METHOD_KEYPAD_PASSPHRASE`.

Public methods

describeContents

Added in API level 36

public int describeContents ()

Implement the Parcelable interface

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getPairingBootstrappingMethod

Added in Android Baklava

public int getPairingBootstrappingMethod ()

Gets the current pairing bootstrapping method.

Returns
`int`	The current pairing bootstrapping method. Value is either `0` or a combination of `PAIRING_BOOTSTRAPPING_METHOD_OPPORTUNISTIC`, `PAIRING_BOOTSTRAPPING_METHOD_DISPLAY_PINCODE`, `PAIRING_BOOTSTRAPPING_METHOD_DISPLAY_PASSPHRASE`, `PAIRING_BOOTSTRAPPING_METHOD_KEYPAD_PINCODE`, `PAIRING_BOOTSTRAPPING_METHOD_KEYPAD_PASSPHRASE`, and `PAIRING_BOOTSTRAPPING_METHOD_OUT_OF_BAND`

getPairingBootstrappingPassword

Added in Android Baklava

public String getPairingBootstrappingPassword ()

Retrieves the PIN or password used for the current pairing bootstrapping method.

The specific type and format of the returned value depend on the active pairing bootstrapping method:

If the method is PAIRING_BOOTSTRAPPING_METHOD_DISPLAY_PINCODE or PAIRING_BOOTSTRAPPING_METHOD_KEYPAD_PINCODE, this method returns a PIN. A PIN is a string consisting of 4 or more digits (0-9).

If the method is PAIRING_BOOTSTRAPPING_METHOD_DISPLAY_PASSPHRASE or PAIRING_BOOTSTRAPPING_METHOD_KEYPAD_PASSPHRASE this method returns a password. A password is a UTF-8 encoded string with a minimum length of 1 character.

Returns
`String`	The PIN or password as a `String`, or `null` if not applicable for the current pairing bootstrapping method.

toString

Added in API level 36

public String toString ()

Generates a string of all the defined elements.

Returns
`String`	a compiled string representing all elements

writeToParcel

Added in API level 36

public void writeToParcel (Parcel dest, 
                int flags)

Implement the Parcelable interface

Parameters
`dest`	`Parcel`: This value cannot be `null`.
`flags`	`int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES