Added in API level 14

WifiP2pDevice


open class WifiP2pDevice : Parcelable
kotlin.Any
   ↳ android.net.wifi.p2p.WifiP2pDevice

A class representing a Wi-Fi p2p device Note that the operations are not thread safe

Summary

Constants
static Int

static Int

static Int

static Int

static Int

Inherited constants
Public constructors

copy constructor

Public methods
open Int

Implement the Parcelable interface

open Boolean
equals(other: Any?)

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

open InetAddress?

Get the IP address of the connected client device.

open MutableList<ScanResult.InformationElement!>

Get the vendor-specific information elements received as part of the discovery of the peer device.

open WifiP2pWfdInfo?

The Wifi Display information for this device, or null if unavailable.

open WifiP2pConnectionInfo?

Get the P2P connection info (See WifiP2pConnectionInfo of the connected client device if the device is a part of the group, otherwise null.

open Int

Returns a hash code value for the object.

open Boolean

Returns true if the device is a group owner

open Boolean

Returns true if opportunistic bootstrapping method is supported.

open Boolean

Returns true if passphrase display bootstrapping method is supported.

open Boolean

Returns true if passphrase keypad bootstrapping method is supported.

open Boolean

Returns true if pin-code display bootstrapping method is supported.

open Boolean

Returns true if pin-code keypad bootstrapping method is supported.

open Boolean

Returns true if the device is capable of service discovery

open String

Returns a string representation of the object.

open Unit

Update this device's details using another WifiP2pDevice instance.

open Boolean

Returns true if WPS display configuration is supported

open Boolean

Returns true if WPS keypad configuration is supported

open Boolean

Returns true if WPS push button configuration is supported

open Unit
writeToParcel(dest: Parcel, flags: Int)

Implement the Parcelable interface

Properties
static Parcelable.Creator<WifiP2pDevice!>

Implement the Parcelable interface

String!

The device MAC address uniquely identifies a Wi-Fi p2p device

String!

The device name is a user friendly string to identify a Wi-Fi p2p device

String!

Primary device type identifies the type of device.

String!

Secondary device type is an optional attribute that can be provided by a device in addition to the primary device type.

Int

Device connection status

Constants

AVAILABLE

Added in API level 14
static val AVAILABLE: Int
Value: 3

CONNECTED

Added in API level 14
static val CONNECTED: Int
Value: 0

FAILED

Added in API level 14
static val FAILED: Int
Value: 2

INVITED

Added in API level 14
static val INVITED: Int
Value: 1

UNAVAILABLE

Added in API level 14
static val UNAVAILABLE: Int
Value: 4

Public constructors

WifiP2pDevice

Added in API level 14
WifiP2pDevice()

WifiP2pDevice

Added in API level 14
WifiP2pDevice(source: WifiP2pDevice!)

copy constructor

Public methods

describeContents

Added in API level 14
open fun describeContents(): Int

Implement the Parcelable interface

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

getIpAddress

Added in API level 35
open fun getIpAddress(): InetAddress?

Get the IP address of the connected client device. The application should listen to WifiP2pManager.WIFI_P2P_CONNECTION_CHANGED_ACTION broadcast to obtain the IP address of the connected client. When system assigns the IP address, the connected P2P device information (WifiP2pGroup.getClientList()) in the group is updated with the IP address and broadcast the group information using WifiP2pManager.EXTRA_WIFI_P2P_GROUP extra of the WifiP2pManager.WIFI_P2P_CONNECTION_CHANGED_ACTION broadcast intent. Alternatively, the application can request for the group details with WifiP2pManager.requestGroupInfo and use (WifiP2pGroup.getClientList()) to obtain the connected client details.

Return
InetAddress? the IP address if the device is a part of the group; otherwise null.

getVendorElements

Added in API level 33
open fun getVendorElements(): MutableList<ScanResult.InformationElement!>

Get the vendor-specific information elements received as part of the discovery of the peer device.

Return
MutableList<ScanResult.InformationElement!> the list of vendor-specific information elements The information element format is defined in the IEEE 802.11-2016 spec Table 9-77.
This value cannot be null.

getWfdInfo

Added in API level 30
open fun getWfdInfo(): WifiP2pWfdInfo?

The Wifi Display information for this device, or null if unavailable.

getWifiP2pConnectionInfo

Added in API level 14
open fun getWifiP2pConnectionInfo(): WifiP2pConnectionInfo?

Get the P2P connection info (See WifiP2pConnectionInfo of the connected client device if the device is a part of the group, otherwise null.

The application should listen to WifiP2pManager.WIFI_P2P_CONNECTION_CHANGED_ACTION broadcast to obtain the connection info of the connected client. When the client gets connected to the Group Owner, the connected P2P device information (WifiP2pGroup.getClientList()) in the group is updated with the connection information and broadcast the group information using WifiP2pManager.EXTRA_WIFI_P2P_GROUP extra of the WifiP2pManager.WIFI_P2P_CONNECTION_CHANGED_ACTION broadcast intent. Alternatively, the application can request for the group details with WifiP2pManager.requestGroupInfo and use (WifiP2pGroup.getClientList()) to obtain the connected client details.

Return
WifiP2pConnectionInfo? the p2p connection info if the device is a part of the group, otherwise null.

hashCode

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

isGroupOwner

Added in API level 14
open fun isGroupOwner(): Boolean

Returns true if the device is a group owner

isOpportunisticBootstrappingMethodSupported

Added in API level 36
open fun isOpportunisticBootstrappingMethodSupported(): Boolean

Returns true if opportunistic bootstrapping method is supported. Defined in Wi-Fi Alliance Wi-Fi Direct R2 Specification Table 10 - Bootstrapping Methods.

isPassphraseDisplayBootstrappingMethodSupported

Added in API level 36
open fun isPassphraseDisplayBootstrappingMethodSupported(): Boolean

Returns true if passphrase display bootstrapping method is supported. Defined in Wi-Fi Alliance Wi-Fi Direct R2 Specification Table 10 - Bootstrapping Methods.

isPassphraseKeypadBootstrappingMethodSupported

Added in API level 36
open fun isPassphraseKeypadBootstrappingMethodSupported(): Boolean

Returns true if passphrase keypad bootstrapping method is supported. Defined in Wi-Fi Alliance Wi-Fi Direct R2 Specification Table 10 - Bootstrapping Methods.

isPinCodeDisplayBootstrappingMethodSupported

Added in API level 36
open fun isPinCodeDisplayBootstrappingMethodSupported(): Boolean

Returns true if pin-code display bootstrapping method is supported. Defined in Wi-Fi Alliance Wi-Fi Direct R2 Specification Table 10 - Bootstrapping Methods.

isPinCodeKeypadBootstrappingMethodSupported

Added in API level 36
open fun isPinCodeKeypadBootstrappingMethodSupported(): Boolean

Returns true if pin-code keypad bootstrapping method is supported. Defined in Wi-Fi Alliance Wi-Fi Direct R2 Specification Table 10 - Bootstrapping Methods.

isServiceDiscoveryCapable

Added in API level 14
open fun isServiceDiscoveryCapable(): Boolean

Returns true if the device is capable of service discovery

toString

Added in API level 14
open fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.

update

Added in API level 30
open fun update(device: WifiP2pDevice): Unit

Update this device's details using another WifiP2pDevice instance. This will throw an exception if the device address does not match.

Parameters
device WifiP2pDevice: another instance of WifiP2pDevice used to update this instance.
This value cannot be null.
Exceptions
java.lang.IllegalArgumentException if the device is null or the device address does not match

wpsDisplaySupported

Added in API level 14
open fun wpsDisplaySupported(): Boolean

Returns true if WPS display configuration is supported

wpsKeypadSupported

Added in API level 14
open fun wpsKeypadSupported(): Boolean

Returns true if WPS keypad configuration is supported

wpsPbcSupported

Added in API level 14
open fun wpsPbcSupported(): Boolean

Returns true if WPS push button configuration is supported

writeToParcel

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

Implement the Parcelable interface

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 14
static val CREATOR: Parcelable.Creator<WifiP2pDevice!>

Implement the Parcelable interface

deviceAddress

Added in API level 14
var deviceAddress: String!

The device MAC address uniquely identifies a Wi-Fi p2p device

deviceName

Added in API level 14
var deviceName: String!

The device name is a user friendly string to identify a Wi-Fi p2p device

primaryDeviceType

Added in API level 14
var primaryDeviceType: String!

Primary device type identifies the type of device. For example, an application could filter the devices discovered to only display printers if the purpose is to enable a printing action from the user. See the Wi-Fi Direct technical specification for the full list of standard device types supported.

secondaryDeviceType

Added in API level 14
var secondaryDeviceType: String!

Secondary device type is an optional attribute that can be provided by a device in addition to the primary device type.

status

Added in API level 14
var status: Int

Device connection status