Added in API level 33

Summary: Nested Classes | Constants | Inherited Constants | Fields | Methods | Inherited Methods

PreferentialNetworkServiceConfig

---

Kotlin |Java

public final class PreferentialNetworkServiceConfig
extends Object implements Parcelable

java.lang.Object
↳	android.app.admin.PreferentialNetworkServiceConfig

---

Network configuration to be set for the user profile .

See also:

• DevicePolicyManager.setPreferentialNetworkServiceConfigs(List)

Summary

Nested classes
class	PreferentialNetworkServiceConfig.Builder Builder used to create PreferentialNetworkServiceConfig objects.

Constants
int	PREFERENTIAL_NETWORK_ID_1 Preferential network identifier 1.
int	PREFERENTIAL_NETWORK_ID_2 Preferential network identifier 2.
int	PREFERENTIAL_NETWORK_ID_3 Preferential network identifier 3.
int	PREFERENTIAL_NETWORK_ID_4 Preferential network identifier 4.
int	PREFERENTIAL_NETWORK_ID_5 Preferential network identifier 5.

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<PreferentialNetworkServiceConfig>	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[]	getExcludedUids() Get the array of uids that are excluded for the profile preference.
int[]	getIncludedUids() Get the array of uids that are applicable for the profile preference.
int	getNetworkId()
int	hashCode() Returns a hash code value for the object.
boolean	isEnabled() Is the preferential network enabled.
boolean	isFallbackToDefaultConnectionAllowed() Whether fallback to the device-wide default network is allowed.
boolean	shouldBlockNonMatchingNetworks() Whether to block UIDs from using other networks than the preferential service.
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 timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
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

PREFERENTIAL_NETWORK_ID_1

Added in API level 33

public static final int PREFERENTIAL_NETWORK_ID_1

Preferential network identifier 1.

Constant Value: 1 (0x00000001)

PREFERENTIAL_NETWORK_ID_2

Added in API level 33

public static final int PREFERENTIAL_NETWORK_ID_2

Preferential network identifier 2.

Constant Value: 2 (0x00000002)

PREFERENTIAL_NETWORK_ID_3

Added in API level 33

public static final int PREFERENTIAL_NETWORK_ID_3

Preferential network identifier 3.

Constant Value: 3 (0x00000003)

PREFERENTIAL_NETWORK_ID_4

Added in API level 33

public static final int PREFERENTIAL_NETWORK_ID_4

Preferential network identifier 4.

Constant Value: 4 (0x00000004)

PREFERENTIAL_NETWORK_ID_5

Added in API level 33

public static final int PREFERENTIAL_NETWORK_ID_5

Preferential network identifier 5.

Constant Value: 5 (0x00000005)

Fields

CREATOR

Added in API level 33

public static final Creator<PreferentialNetworkServiceConfig> CREATOR

Public methods

describeContents

Added in API level 33

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

Added in API level 33

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 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
o	Object: the reference object with which to compare.

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

getExcludedUids

Added in API level 33

public int[] getExcludedUids ()

Get the array of uids that are excluded for the profile preference. 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.

Returns
int[]	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.

See also:

• getIncludedUids()

getIncludedUids

Added in API level 33

public int[] getIncludedUids ()

Get the array of uids that are applicable for the profile preference. 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.

Returns
int[]	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.

See also:

• getExcludedUids()

getNetworkId

Added in API level 33

public int getNetworkId ()

Returns
int	preference enterprise identifier. preference identifier is applicable only if preference network service is enabled Value is PREFERENTIAL_NETWORK_ID_1, PREFERENTIAL_NETWORK_ID_2, PREFERENTIAL_NETWORK_ID_3, PREFERENTIAL_NETWORK_ID_4, or PREFERENTIAL_NETWORK_ID_5

hashCode

Added in API level 33

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

Returns
int	a hash code value for this object.

isEnabled

Added in API level 33

public boolean isEnabled ()

Is the preferential network enabled.

Returns
boolean	true if enabled else false

isFallbackToDefaultConnectionAllowed

Added in API level 33

public boolean isFallbackToDefaultConnectionAllowed ()

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.

Returns
boolean	true if fallback is allowed, else false.

shouldBlockNonMatchingNetworks

Added in API level 34

public boolean shouldBlockNonMatchingNetworks ()

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.

Returns
boolean	true if UIDs should be blocked from using the other networks, else false.

toString

Added in API level 33

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in API level 33

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