Added in API level 33

PreferentialNetworkServiceConfig

class PreferentialNetworkServiceConfig : Parcelable
kotlin.Any
   ↳ android.app.admin.PreferentialNetworkServiceConfig

Network configuration to be set for the user profile {@see DevicePolicyManager#setPreferentialNetworkServiceConfigs}.

Summary

Nested classes

Builder used to create PreferentialNetworkServiceConfig objects.
Constants
static Int

Preferential network identifier 1.
static Int

Preferential network identifier 2.
static Int

Preferential network identifier 3.
static Int

Preferential network identifier 4.
static Int

Preferential network identifier 5.
Inherited constants
Public methods
Int

Boolean
equals(other: Any?)
IntArray

Get the array of uids that are excluded for the profile preference.
IntArray

Get the array of uids that are applicable for the profile preference.
Int

Int

Boolean

Is the preferential network enabled.
Boolean

Whether fallback to the device-wide default network is allowed.
Boolean

Whether to block UIDs from using other networks than the preferential service.
String

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.
Properties
static Parcelable.Creator<PreferentialNetworkServiceConfig!>

Constants

PREFERENTIAL_NETWORK_ID_1

Added in API level 33
static val PREFERENTIAL_NETWORK_ID_1: Int

Preferential network identifier 1.

Value: 1

PREFERENTIAL_NETWORK_ID_2

Added in API level 33
static val PREFERENTIAL_NETWORK_ID_2: Int

Preferential network identifier 2.

Value: 2

PREFERENTIAL_NETWORK_ID_3

Added in API level 33
static val PREFERENTIAL_NETWORK_ID_3: Int

Preferential network identifier 3.

Value: 3

PREFERENTIAL_NETWORK_ID_4

Added in API level 33
static val PREFERENTIAL_NETWORK_ID_4: Int

Preferential network identifier 4.

Value: 4

PREFERENTIAL_NETWORK_ID_5

Added in API level 33
static val PREFERENTIAL_NETWORK_ID_5: Int

Preferential network identifier 5.

Value: 5

Public methods

describeContents

Added in API level 33
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 33
fun equals(other: Any?): Boolean
Parameters
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getExcludedUids

Added in API level 33
fun getExcludedUids(): IntArray

Get the array of uids that are excluded for the profile preference. {@see #getIncludedUids()} Included UIDs and Excluded UIDs can't both be non-empty. if both are empty, it means this request applies to all uids in the user profile. if included is not empty, then only included UIDs are applied. if excluded is not empty, then it is all uids in the user profile except these UIDs.

Return
IntArray Array of uids that are excluded for the profile preference. Empty array would mean that this request applies to all uids in the profile. This value cannot be null.

getIncludedUids

Added in API level 33
fun getIncludedUids(): IntArray

Get the array of uids that are applicable for the profile preference. {@see #getExcludedUids()} Included UIDs and Excluded UIDs can't both be non-empty. if both are empty, it means this request applies to all uids in the user profile. if included is not empty, then only included UIDs are applied. if excluded is not empty, then it is all uids in the user profile except these UIDs.

Return
IntArray Array of uids applicable for the profile preference. Empty array would mean that this request applies to all uids in the profile. This value cannot be null.

getNetworkId

Added in API level 33
fun getNetworkId(): Int
Return
Int preference enterprise identifier. preference identifier is applicable only if preference network service is enabled Value is android.app.admin.PreferentialNetworkServiceConfig#PREFERENTIAL_NETWORK_ID_1, android.app.admin.PreferentialNetworkServiceConfig#PREFERENTIAL_NETWORK_ID_2, android.app.admin.PreferentialNetworkServiceConfig#PREFERENTIAL_NETWORK_ID_3, android.app.admin.PreferentialNetworkServiceConfig#PREFERENTIAL_NETWORK_ID_4, or android.app.admin.PreferentialNetworkServiceConfig#PREFERENTIAL_NETWORK_ID_5

hashCode

Added in API level 33
fun hashCode(): Int
Return
Int a hash code value for this object.

isEnabled

Added in API level 33
fun isEnabled(): Boolean

Is the preferential network enabled.

Return
Boolean true if enabled else false

isFallbackToDefaultConnectionAllowed

Added in API level 33
fun isFallbackToDefaultConnectionAllowed(): Boolean

Whether fallback to the device-wide default network is allowed. This boolean configures whether the default connection (e.g. general cell network or wifi) should be used if no preferential network service connection is available. If true, the default connection will be used when no preferential service is available. If false, the UIDs subject to this configuration will have no default network. Note that while this boolean determines whether the UIDs subject to this configuration have a default network in the absence of a preferential service, apps can still explicitly decide to use another network than their default network by requesting them from the system. This boolean does not determine whether the UIDs are blocked from using such other networks. See shouldBlockNonMatchingNetworks() for that configuration.

Return
Boolean true if fallback is allowed, else false.

shouldBlockNonMatchingNetworks

Added in API level 34
fun shouldBlockNonMatchingNetworks(): Boolean

Whether to block UIDs from using other networks than the preferential service. Apps can inspect the list of available networks on the device and choose to use multiple of them concurrently for performance, privacy or other reasons. This boolean configures whether the concerned UIDs should be blocked from using networks that do not match the configured preferential network service even if these networks are otherwise open to all apps.

Return
Boolean true if UIDs should be blocked from using the other networks, else false.

toString

Added in API level 33
fun toString(): String
Return
String a string representation of the object.

writeToParcel

Added in API level 33
fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

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_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 33
static val CREATOR: Parcelable.Creator<PreferentialNetworkServiceConfig!>