Added in API level 34

Summary: Nested Classes | Constants | Inherited Constants | Fields | Methods | Inherited Methods

AwarePairingConfig

---

Kotlin |Java

public final class AwarePairingConfig
extends Object implements Parcelable

java.lang.Object
↳	android.net.wifi.aware.AwarePairingConfig

---

The config for the Aware Pairing. Set to PublishConfig.Builder#setPairingConfig(AwarePairingConfig) and SubscribeConfig.Builder#setPairingConfig(AwarePairingConfig). Only valid when Characteristics#isAwarePairingSupported() is true.

Summary

Nested classes
class	AwarePairingConfig.Builder Builder used to build AwarePairingConfig objects.

Constants
int	PAIRING_BOOTSTRAPPING_NFC_READER Aware Pairing bootstrapping method NFC reader
int	PAIRING_BOOTSTRAPPING_NFC_TAG Aware Pairing bootstrapping method NFC tag
int	PAIRING_BOOTSTRAPPING_OPPORTUNISTIC Aware Pairing bootstrapping method opportunistic
int	PAIRING_BOOTSTRAPPING_PASSPHRASE_DISPLAY Aware Pairing bootstrapping method passphrase display
int	PAIRING_BOOTSTRAPPING_PASSPHRASE_KEYPAD Aware Pairing bootstrapping method passphrase keypad
int	PAIRING_BOOTSTRAPPING_PIN_CODE_DISPLAY Aware Pairing bootstrapping method pin-code display
int	PAIRING_BOOTSTRAPPING_PIN_CODE_KEYPAD Aware Pairing bootstrapping method pin-code keypad
int	PAIRING_BOOTSTRAPPING_QR_DISPLAY Aware Pairing bootstrapping method QR-code display
int	PAIRING_BOOTSTRAPPING_QR_SCAN Aware Pairing bootstrapping method QR-code scan

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<AwarePairingConfig>	CREATOR

Public methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
int	getBootstrappingMethods() Get the supported bootstrapping methods in this config.
int	hashCode() Returns a hash code value for the object.
boolean	isPairingCacheEnabled() Check if the NPK/NIK cache is support in the config
boolean	isPairingSetupEnabled() Check if the Aware Pairing setup is support in the config.
boolean	isPairingVerificationEnabled() Check if the Aware Pairing verification is support in the config.
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

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_NFC_READER

Added in API level 34

public static final int PAIRING_BOOTSTRAPPING_NFC_READER

Aware Pairing bootstrapping method NFC reader

Constant Value: 256 (0x00000100)

PAIRING_BOOTSTRAPPING_NFC_TAG

Added in API level 34

public static final int PAIRING_BOOTSTRAPPING_NFC_TAG

Aware Pairing bootstrapping method NFC tag

Constant Value: 16 (0x00000010)

PAIRING_BOOTSTRAPPING_OPPORTUNISTIC

Added in API level 34

public static final int PAIRING_BOOTSTRAPPING_OPPORTUNISTIC

Aware Pairing bootstrapping method opportunistic

Constant Value: 1 (0x00000001)

PAIRING_BOOTSTRAPPING_PASSPHRASE_DISPLAY

Added in API level 34

public static final int PAIRING_BOOTSTRAPPING_PASSPHRASE_DISPLAY

Aware Pairing bootstrapping method passphrase display

Constant Value: 4 (0x00000004)

PAIRING_BOOTSTRAPPING_PASSPHRASE_KEYPAD

Added in API level 34

public static final int PAIRING_BOOTSTRAPPING_PASSPHRASE_KEYPAD

Aware Pairing bootstrapping method passphrase keypad

Constant Value: 64 (0x00000040)

PAIRING_BOOTSTRAPPING_PIN_CODE_DISPLAY

Added in API level 34

public static final int PAIRING_BOOTSTRAPPING_PIN_CODE_DISPLAY

Aware Pairing bootstrapping method pin-code display

Constant Value: 2 (0x00000002)

PAIRING_BOOTSTRAPPING_PIN_CODE_KEYPAD

Added in API level 34

public static final int PAIRING_BOOTSTRAPPING_PIN_CODE_KEYPAD

Aware Pairing bootstrapping method pin-code keypad

Constant Value: 32 (0x00000020)

PAIRING_BOOTSTRAPPING_QR_DISPLAY

Added in API level 34

public static final int PAIRING_BOOTSTRAPPING_QR_DISPLAY

Aware Pairing bootstrapping method QR-code display

Constant Value: 8 (0x00000008)

PAIRING_BOOTSTRAPPING_QR_SCAN

Added in API level 34

public static final int PAIRING_BOOTSTRAPPING_QR_SCAN

Aware Pairing bootstrapping method QR-code scan

Constant Value: 128 (0x00000080)

Fields

CREATOR

Added in API level 34

public static final Creator<AwarePairingConfig> CREATOR

Public methods

describeContents

Added in API level 34

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

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

equals

Added in API level 34

public 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.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

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.

getBootstrappingMethods

Added in API level 34

public int getBootstrappingMethods ()

Get the supported bootstrapping methods in this config. Set of the STATUS_NETWORK_SUGGESTIONS_ values.

Returns
int	Value is either 0 or a combination of PAIRING_BOOTSTRAPPING_OPPORTUNISTIC, PAIRING_BOOTSTRAPPING_PIN_CODE_DISPLAY, PAIRING_BOOTSTRAPPING_PASSPHRASE_DISPLAY, PAIRING_BOOTSTRAPPING_QR_DISPLAY, PAIRING_BOOTSTRAPPING_NFC_TAG, PAIRING_BOOTSTRAPPING_PIN_CODE_KEYPAD, PAIRING_BOOTSTRAPPING_PASSPHRASE_KEYPAD, PAIRING_BOOTSTRAPPING_QR_SCAN, and PAIRING_BOOTSTRAPPING_NFC_READER

hashCode

Added in API level 34

public 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.

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 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 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.

Returns
int	a hash code value for this object.

isPairingCacheEnabled

Added in API level 34

public boolean isPairingCacheEnabled ()

Check if the NPK/NIK cache is support in the config

Returns
boolean

isPairingSetupEnabled

Added in API level 34

public boolean isPairingSetupEnabled ()

Check if the Aware Pairing setup is support in the config. Setup is the first time for two device establish Aware Pairing

Returns
boolean

isPairingVerificationEnabled

Added in API level 34

public boolean isPairingVerificationEnabled ()

Check if the Aware Pairing verification is support in the config. Verification is for two device already paired and re-establish with cached NPK/NIK

Returns
boolean

writeToParcel

Added in API level 34

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

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