SubscribeConfig
class SubscribeConfig : Parcelable
| kotlin.Any | |
| ↳ | android.net.wifi.aware.SubscribeConfig |
Defines the configuration of an Aware subscribe session. Built using SubscribeConfig.Builder. Subscribe is done using WifiAwareSession.subscribe(SubscribeConfig, DiscoverySessionCallback, android.os.Handler) or SubscribeDiscoverySession.updateSubscribe(SubscribeConfig).
Summary
| Nested classes | |
|---|---|
|
Builder used to build |
|
| Constants | |
|---|---|
| static Int |
Defines an active subscribe session - a subscribe session where subscribe packets are transmitted over-the-air. |
| static Int |
Defines a passive subscribe session - a subscribe session where subscribe packets are not transmitted over-the-air and the device listens and matches to transmitted publish packets. |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| Int |
Get the egress distance in mm. |
| Int |
Get the ingress distance in mm. |
| Int |
Check if enable instant mode on 5G for this subscribe session |
| AwarePairingConfig? |
Get the Aware Pairing config for this subscribe session |
| Int |
hashCode()Returns a hash code value for the object. |
| Boolean |
Check if instant mode is enabled for this subscribe session. |
| String |
toString()Returns a string representation of the object. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<SubscribeConfig!> | |
Constants
SUBSCRIBE_TYPE_ACTIVE
static val SUBSCRIBE_TYPE_ACTIVE: Int
Defines an active subscribe session - a subscribe session where subscribe packets are transmitted over-the-air. Configuration is done using SubscribeConfig.Builder.setSubscribeType(int).
Value: 1SUBSCRIBE_TYPE_PASSIVE
static val SUBSCRIBE_TYPE_PASSIVE: Int
Defines a passive subscribe session - a subscribe session where subscribe packets are not transmitted over-the-air and the device listens and matches to transmitted publish packets. Configuration is done using SubscribeConfig.Builder.setSubscribeType(int).
Value: 0Public methods
describeContents
fun describeContents(): Int
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.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
equals
fun equals(other: Any?): Boolean
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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 | |
|---|---|
obj |
the reference object with which to compare. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getEgressDistanceMm
fun getEgressDistanceMm(): Int
Get the egress distance in mm. See Builder.setEgressDistanceMm(int).
| Return | |
|---|---|
Int |
The egress distance in mm. |
| Exceptions | |
|---|---|
java.lang.IllegalStateException |
if the value was not set. |
getIngressDistanceMm
fun getIngressDistanceMm(): Int
Get the ingress distance in mm. See Builder.setIngressDistanceMm(int).
| Return | |
|---|---|
Int |
The ingress distance in mm. |
| Exceptions | |
|---|---|
java.lang.IllegalStateException |
if the value was not set. |
getInstantCommunicationBand
fun getInstantCommunicationBand(): Int
Check if enable instant mode on 5G for this subscribe session
| Return | |
|---|---|
Int |
If instant communication mode is not enabled will return ScanResult.WIFI_BAND_24_GHZ as default. Value is one of the following: |
getPairingConfig
fun getPairingConfig(): AwarePairingConfig?
Get the Aware Pairing config for this subscribe session
| Return | |
|---|---|
AwarePairingConfig? |
A AwarePairingConfig specified in this config. This value may be null. |
hashCode
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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.
| Return | |
|---|---|
Int |
a hash code value for this object. |
isInstantCommunicationModeEnabled
fun isInstantCommunicationModeEnabled(): Boolean
Check if instant mode is enabled for this subscribe session.
| Return | |
|---|---|
Boolean |
true for enabled, false otherwise. |
toString
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
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_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following:
|