PreferentialNetworkServiceConfig
class PreferentialNetworkServiceConfig : Parcelable
| kotlin.Any | |
| ↳ | android.app.admin.PreferentialNetworkServiceConfig |
Network configuration to be set for the user profile.
Summary
| Nested classes | |
|---|---|
|
Builder used to create |
|
| 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 |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| 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 |
hashCode()Returns a hash code value for the object. |
| 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 |
toString()Returns a string representation of the object. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<PreferentialNetworkServiceConfig!> | |
Constants
PREFERENTIAL_NETWORK_ID_1
static val PREFERENTIAL_NETWORK_ID_1: Int
Preferential network identifier 1.
Value: 1PREFERENTIAL_NETWORK_ID_2
static val PREFERENTIAL_NETWORK_ID_2: Int
Preferential network identifier 2.
Value: 2PREFERENTIAL_NETWORK_ID_3
static val PREFERENTIAL_NETWORK_ID_3: Int
Preferential network identifier 3.
Value: 3PREFERENTIAL_NETWORK_ID_4
static val PREFERENTIAL_NETWORK_ID_4: Int
Preferential network identifier 4.
Value: 4PREFERENTIAL_NETWORK_ID_5
static val PREFERENTIAL_NETWORK_ID_5: Int
Preferential network identifier 5.
Value: 5Public methods
describeContents
fun describeContents(): Int
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.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
equals
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getExcludedUids
fun getExcludedUids(): IntArray
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.
| 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. |
See Also
getIncludedUids
fun getIncludedUids(): IntArray
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.
| 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. |
See Also
getNetworkId
fun getNetworkId(): Int
| Return | |
|---|---|
Int |
preference enterprise identifier. preference identifier is applicable only if preference network service is enabled. Value is one of the following: |
hashCode
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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.
| Return | |
|---|---|
Int |
a hash code value for this object. |
isEnabled
fun isEnabled(): Boolean
Is the preferential network enabled.
| Return | |
|---|---|
Boolean |
true if enabled else false |
isFallbackToDefaultConnectionAllowed
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
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
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
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 the following:
|
Properties
CREATOR
static val CREATOR: Parcelable.Creator<PreferentialNetworkServiceConfig!>