Most visited

Recently visited

Results for

Summary: Constants | Inherited Constants | Fields | Methods | Inherited Methods

SoftApConfiguration

public final class SoftApConfiguration
extends Object implements Parcelable

java.lang.Object
↳	android.net.wifi.SoftApConfiguration

Configuration for a soft access point (a.k.a. Soft AP, SAP, Hotspot). This is input for the framework provided by a client app, i.e. it exposes knobs to instruct the framework how it should configure a hotspot. System apps can use this to configure a tethered hotspot using WifiManager#startTetheredHotspot(SoftApConfiguration) and WifiManager#setSoftApConfiguration(SoftApConfiguration) or local-only hotspot using WifiManager#startLocalOnlyHotspot(SoftApConfiguration, Executor, WifiManager.LocalOnlyHotspotCallback). Instances of this class are immutable; use SoftApConfiguration.Builder and its methods to create a new instance.

Summary

Constants
`int`	`SECURITY_TYPE_OPEN` THe definition of security type OPEN.
`int`	`SECURITY_TYPE_WPA2_PSK` The definition of security type WPA2-PSK.
`int`	`SECURITY_TYPE_WPA3_SAE` The definition of security type WPA3-SAE.
`int`	`SECURITY_TYPE_WPA3_SAE_TRANSITION` The definition of security type WPA3-SAE Transition mode.

Inherited constants

From interface android.os.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(Parcel, int)`: 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)`".

Fields
`public static final Creator<SoftApConfiguration>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`boolean`	`equals(Object otherObj)` Indicates whether some other object is "equal to" this one.
`MacAddress`	`getBssid()` Returns MAC address set to be BSSID for the AP.
`String`	`getPassphrase()` Returns String set to be passphrase for current AP.
`int`	`getSecurityType()` Get security type params which depends on which security passphrase to set.
`String`	`getSsid()` Return String set to be the SSID for the AP.
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`isHiddenSsid()` Returns Boolean set to be indicate hidden (true: doesn't broadcast its SSID) or not (false: broadcasts its SSID) for the AP.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

SECURITY_TYPE_OPEN

public static final int SECURITY_TYPE_OPEN

THe definition of security type OPEN.

Constant Value: 0 (0x00000000)

SECURITY_TYPE_WPA2_PSK

public static final int SECURITY_TYPE_WPA2_PSK

The definition of security type WPA2-PSK.

Constant Value: 1 (0x00000001)

SECURITY_TYPE_WPA3_SAE

public static final int SECURITY_TYPE_WPA3_SAE

The definition of security type WPA3-SAE.

Constant Value: 3 (0x00000003)

SECURITY_TYPE_WPA3_SAE_TRANSITION

public static final int SECURITY_TYPE_WPA3_SAE_TRANSITION

The definition of security type WPA3-SAE Transition mode.

Constant Value: 2 (0x00000002)

Fields

CREATOR

public static final Creator<SoftApConfiguration> CREATOR

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 `0` or `CONTENTS_FILE_DESCRIPTOR`

equals

public boolean equals (Object otherObj)

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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
`otherObj`	`Object`: the reference object with which to compare.

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

getBssid

public MacAddress getBssid ()

Returns MAC address set to be BSSID for the AP. Builder#setBssid(MacAddress).

Returns
`MacAddress`	This value may be `null`.

getPassphrase

public String getPassphrase ()

Returns String set to be passphrase for current AP. Builder#setPassphrase(String, int).

Returns
`String`	This value may be `null`.

getSecurityType

public int getSecurityType ()

Get security type params which depends on which security passphrase to set.

Returns
`int`	One of: `SECURITY_TYPE_OPEN`, `SECURITY_TYPE_WPA2_PSK`, `SECURITY_TYPE_WPA3_SAE_TRANSITION`, `SECURITY_TYPE_WPA3_SAE` Value is `SECURITY_TYPE_OPEN`, `SECURITY_TYPE_WPA2_PSK`, `SECURITY_TYPE_WPA3_SAE_TRANSITION`, or `SECURITY_TYPE_WPA3_SAE`

getSsid

public String getSsid ()

Return String set to be the SSID for the AP. Builder#setSsid(String).

Returns
`String`	This value may be `null`.

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 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(Object) 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(java.lang.Object) 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.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
`int`	a hash code value for this object.

isHiddenSsid

public boolean isHiddenSsid ()

Returns Boolean set to be indicate hidden (true: doesn't broadcast its SSID) or not (false: broadcasts its SSID) for the AP. Builder#setHiddenSsid(boolean).

Returns
`boolean`

toString

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())

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`: 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

Interfaces

Classes

Enums

Most visited

Recently visited

Results for

SoftApConfiguration

Summary

Constants

Inherited constants

Fields

Public methods

Inherited methods

Constants

SECURITY_TYPE_OPEN

SECURITY_TYPE_WPA2_PSK

SECURITY_TYPE_WPA3_SAE

SECURITY_TYPE_WPA3_SAE_TRANSITION

Fields

CREATOR

Public methods

describeContents

equals

getBssid

getPassphrase

getSecurityType

getSsid

hashCode

isHiddenSsid

toString

writeToParcel