AwarePairingConfig
  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.BuilderBuilder used to build  | 
| Constants | |
|---|---|
| int | PAIRING_BOOTSTRAPPING_NFC_READERAware Pairing bootstrapping method NFC reader | 
| int | PAIRING_BOOTSTRAPPING_NFC_TAGAware Pairing bootstrapping method NFC tag | 
| int | PAIRING_BOOTSTRAPPING_OPPORTUNISTICAware Pairing bootstrapping method opportunistic | 
| int | PAIRING_BOOTSTRAPPING_PASSPHRASE_DISPLAYAware Pairing bootstrapping method passphrase display | 
| int | PAIRING_BOOTSTRAPPING_PASSPHRASE_KEYPADAware Pairing bootstrapping method passphrase keypad | 
| int | PAIRING_BOOTSTRAPPING_PIN_CODE_DISPLAYAware Pairing bootstrapping method pin-code display | 
| int | PAIRING_BOOTSTRAPPING_PIN_CODE_KEYPADAware Pairing bootstrapping method pin-code keypad | 
| int | PAIRING_BOOTSTRAPPING_QR_DISPLAYAware Pairing bootstrapping method QR-code display | 
| int | PAIRING_BOOTSTRAPPING_QR_SCANAware Pairing bootstrapping method QR-code scan | 
| Inherited constants | 
|---|
| 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 | 
      getSupportedCipherSuites()
      Get the supported cipher suites 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 | |
|---|---|
Constants
PAIRING_BOOTSTRAPPING_NFC_READER
public static final int PAIRING_BOOTSTRAPPING_NFC_READER
Aware Pairing bootstrapping method NFC reader
Constant Value: 256 (0x00000100)
PAIRING_BOOTSTRAPPING_NFC_TAG
public static final int PAIRING_BOOTSTRAPPING_NFC_TAG
Aware Pairing bootstrapping method NFC tag
Constant Value: 16 (0x00000010)
PAIRING_BOOTSTRAPPING_OPPORTUNISTIC
public static final int PAIRING_BOOTSTRAPPING_OPPORTUNISTIC
Aware Pairing bootstrapping method opportunistic
Constant Value: 1 (0x00000001)
PAIRING_BOOTSTRAPPING_PASSPHRASE_DISPLAY
public static final int PAIRING_BOOTSTRAPPING_PASSPHRASE_DISPLAY
Aware Pairing bootstrapping method passphrase display
Constant Value: 4 (0x00000004)
PAIRING_BOOTSTRAPPING_PASSPHRASE_KEYPAD
public static final int PAIRING_BOOTSTRAPPING_PASSPHRASE_KEYPAD
Aware Pairing bootstrapping method passphrase keypad
Constant Value: 64 (0x00000040)
PAIRING_BOOTSTRAPPING_PIN_CODE_DISPLAY
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
public static final int PAIRING_BOOTSTRAPPING_PIN_CODE_KEYPAD
Aware Pairing bootstrapping method pin-code keypad
Constant Value: 32 (0x00000020)
PAIRING_BOOTSTRAPPING_QR_DISPLAY
public static final int PAIRING_BOOTSTRAPPING_QR_DISPLAY
Aware Pairing bootstrapping method QR-code display
Constant Value: 8 (0x00000008)
PAIRING_BOOTSTRAPPING_QR_SCAN
public static final int PAIRING_BOOTSTRAPPING_QR_SCAN
Aware Pairing bootstrapping method QR-code scan
Constant Value: 128 (0x00000080)
Fields
Public methods
describeContents
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 0orCONTENTS_FILE_DESCRIPTOR | 
equals
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 returntrue.
- It is symmetric: for any non-null reference values
     xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue.
- It is transitive: for any non-null reference values
     x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue.
- It is consistent: for any non-null reference values
     xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified.
- For any non-null reference value x,x.equals(null)should returnfalse.
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 | trueif this object is the same as the obj
          argument;falseotherwise. | 
getBootstrappingMethods
public int getBootstrappingMethods ()
Get the supported bootstrapping methods in this config. Set of the PAIRING_BOOTSTRAPPING_ values.
getSupportedCipherSuites
public int getSupportedCipherSuites ()
Get the supported cipher suites in this config.
| Returns | |
|---|---|
| int | Value is either 0or a combination ofCharacteristics.WIFI_AWARE_CIPHER_SUITE_NCS_PK_PASN_128, andCharacteristics.WIFI_AWARE_CIPHER_SUITE_NCS_PK_PASN_256 | 
hashCode
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 hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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 equalsmethod, then calling thehashCodemethod 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 equalsmethod, then calling thehashCodemethod 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
public boolean isPairingCacheEnabled ()
Check if the NPK/NIK cache is support in the config
| Returns | |
|---|---|
| boolean | |
isPairingSetupEnabled
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
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
public void writeToParcel (Parcel dest, int flags)
Flatten this object in to a Parcel.
| Parameters | |
|---|---|
| dest | Parcel: This value cannot benull. | 
| flags | int: Additional flags about how the object should be written.
 May be 0 orParcelable.PARCELABLE_WRITE_RETURN_VALUE.
 Value is either0or a combination ofParcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES | 
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-10-15 UTC.
