AwareResources

public final class AwareResources
extends Object implements Parcelable

java.lang.Object
   ↳ android.net.wifi.aware.AwareResources


The resources of the Aware service.

Summary

Inherited constants

Fields

public static final Creator<AwareResources> CREATOR

Public constructors

AwareResources(int availableDataPathsCount, int availablePublishSessionsCount, int availableSubscribeSessionsCount)

Construct a AwareResources object, which represents the currently available Aware resources.

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

int getAvailableDataPathsCount()

Return the number of Aware data-paths (also known as NDPs - NAN Data Paths) which an app could create.

int getAvailablePublishSessionsCount()

Return the number of Aware publish sessions which an app could create.

int getAvailableSubscribeSessionsCount()

Return the number of Aware subscribe sessions which an app could create.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 31
public static final Creator<AwareResources> CREATOR

Public constructors

AwareResources

Added in API level 31
public AwareResources (int availableDataPathsCount, 
                int availablePublishSessionsCount, 
                int availableSubscribeSessionsCount)

Construct a AwareResources object, which represents the currently available Aware resources.

Parameters
availableDataPathsCount int: Number of available Aware data-path. Value is 0 or greater

availablePublishSessionsCount int: Number of available Aware publish sessions. Value is 0 or greater

availableSubscribeSessionsCount int: Number of available Aware subscribe sessions. Value is 0 or greater

Public methods

describeContents

Added in API level 31
public int describeContents ()

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(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

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

getAvailableDataPathsCount

Added in API level 31
public int getAvailableDataPathsCount ()

Return the number of Aware data-paths (also known as NDPs - NAN Data Paths) which an app could create. Please refer to the WifiAwareNetworkSpecifier to create a Network Specifier and request a data-path.

Note that these resources aren't reserved - other apps could use them by the time you attempt to create a data-path.

Returns
int A Non-negative integer, number of data-paths that could be created. Value is 0 or greater

getAvailablePublishSessionsCount

Added in API level 31
public int getAvailablePublishSessionsCount ()

Return the number of Aware publish sessions which an app could create. Please refer to the WifiAwareSession#publish(PublishConfig, DiscoverySessionCallback, Handler) to create a publish session.

Note that these resources aren't reserved - other apps could use them by the time you attempt to create a publish session.

Returns
int A Non-negative integer, number of publish sessions that could be created. Value is 0 or greater

getAvailableSubscribeSessionsCount

Added in API level 31
public int getAvailableSubscribeSessionsCount ()

Return the number of Aware subscribe sessions which an app could create. Please refer to the WifiAwareSession#subscribe(SubscribeConfig, DiscoverySessionCallback, Handler) to create a subscribe session.

Note that these resources aren't reserved - other apps could use them by the time you attempt to create a subscribe session.

Returns
int A Non-negative integer, number of subscribe sessions that could be created. Value is 0 or greater

writeToParcel

Added in API level 31
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: 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