WifiP2pGroup

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:

Summary

Constants

int NETWORK_ID_PERSISTENT

The persistent network id.

int NETWORK_ID_TEMPORARY

The temporary network id.

Inherited constants

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

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.

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

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:

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:

Constant Value: -1 (0xffffffff)

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

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

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