SoftApConfiguration Class

Definition

Namespace:: Android.Net.Wifi

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Configuration for a soft access point (a.

[Android.Runtime.Register("android/net/wifi/SoftApConfiguration", ApiSince=30, DoNotGenerateAcw=true)]
public sealed class SoftApConfiguration : Java.Lang.Object, Android.OS.IParcelable, IDisposable

[<Android.Runtime.Register("android/net/wifi/SoftApConfiguration", ApiSince=30, DoNotGenerateAcw=true)>]
type SoftApConfiguration = class
    inherit Object
    interface IParcelable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable

Inheritance: Object

JavaObject

Object
SoftApConfiguration

Attributes: RegisterAttribute

Implements: IParcelable IJavaObject IJavaPeerable IDisposable

Remarks

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 or local-only hotspot.

Instances of this class are immutable.

Java documentation for android.net.wifi.SoftApConfiguration.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Fields

Name	Description
Band2ghz	Obsolete. 2GHz band.
Band5ghz	Obsolete. 5GHz band.
Band60ghz	Obsolete. 60GHz band.
Band6ghz	Obsolete. 6GHz band.
SecurityTypeOpen	Obsolete. THe definition of security type OPEN.
SecurityTypeWpa2Psk	Obsolete. The definition of security type WPA2-PSK.
SecurityTypeWpa3Owe	Obsolete. The definition of security type WPA3-OWE.
SecurityTypeWpa3OweTransition	Obsolete. The definition of security type WPA3-OWE Transition.
SecurityTypeWpa3Sae	Obsolete. The definition of security type WPA3-SAE.
SecurityTypeWpa3SaeTransition	Obsolete. The definition of security type WPA3-SAE Transition mode.

Properties

Name	Description
Bssid	Returns MAC address set to be BSSID for the AP.
Channels	Returns SparseIntArray (key: `BandType` , value: channel) that consists of the configured bands and channels for the AP(s).
Class	Returns the runtime class of this `Object`. (Inherited from Object)
Creator	A creator that generates instances of android.net.wifi.SoftApConfiguration from a Parcel.
Handle	The handle to the underlying Android instance. (Inherited from Object)
IsHiddenSsid	Returns Boolean set to be indicate hidden (true: doesn't broadcast its SSID) or not (false: broadcasts its SSID) for the AP.
JniIdentityHashCode	Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object)
JniManagedPeerState	Gets the state flags last assigned by the runtime. (Inherited from JavaObject)
JniPeerMembers	Gets the JNI metadata used to access members of this Java binding.
Passphrase	Returns String set to be passphrase for current AP.
PeerReference	Gets the JNI object reference for this Java peer. (Inherited from Object)
SecurityType	Get security type params which depends on which security passphrase to set.
Ssid	Return the UTF-8 String set to be the SSID for the AP.
ThresholdClass	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object)
ThresholdType	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object)
WifiSsid	Return WifiSsid set to be the SSID for the AP.

Methods

Name	Description
Clone()	Creates and returns a copy of this object. (Inherited from Object)
Construct(JniObjectReference, JniObjectReferenceOptions)	Delegates construction of this peer to the runtime's value manager. (Inherited from JavaObject)
DescribeContents()	Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
Dispose()	Releases the resources held by this Java peer. (Inherited from Object)
Dispose(Boolean)	Releases the resources held by this Java peer. (Inherited from Object)
DisposeUnlessReferenced()	Asks the value manager to dispose this peer unless its mapping retains this same managed instance. (Inherited from JavaObject)
Equals(Object)	Tests whether another managed peer refers to the same Java object. (Inherited from JavaObject)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
JavaFinalize()	Obsolete. Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object)
Notify()	Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object)
NotifyAll()	Wakes up all threads that are waiting on this object's monitor. (Inherited from Object)
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
SetPeerReference(JniObjectReference, JniObjectReferenceOptions)	Stores a reference value in the control block without creating a JNI reference copy. (Inherited from JavaObject)
ToArray<T>()	Creates a managed array from this Java array wrapper. (Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	Unregisters this Java peer from the interop runtime. (Inherited from Object)
Wait()	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object)
Wait(Int64, Int32)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
Wait(Int64)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
WriteToParcel(Parcel, ParcelableWriteFlags)	Flatten this object in to a Parcel.

Explicit Interface Implementations

Name	Description
IJavaPeerable.Disposed()	Marks this peer as disposed and calls `Dispose` with `disposing` set to `true`. (Inherited from JavaObject)
IJavaPeerable.Finalized()	Marks this peer as disposed and calls `Dispose` with `disposing` set to `false`. (Inherited from JavaObject)
IJavaPeerable.JniObjectReferenceControlBlock	Gets the native control-block pointer used by this peer. (Inherited from JavaObject)
IJavaPeerable.SetJniIdentityHashCode(Int32)	Stores the identity hash code supplied by the runtime. (Inherited from JavaObject)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	Replaces the stored managed peer state flags. (Inherited from JavaObject)
IJavaPeerable.SetPeerReference(JniObjectReference)	Updates the peer reference and releases a disposed peer's control block when the reference is invalid. (Inherited from JavaObject)
IJavaPeerable.UnregisterFromRuntime()	Removes this instance from the runtime's Java object lookup.

Extension Methods

Name	Description
GetJniTypeName(IJavaPeerable)	Gets the JNI name of the type of the instance `self`.
JavaAs<TResult>(IJavaPeerable)	Try to coerce `self` to type `TResult`, checking that the coercion is valid on the Java side.
JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)	Reuses a compatible managed peer or obtains a wrapper of the requested type.
TryJavaCast<TResult>(IJavaPeerable, TResult)	Try to coerce `self` to type `TResult`, checking that the coercion is valid on the Java side.

Applies to