VcnWifiUnderlyingNetworkTemplate

Kotlin |Java

class VcnWifiUnderlyingNetworkTemplate : VcnUnderlyingNetworkTemplate

kotlin.Any
↳	android.net.vcn.VcnUnderlyingNetworkTemplate
	↳	android.net.vcn.VcnWifiUnderlyingNetworkTemplate

This class represents a configuration for a network template class of underlying Carrier WiFi networks.

See VcnUnderlyingNetworkTemplate

Summary

Nested classes
	`Builder` This class is used to incrementally build VcnWifiUnderlyingNetworkTemplate objects.

Inherited constants

From class VcnUnderlyingNetworkTemplate

Int

MATCH_ANY

Used to configure the matching criteria of a network characteristic. This may include network capabilities, or cellular subscription information. Denotes that networks with or without the characteristic are both acceptable to match this template.

Int

MATCH_FORBIDDEN

Used to configure the matching criteria of a network characteristic. This may include network capabilities, or cellular subscription information. Denotes that a network MUST NOT have the capability in order to match this template.

Int

MATCH_REQUIRED

Used to configure the matching criteria of a network characteristic. This may include network capabilities, or cellular subscription information. Denotes that a network MUST have the capability in order to match this template.

Public methods
Boolean	`equals(other: Any?)` Indicates whether some other object is "equal to" this one.
MutableSet<String!>	`getSsids()` Retrieve the matching SSIDs, or an empty set if any SSID is acceptable.
Int	`hashCode()`

Inherited functions

From class VcnUnderlyingNetworkTemplate

`Int`	`getMetered()` Return the matching criteria for metered networks.
`Int`	`getMinEntryDownstreamBandwidthKbps()` Returns the minimum entry downstream bandwidth allowed by this template.
`Int`	`getMinEntryUpstreamBandwidthKbps()` Returns the minimum entry upstream bandwidth allowed by this template.
`Int`	`getMinExitDownstreamBandwidthKbps()` Returns the minimum exit downstream bandwidth allowed by this template.
`Int`	`getMinExitUpstreamBandwidthKbps()` Returns the minimum exit upstream bandwidth allowed by this template.

Public methods

equals

Added in API level 33

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

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.
`other`	Any?: This value may be `null`.

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

getSsids

Added in API level 33

fun getSsids(): MutableSet<String!>

Retrieve the matching SSIDs, or an empty set if any SSID is acceptable.

Return
`MutableSet<String!>`	This value cannot be `null`.

See Also

android.net.vcn.VcnWifiUnderlyingNetworkTemplate.Builder#setSsids(Set)

hashCode

Added in API level 33

fun hashCode(): Int

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