Added in API level 14

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

WifiP2pConfig

---

Kotlin |Java

public class WifiP2pConfig
extends Object implements Parcelable

java.lang.Object
↳	android.net.wifi.p2p.WifiP2pConfig

---

A class representing a Wi-Fi P2p configuration for setting up a connection

See also:

• WifiP2pManager

Summary

Nested classes
class	WifiP2pConfig.Builder Builder used to build WifiP2pConfig objects for creating or joining a group.

Constants
int	GROUP_CLIENT_IP_PROVISIONING_MODE_IPV4_DHCP IP provisioning via IPv4 DHCP, when joining a group as a group client.
int	GROUP_CLIENT_IP_PROVISIONING_MODE_IPV6_LINK_LOCAL IP provisioning via IPv6 link-local, when joining a group as a group client.
int	GROUP_OWNER_BAND_2GHZ Allow the system to pick the operating frequency from the 2.4 GHz band.
int	GROUP_OWNER_BAND_5GHZ Allow the system to pick the operating frequency from the 5 GHz band.
int	GROUP_OWNER_BAND_AUTO Allow the system to pick the operating frequency from all supported bands.
int	GROUP_OWNER_INTENT_AUTO The system can choose an appropriate owner intent value, to be filled in the field groupOwnerIntent.
int	GROUP_OWNER_INTENT_MAX The most inclination to be a group owner, to be filled in the field groupOwnerIntent.
int	GROUP_OWNER_INTENT_MIN The least inclination to be a group owner, to be filled in the field groupOwnerIntent.

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<WifiP2pConfig>	CREATOR Implement the Parcelable interface
public String	deviceAddress The device MAC address uniquely identifies a Wi-Fi p2p device
public int	groupOwnerIntent This is an integer value between GROUP_OWNER_INTENT_MIN and GROUP_OWNER_INTENT_MAX where GROUP_OWNER_INTENT_MIN indicates the least inclination to be a group owner and GROUP_OWNER_INTENT_MAX indicates the highest inclination to be a group owner.
public WpsInfo	wps Wi-Fi Protected Setup information

Public constructors
WifiP2pConfig()
WifiP2pConfig(WifiP2pConfig source) copy constructor

Public methods
int	describeContents() Implement the Parcelable interface
int	getGroupClientIpProvisioningMode() Get the IP provisioning mode when joining a group as a group client.
int	getGroupOwnerBand() Get the required band for the group owner.
int	getNetworkId() Get the network ID of this P2P configuration.
String	getNetworkName() Get the network name of this P2P configuration, or null if unset.
String	getPassphrase() Get the passphrase of this P2P configuration, or null if unset.
String	toString() Returns a string representation of the object.
void	writeToParcel(Parcel dest, int flags) Implement the Parcelable interface

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

GROUP_CLIENT_IP_PROVISIONING_MODE_IPV4_DHCP

Added in API level 34

public static final int GROUP_CLIENT_IP_PROVISIONING_MODE_IPV4_DHCP

IP provisioning via IPv4 DHCP, when joining a group as a group client.

Constant Value: 0 (0x00000000)

GROUP_CLIENT_IP_PROVISIONING_MODE_IPV6_LINK_LOCAL

Added in API level 34

public static final int GROUP_CLIENT_IP_PROVISIONING_MODE_IPV6_LINK_LOCAL

IP provisioning via IPv6 link-local, when joining a group as a group client.

Constant Value: 1 (0x00000001)

GROUP_OWNER_BAND_2GHZ

Added in API level 29

public static final int GROUP_OWNER_BAND_2GHZ

Allow the system to pick the operating frequency from the 2.4 GHz band.

Constant Value: 1 (0x00000001)

GROUP_OWNER_BAND_5GHZ

Added in API level 29

public static final int GROUP_OWNER_BAND_5GHZ

Allow the system to pick the operating frequency from the 5 GHz band.

