SubscribeConfig
  public
  
  final
  
  class
  SubscribeConfig
  
    extends Object
  
  
  
  
  
      implements
      
        Parcelable
      
  
  
| java.lang.Object | |
| ↳ | 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 | |
|---|---|
| 
        
        
        
        
        class | SubscribeConfig.BuilderBuilder used to build  | 
| Constants | |
|---|---|
| int | SUBSCRIBE_TYPE_ACTIVEDefines an active subscribe session - a subscribe session where subscribe packets are transmitted over-the-air. | 
| int | SUBSCRIBE_TYPE_PASSIVEDefines 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 | 
|---|
| Fields | |
|---|---|
| 
    public
    static
    final
    Creator<SubscribeConfig> | 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()
      Check if enable instant mode on 5G for this subscribe session | 
| 
        
        
        
        
        
        AwarePairingConfig | 
      getPairingConfig()
      Get the Aware Pairing config for this subscribe session | 
| 
        
        
        
        
        
        int | 
      hashCode()
      Returns a hash code value for the object. | 
| 
        
        
        
        
        
        boolean | 
      isInstantCommunicationModeEnabled()
      Check if instant mode is enabled for this subscribe 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
SUBSCRIBE_TYPE_ACTIVE
public static final int SUBSCRIBE_TYPE_ACTIVE
Defines an active subscribe session - a subscribe session where
 subscribe packets are transmitted over-the-air. Configuration is done
 using SubscribeConfig.Builder.setSubscribeType(int).
Constant Value: 1 (0x00000001)
SUBSCRIBE_TYPE_PASSIVE
public static final int SUBSCRIBE_TYPE_PASSIVE
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).
Constant Value: 0 (0x00000000)
Fields
Public methods
describeContents
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 0orCONTENTS_FILE_DESCRIPTOR | 
equals
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 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 | |
|---|---|
| o | Object: the reference object with which to compare. | 
| Returns | |
|---|---|
| boolean | trueif this object is the same as the obj
          argument;falseotherwise. | 
getInstantCommunicationBand
public int getInstantCommunicationBand ()
Check if enable instant mode on 5G for this subscribe session
| Returns | |
|---|---|
| int | If instant communication mode is not enabled will return ScanResult.WIFI_BAND_24_GHZas default.
 Value isScanResult.WIFI_BAND_24_GHZ, orScanResult.WIFI_BAND_5_GHZ | 
getPairingConfig
public AwarePairingConfig getPairingConfig ()
Get the Aware Pairing config for this subscribe session
| Returns | |
|---|---|
| AwarePairingConfig | A AwarePairingConfigspecified in this config.
 This value may benull. | 
hashCode
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 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.
| Returns | |
|---|---|
| int | a hash code value for this object. | 
isInstantCommunicationModeEnabled
public boolean isInstantCommunicationModeEnabled ()
Check if instant mode is enabled for this subscribe session.
| Returns | |
|---|---|
| boolean | true for enabled, false otherwise. | 
toString
public String toString ()
Returns a string representation of the object.
| Returns | |
|---|---|
| String | a string representation of the object. | 
writeToParcel
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 benull. | 
| flags | int: Additional flags about how the object should be written.
 May be 0 orParcelable.PARCELABLE_WRITE_RETURN_VALUE.
 Value is either0or a combination ofParcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES | 
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
