PublishConfig


public final class PublishConfig
extends Object implements Parcelable

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


Defines the configuration of an Aware publish session. Built using PublishConfig.Builder. A publish session is created using WifiAwareSession#publish(PublishConfig, DiscoverySessionCallback, android.os.Handler) or updated using PublishDiscoverySession#updatePublish(PublishConfig).

Summary

Nested classes

class PublishConfig.Builder

Builder used to build PublishConfig objects. 

Constants

int PUBLISH_TYPE_SOLICITED

Defines a solicited publish session - a publish session which is silent, waiting for a matching active subscribe session - and responding to it in unicast.

int PUBLISH_TYPE_UNSOLICITED

Defines an unsolicited publish session - a publish session where the publisher is advertising itself by broadcasting on-the-air.

Inherited constants

Fields

public static final Creator<PublishConfig> CREATOR

Public methods

int describeContents()

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

boolean equals(Object o)

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

int getInstantCommunicationBand()

Get the Wi-Fi band for instant communication mode for this publish session

AwarePairingConfig getPairingConfig()

Get the Aware Pairing config for this publish session

WifiAwareDataPathSecurityConfig getSecurityConfig()

Get the data-path security config for this publish session

int hashCode()

Returns a hash code value for the object.

boolean isInstantCommunicationModeEnabled()

Check if instant communication mode is enabled for this publish session.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

PUBLISH_TYPE_SOLICITED

Added in API level 26
public static final int PUBLISH_TYPE_SOLICITED

Defines a solicited publish session - a publish session which is silent, waiting for a matching active subscribe session - and responding to it in unicast. A solicited publish session is paired with an active subscribe session SubscribeConfig#SUBSCRIBE_TYPE_ACTIVE. Configuration is done using PublishConfig.Builder#setPublishType(int).

Constant Value: 1 (0x00000001)

PUBLISH_TYPE_UNSOLICITED

Added in API level 26
public static final int PUBLISH_TYPE_UNSOLICITED

Defines an unsolicited publish session - a publish session where the publisher is advertising itself by broadcasting on-the-air. An unsolicited publish session is paired with a passive subscribe session SubscribeConfig#SUBSCRIBE_TYPE_PASSIVE. Configuration is done using PublishConfig.Builder#setPublishType(int).

Constant Value: 0 (0x00000000)

Fields

CREATOR

Added in API level 26
public static final Creator<PublishConfig> CREATOR

Public methods

describeContents

Added in API level 26
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

equals

Added in API level 26
public boolean equals (Object o)

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
o Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getInstantCommunicationBand

Added in API level 33
public int getInstantCommunicationBand ()

Get the Wi-Fi band for instant communication mode for this publish session

Returns
int The Wi-Fi band. If instant communication mode is not enabled will return ScanResult.WIFI_BAND_24_GHZ as default. Value is ScanResult.WIFI_BAND_24_GHZ, or ScanResult.WIFI_BAND_5_GHZ

getPairingConfig

Added in API level 34
public AwarePairingConfig getPairingConfig ()

Get the Aware Pairing config for this publish session

Returns
AwarePairingConfig A AwarePairingConfig specified in this config. This value may be null.

getSecurityConfig

Added in API level 33
public WifiAwareDataPathSecurityConfig getSecurityConfig ()

Get the data-path security config for this publish session

Returns
WifiAwareDataPathSecurityConfig A WifiAwareDataPathSecurityConfig specified in this config. This value may be null.

hashCode

Added in API level 26
public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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.

Returns
int a hash code value for this object.

isInstantCommunicationModeEnabled

Added in API level 33
public boolean isInstantCommunicationModeEnabled ()

Check if instant communication mode is enabled for this publish session.

Returns
boolean true for enabled, false otherwise.

toString

Added in API level 26
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

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

Flatten this object in to a Parcel.

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