Added in API level 14

WifiP2pGroup

Kotlin |Java

public class WifiP2pGroup
extends Object implements Parcelable

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

A class representing a Wi-Fi P2p group. A p2p group consists of a single group owner and one or more clients. In the case of a group with only two devices, one will be the group owner and the other will be a group client.

See also:

WifiP2pManager

Summary

Constants
`int`	`NETWORK_ID_PERSISTENT` The persistent network id.
`int`	`NETWORK_ID_TEMPORARY` The temporary network id.
`int`	`SECURITY_TYPE_UNKNOWN` The definition of security type unknown.
`int`	`SECURITY_TYPE_WPA2_PSK` The definition of security type WPA2-PSK.
`int`	`SECURITY_TYPE_WPA3_COMPATIBILITY` The definition of security type WPA3-Compatibility Mode.
`int`	`SECURITY_TYPE_WPA3_SAE` The definition of security type WPA3-SAE.

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<WifiP2pGroup>`	`CREATOR` Implement the Parcelable interface

Public constructors
`WifiP2pGroup()`
`WifiP2pGroup(WifiP2pGroup source)` copy constructor

Public methods
`int`	`describeContents()` Implement the Parcelable interface
`Collection<WifiP2pDevice>`	`getClientList()` Get the list of clients currently part of the p2p group
`int`	`getFrequency()` Get the operating frequency (in MHz) of the p2p group
`MacAddress`	`getGroupOwnerBssid()` Returns the BSSID, if this device is the group owner of the P2P group supporting Wi-Fi Direct R2 protocol.
`String`	`getInterface()` Get the interface name on which the group is created
`int`	`getNetworkId()` The network ID of the P2P group in wpa_supplicant.
`String`	`getNetworkName()` Get the network name (SSID) of the group.
`WifiP2pDevice`	`getOwner()` Get the details of the group owner as a `WifiP2pDevice` object
`String`	`getPassphrase()` Get the passphrase of the group.
`int`	`getSecurityType()` Get the security type of the group.
`boolean`	`isGroupOwner()` Check whether this device is the group owner of the created p2p group
`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

NETWORK_ID_PERSISTENT

Added in API level 30

public static final int NETWORK_ID_PERSISTENT

The persistent network id. If a matching persistent profile is found, use it. Otherwise, create a new persistent profile.

See also:

getNetworkId()

Constant Value: -2 (0xfffffffe)

NETWORK_ID_TEMPORARY

Added in API level 30

public static final int NETWORK_ID_TEMPORARY

The temporary network id.

See also:

getNetworkId()

Constant Value: -1 (0xffffffff)

SECURITY_TYPE_UNKNOWN

Added in API level 36

public static final int SECURITY_TYPE_UNKNOWN

The definition of security type unknown. It is set when framework fails to derive the security type from the authentication key management provided by wpa_supplicant.

Constant Value: -1 (0xffffffff)

SECURITY_TYPE_WPA2_PSK

Added in API level 36

public static final int SECURITY_TYPE_WPA2_PSK

The definition of security type WPA2-PSK.

Constant Value: 0 (0x00000000)

SECURITY_TYPE_WPA3_COMPATIBILITY

Added in API level 36

public static final int SECURITY_TYPE_WPA3_COMPATIBILITY

The definition of security type WPA3-Compatibility Mode.

Constant Value: 1 (0x00000001)

SECURITY_TYPE_WPA3_SAE

Added in API level 36

public static final int SECURITY_TYPE_WPA3_SAE

The definition of security type WPA3-SAE.

Constant Value: 2 (0x00000002)

Fields

CREATOR

Added in API level 14

public static final Creator<WifiP2pGroup> CREATOR

Implement the Parcelable interface

Public constructors

WifiP2pGroup

Added in API level 14

public WifiP2pGroup ()

WifiP2pGroup

Added in API level 14

public WifiP2pGroup (WifiP2pGroup source)

copy constructor

Parameters
`source`	`WifiP2pGroup`

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`

getClientList

Added in API level 14

public Collection<WifiP2pDevice> getClientList ()

Get the list of clients currently part of the p2p group

Returns
`Collection<WifiP2pDevice>`

getFrequency

Added in API level 29

public int getFrequency ()

Get the operating frequency (in MHz) of the p2p group

Returns
`int`

getGroupOwnerBssid

Added in API level 36

public MacAddress getGroupOwnerBssid ()

Returns the BSSID, if this device is the group owner of the P2P group supporting Wi-Fi Direct R2 protocol.

The interface address of a Wi-Fi Direct R2 supported device is randomized. So for every group owner session a randomized interface address will be returned.

The BSSID returned will be null, if this device is a client device or a group owner which doesn't support Wi-Fi Direct R2 protocol.

Returns
`MacAddress`	the BSSID.

getInterface

Added in API level 14

public String getInterface ()

Get the interface name on which the group is created

Returns
`String`

getNetworkId

Added in API level 30

public int getNetworkId ()

The network ID of the P2P group in wpa_supplicant.

Returns
`int`

getNetworkName

Added in API level 14

public String getNetworkName ()

Get the network name (SSID) of the group. Legacy Wi-Fi clients will discover the p2p group using the network name.

Returns
`String`

getOwner

Added in API level 14

public WifiP2pDevice getOwner ()

Get the details of the group owner as a WifiP2pDevice object

Returns
`WifiP2pDevice`

getPassphrase

Added in API level 14

public String getPassphrase ()

Get the passphrase of the group. This function will return a valid passphrase only at the group owner. Legacy Wi-Fi clients will need this passphrase alongside network name obtained from getNetworkName() to join the group

Returns
`String`

getSecurityType

Added in API level 36

public int getSecurityType ()

Get the security type of the group.

Returns
`int`	One of the `SECURITY_TYPE_*`. Value is `SECURITY_TYPE_UNKNOWN`, `SECURITY_TYPE_WPA2_PSK`, `SECURITY_TYPE_WPA3_COMPATIBILITY`, or `SECURITY_TYPE_WPA3_SAE`

isGroupOwner

Added in API level 14

public boolean isGroupOwner ()

Check whether this device is the group owner of the created p2p group

Returns
`boolean`

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