Added in API level 34

AwarePairingConfig


class AwarePairingConfig : Parcelable
kotlin.Any
   ↳ 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

Builder used to build AwarePairingConfig objects.

Constants
static Int

Aware Pairing bootstrapping method NFC reader Defined as per Wi-Fi Aware specifications version 4.

static Int

Aware Pairing bootstrapping method NFC tag Defined as per Wi-Fi Aware specifications version 4.

static Int

Aware Pairing bootstrapping method opportunistic Defined as per Wi-Fi Aware specifications version 4.

static Int

Aware Pairing bootstrapping method passphrase display Defined as per Wi-Fi Aware specifications version 4.

static Int

Aware Pairing bootstrapping method passphrase keypad Defined as per Wi-Fi Aware specifications version 4.

static Int

Aware Pairing bootstrapping method pin-code display Defined as per Wi-Fi Aware specifications version 4.

static Int

Aware Pairing bootstrapping method pin-code keypad Defined as per Wi-Fi Aware specifications version 4.

static Int

Aware Pairing bootstrapping method QR-code display Defined as per Wi-Fi Aware specifications version 4.

static Int

Aware Pairing bootstrapping method QR-code scan Defined as per Wi-Fi Aware specifications version 4.

Inherited constants
Public methods
Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.

Int

Get the supported bootstrapping methods in this config.

Int

Get the supported cipher suites in this config.

Int

Returns a hash code value for the object.

Boolean

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

Boolean

Check if the Aware Pairing setup is support in the config.

Boolean

Check if the Aware Pairing verification is support in the config.

String

Returns a string representation of the object.

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<AwarePairingConfig!>

Constants

PAIRING_BOOTSTRAPPING_NFC_READER

Added in API level 34
static val PAIRING_BOOTSTRAPPING_NFC_READER: Int

Aware Pairing bootstrapping method NFC reader Defined as per Wi-Fi Aware specifications version 4.0 Section 9.5.21.7

Value: 256

PAIRING_BOOTSTRAPPING_NFC_TAG

Added in API level 34
static val PAIRING_BOOTSTRAPPING_NFC_TAG: Int

Aware Pairing bootstrapping method NFC tag Defined as per Wi-Fi Aware specifications version 4.0 Section 9.5.21.7

Value: 16

PAIRING_BOOTSTRAPPING_OPPORTUNISTIC

Added in API level 34
static val PAIRING_BOOTSTRAPPING_OPPORTUNISTIC: Int

Aware Pairing bootstrapping method opportunistic Defined as per Wi-Fi Aware specifications version 4.0 Section 9.5.21.7

Value: 1

PAIRING_BOOTSTRAPPING_PASSPHRASE_DISPLAY

Added in API level 34
static val PAIRING_BOOTSTRAPPING_PASSPHRASE_DISPLAY: Int

Aware Pairing bootstrapping method passphrase display Defined as per Wi-Fi Aware specifications version 4.0 Section 9.5.21.7

Value: 4

PAIRING_BOOTSTRAPPING_PASSPHRASE_KEYPAD

Added in API level 34
static val PAIRING_BOOTSTRAPPING_PASSPHRASE_KEYPAD: Int

Aware Pairing bootstrapping method passphrase keypad Defined as per Wi-Fi Aware specifications version 4.0 Section 9.5.21.7

Value: 64

PAIRING_BOOTSTRAPPING_PIN_CODE_DISPLAY

Added in API level 34
static val PAIRING_BOOTSTRAPPING_PIN_CODE_DISPLAY: Int

Aware Pairing bootstrapping method pin-code display Defined as per Wi-Fi Aware specifications version 4.0 Section 9.5.21.7

Value: 2

PAIRING_BOOTSTRAPPING_PIN_CODE_KEYPAD

Added in API level 34
static val PAIRING_BOOTSTRAPPING_PIN_CODE_KEYPAD: Int

Aware Pairing bootstrapping method pin-code keypad Defined as per Wi-Fi Aware specifications version 4.0 Section 9.5.21.7

Value: 32

PAIRING_BOOTSTRAPPING_QR_DISPLAY

Added in API level 34
static val PAIRING_BOOTSTRAPPING_QR_DISPLAY: Int

Aware Pairing bootstrapping method QR-code display Defined as per Wi-Fi Aware specifications version 4.0 Section 9.5.21.7

Value: 8

PAIRING_BOOTSTRAPPING_QR_SCAN

Added in API level 34
static val PAIRING_BOOTSTRAPPING_QR_SCAN: Int

Aware Pairing bootstrapping method QR-code scan Defined as per Wi-Fi Aware specifications version 4.0 Section 9.5.21.7

Value: 128

Public methods

describeContents

Added in API level 34
fun describeContents(): Int

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.

Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.
Value is either 0 or

equals

Added in API level 34
fun equals(other: Any?): Boolean

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
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getBootstrappingMethods

Added in API level 34
fun getBootstrappingMethods(): Int

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

Return
Int Value is either 0 or a combination of the following:

getSupportedCipherSuites

Added in API level 36
fun getSupportedCipherSuites(): Int

Get the supported cipher suites in this config.

Return
Int Value is either 0 or a combination of the following:

hashCode

Added in API level 34
fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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.
Return
Int a hash code value for this object.

isPairingCacheEnabled

Added in API level 34
fun isPairingCacheEnabled(): Boolean

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

isPairingSetupEnabled

Added in API level 34
fun isPairingSetupEnabled(): Boolean

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

isPairingVerificationEnabled

Added in API level 34
fun isPairingVerificationEnabled(): Boolean

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

toString

Added in API level 34
fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.

writeToParcel

Added in API level 34
fun writeToParcel(
    dest: Parcel,
    flags: Int
): Unit

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_WRITE_RETURN_VALUE.
Value is either 0 or a combination of the following:

Properties

CREATOR

Added in API level 34
static val CREATOR: Parcelable.Creator<AwarePairingConfig!>