Constant Value: 2 (0x00000002)

GROUP_OWNER_BAND_AUTO

Added in API level 29

public static final int GROUP_OWNER_BAND_AUTO

Allow the system to pick the operating frequency from all supported bands.

Constant Value: 0 (0x00000000)

GROUP_OWNER_INTENT_AUTO

Added in API level 30

public static final int GROUP_OWNER_INTENT_AUTO

The system can choose an appropriate owner intent value, to be filled in the field groupOwnerIntent.

Constant Value: -1 (0xffffffff)

GROUP_OWNER_INTENT_MAX

Added in API level 30

public static final int GROUP_OWNER_INTENT_MAX

The most inclination to be a group owner, to be filled in the field groupOwnerIntent.

Constant Value: 15 (0x0000000f)

GROUP_OWNER_INTENT_MIN

Added in API level 30

public static final int GROUP_OWNER_INTENT_MIN

The least inclination to be a group owner, to be filled in the field groupOwnerIntent.

Constant Value: 0 (0x00000000)

Fields

CREATOR

Added in API level 14

public static final Creator<WifiP2pConfig> CREATOR

Implement the Parcelable interface

deviceAddress

Added in API level 14

public String deviceAddress

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

groupOwnerIntent

Added in API level 14

public int groupOwnerIntent

This is an integer value between GROUP_OWNER_INTENT_MIN and GROUP_OWNER_INTENT_MAX where GROUP_OWNER_INTENT_MIN indicates the least inclination to be a group owner and GROUP_OWNER_INTENT_MAX indicates the highest inclination to be a group owner. A value of GROUP_OWNER_INTENT_AUTO indicates the system can choose an appropriate value. By default this field is set to GROUP_OWNER_INTENT_AUTO.
Value is between 0 and 15 inclusive

wps

Added in API level 14

public WpsInfo wps

Wi-Fi Protected Setup information

Public constructors

WifiP2pConfig

Added in API level 14

public WifiP2pConfig ()

WifiP2pConfig

Added in API level 14

public WifiP2pConfig (WifiP2pConfig source)

copy constructor

Parameters
source	WifiP2pConfig

Public methods

describeContents

Added in API level 14

public int describeContents ()

Implement the Parcelable interface

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

getGroupClientIpProvisioningMode

Added in API level 34

public int getGroupClientIpProvisioningMode ()

Get the IP provisioning mode when joining a group as a group client. The result will be one of the following: GROUP_CLIENT_IP_PROVISIONING_MODE_IPV4_DHCP, GROUP_CLIENT_IP_PROVISIONING_MODE_IPV6_LINK_LOCAL

Returns
int	Value is GROUP_CLIENT_IP_PROVISIONING_MODE_IPV4_DHCP, or GROUP_CLIENT_IP_PROVISIONING_MODE_IPV6_LINK_LOCAL

getGroupOwnerBand

Added in API level 30

public int getGroupOwnerBand ()

Get the required band for the group owner. The result will be one of the following: GROUP_OWNER_BAND_AUTO, GROUP_OWNER_BAND_2GHZ, GROUP_OWNER_BAND_5GHZ

Returns
int	Value is GROUP_OWNER_BAND_AUTO, GROUP_OWNER_BAND_2GHZ, or GROUP_OWNER_BAND_5GHZ

getNetworkId

Added in API level 30

public int getNetworkId ()

Get the network ID of this P2P configuration.

Returns
int	either a non-negative network ID, or one of WifiP2pGroup#NETWORK_ID_PERSISTENT or WifiP2pGroup#NETWORK_ID_TEMPORARY.

getNetworkName

Added in API level 30

public String getNetworkName ()

Get the network name of this P2P configuration, or null if unset.

Returns
String

getPassphrase

Added in API level 30

public String getPassphrase ()

Get the passphrase of this P2P configuration, or null if unset.

Returns
String

toString

Added in API level 14

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in API level 14

public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES