Added in API level 29

WifiAwareNetworkSpecifier


class WifiAwareNetworkSpecifier : NetworkSpecifier, Parcelable
kotlin.Any
   ↳ android.net.NetworkSpecifier
   ↳ android.net.wifi.aware.WifiAwareNetworkSpecifier

Network specifier object used to request a Wi-Fi Aware network. Apps should use the WifiAwareNetworkSpecifier.Builder class to create an instance.

Summary

Nested classes

A builder class for a Wi-Fi Aware network specifier to set up an Aware connection with a peer.

Inherited constants
Public methods
Boolean

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 specified channel in MHZ for this Wi-Fi Aware network specifier.

WifiAwareDataPathSecurityConfig?

Get the security config specified in this Network Specifier to encrypt Wi-Fi Aware data-path

Int

Returns a hash code value for the object.

Boolean

Check if the specified channel is required to honor or not.

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<WifiAwareNetworkSpecifier!>

Public methods

canBeSatisfiedBy

Added in API level 31
fun canBeSatisfiedBy(other: NetworkSpecifier!): Boolean

describeContents

Added in API level 29
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(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 29
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.

getChannelFrequencyMhz

Added in API level 33
fun getChannelFrequencyMhz(): Int

Get the specified channel in MHZ for this Wi-Fi Aware network specifier.

Return
Int Channel frequency in Mhz. A value of 0 indicates that no channel was specified.
Value is 0 or greater

getWifiAwareDataPathSecurityConfig

Added in API level 33
fun getWifiAwareDataPathSecurityConfig(): WifiAwareDataPathSecurityConfig?

Get the security config specified in this Network Specifier to encrypt Wi-Fi Aware data-path

Return
WifiAwareDataPathSecurityConfig? WifiAwareDataPathSecurityConfig used to encrypt the data-path.
This value may be null.

hashCode

Added in API level 29
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.

isChannelRequired

Added in API level 33
fun isChannelRequired(): Boolean

Check if the specified channel is required to honor or not.

Return
Boolean true if forced to honer, false for recommend to use.

toString

Added in API level 29
fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.

writeToParcel

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

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written.
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 29
static val CREATOR: Parcelable.Creator<WifiAwareNetworkSpecifier!>