PublishConfig

Kotlin |Java

class PublishConfig : Parcelable

kotlin.Any
↳	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, or updated using PublishDiscoverySession#updatePublish(PublishConfig).

Summary

Nested classes
	`Builder` Builder used to build `PublishConfig` objects.

Constants
static 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.
static 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

From class 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: 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)". Some implementations may want to release resources at this point.

Public methods
Int	`describeContents()`
Boolean	`equals(other: Any?)`
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()`
Boolean	`isInstantCommunicationModeEnabled()` Check if instant communication mode is enabled for this publish session.
String	`toString()`
Unit	`writeToParcel(dest: Parcel, flags: Int)`

Properties
static Parcelable.Creator<PublishConfig!>	`CREATOR`

Constants

PUBLISH_TYPE_SOLICITED

Added in API level 26

static val PUBLISH_TYPE_SOLICITED: Int

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).

Value: 1

PUBLISH_TYPE_UNSOLICITED

Added in API level 26

static val PUBLISH_TYPE_UNSOLICITED: Int

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).

Value: 0

Public methods

describeContents

Added in API level 26

fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level 26

fun equals(other: Any?): Boolean

Parameters
`obj`	the reference object with which to compare.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getInstantCommunicationBand

Added in API level 33

fun getInstantCommunicationBand(): Int

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

Return
`Int`	The Wi-Fi band. If instant communication mode is not enabled will return `android.net.wifi.ScanResult#WIFI_BAND_24_GHZ` as default. Value is `android.net.wifi.ScanResult#WIFI_BAND_24_GHZ`, or `android.net.wifi.ScanResult#WIFI_BAND_5_GHZ`

See Also

android.net.wifi.aware.PublishConfig.Builder#setInstantCommunicationModeEnabled(boolean, int)

getPairingConfig

Added in API level 34

fun getPairingConfig(): AwarePairingConfig?

Get the Aware Pairing config for this publish session

Return
`AwarePairingConfig?`	A `AwarePairingConfig` specified in this config. This value may be `null`.

See Also

android.net.wifi.aware.PublishConfig.Builder#setPairingConfig(AwarePairingConfig)

getSecurityConfig

Added in API level 33

fun getSecurityConfig(): WifiAwareDataPathSecurityConfig?

Get the data-path security config for this publish session

Return
`WifiAwareDataPathSecurityConfig?`	A `WifiAwareDataPathSecurityConfig` specified in this config. This value may be `null`.

See Also

android.net.wifi.aware.PublishConfig.Builder#setDataPathSecurityConfig(WifiAwareDataPathSecurityConfig)

hashCode

Added in API level 26

fun hashCode(): Int

Return
`Int`	a hash code value for this object.

isInstantCommunicationModeEnabled

Added in API level 33

fun isInstantCommunicationModeEnabled(): Boolean

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

Return
`Boolean`	true for enabled, false otherwise.

See Also

android.net.wifi.aware.PublishConfig.Builder#setInstantCommunicationModeEnabled(boolean, int)

toString

Added in API level 26

fun toString(): String

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 26

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

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

Properties

CREATOR

Added in API level 26

static val CREATOR: Parcelable.Creator<PublishConfig!>