NetworkSliceInfo
class NetworkSliceInfo : Parcelable
| kotlin.Any | |
| ↳ | android.telephony.data.NetworkSliceInfo |
Represents a S-NSSAI as defined in 3GPP TS 24.501, which represents a network slice. There are 2 main fields that define a slice, SliceServiceType and SliceDifferentiator. SliceServiceType defines the type of service provided by the slice, and SliceDifferentiator is used to differentiate between multiple slices of the same type. If the devices is not on HPLMN, the mappedHplmn versions of these 2 fields indicate the corresponding values in HPLMN.
Summary
| Nested classes | |
|---|---|
|
Provides a convenient way to set the fields of a |
|
| Constants | |
|---|---|
| static Int |
When set on a Slice Differentiator, this value indicates that there is no corresponding Slice. |
| static Int |
Slice suitable for the handling of 5G enhanced Mobile Broadband. |
| static Int |
Slice suitable for the handling of massive IoT. |
| static Int |
Indicates that the service type is not present. |
| static Int |
Slice suitable for the handling of ultra-reliable low latency communications. |
| static Int |
The slice is allowed to be used. |
| static Int |
The slice is configured but not allowed or rejected yet. |
| static Int |
The slice is configured by home operator(HPLMN) in default and is used if configured/allowed slices are not available for the serving PLMN. |
| static Int |
The slice is rejected because not available in PLMN. |
| static Int |
The slice is rejected because not available in registered area. |
| static Int |
The slice status is unknown. |
| 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. |
| Int |
This Slice Differentiator corresponds to a |
| Int |
Corresponds to a Slice Info (S-NSSAI) of the HPLMN. |
| Int |
Identifies the slice from others with the same Slice Service Type. |
| Int |
The type of service provided by the slice. |
| Int |
Field to indicate the current status of the slice. |
| Int |
hashCode()Returns a hash code value for the object. |
| 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<NetworkSliceInfo!> | |
Constants
SLICE_DIFFERENTIATOR_NO_SLICE
static val SLICE_DIFFERENTIATOR_NO_SLICE: Int
When set on a Slice Differentiator, this value indicates that there is no corresponding Slice.
Value: -1SLICE_SERVICE_TYPE_EMBB
static val SLICE_SERVICE_TYPE_EMBB: Int
Slice suitable for the handling of 5G enhanced Mobile Broadband.
Value: 1SLICE_SERVICE_TYPE_MIOT
static val SLICE_SERVICE_TYPE_MIOT: Int
Slice suitable for the handling of massive IoT.
Value: 3SLICE_SERVICE_TYPE_NONE
static val SLICE_SERVICE_TYPE_NONE: Int
Indicates that the service type is not present.
Value: 0SLICE_SERVICE_TYPE_URLLC
static val SLICE_SERVICE_TYPE_URLLC: Int
Slice suitable for the handling of ultra-reliable low latency communications.
Value: 2SLICE_STATUS_ALLOWED
static val SLICE_STATUS_ALLOWED: Int
The slice is allowed to be used.
Value: 2SLICE_STATUS_CONFIGURED
static val SLICE_STATUS_CONFIGURED: Int
The slice is configured but not allowed or rejected yet.
Value: 1SLICE_STATUS_DEFAULT_CONFIGURED
static val SLICE_STATUS_DEFAULT_CONFIGURED: Int
The slice is configured by home operator(HPLMN) in default and is used if configured/allowed slices are not available for the serving PLMN.
Value: 5SLICE_STATUS_REJECTED_NOT_AVAILABLE_IN_PLMN
static val SLICE_STATUS_REJECTED_NOT_AVAILABLE_IN_PLMN: Int
The slice is rejected because not available in PLMN.
Value: 3SLICE_STATUS_REJECTED_NOT_AVAILABLE_IN_REGISTERED_AREA
static val SLICE_STATUS_REJECTED_NOT_AVAILABLE_IN_REGISTERED_AREA: Int
The slice is rejected because not available in registered area.
Value: 4SLICE_STATUS_UNKNOWN
static val SLICE_STATUS_UNKNOWN: Int
The slice status is unknown. This can happen during IWLAN->cellular handover when the NetworkSliceInfo is received over IWLAN.
Value: 0Public 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. |
getMappedHplmnSliceDifferentiator
fun getMappedHplmnSliceDifferentiator(): Int
This Slice Differentiator corresponds to a NetworkSliceInfo (S-NSSAI) of the HPLMN; getSliceDifferentiator() is mapped to this value.
SLICE_DIFFERENTIATOR_NO_SLICE if either of the following are true:
getSliceDifferentiator()returnsSLICE_DIFFERENTIATOR_NO_SLICEgetMappedHplmnSliceServiceType()returnsSLICE_SERVICE_TYPE_NONE
| Return | |
|---|---|
Int |
Value is between #MIN_SLICE_DIFFERENTIATOR and #MAX_SLICE_DIFFERENTIATOR inclusive |
getMappedHplmnSliceServiceType
fun getMappedHplmnSliceServiceType(): Int
Corresponds to a Slice Info (S-NSSAI) of the HPLMN.
see: 3GPP TS 24.501 Section 9.11.2.8.| Return | |
|---|---|
Int |
Value is one of the following: |
getSliceDifferentiator
fun getSliceDifferentiator(): Int
Identifies the slice from others with the same Slice Service Type.
ReturnsSLICE_DIFFERENTIATOR_NO_SLICE if getSliceServiceType returns SLICE_SERVICE_TYPE_NONE.
see: 3GPP TS 24.501 Section 9.11.2.8.
| Return | |
|---|---|
Int |
Value is between #MIN_SLICE_DIFFERENTIATOR and #MAX_SLICE_DIFFERENTIATOR inclusive |
getSliceServiceType
fun getSliceServiceType(): Int
The type of service provided by the slice.
see: 3GPP TS 24.501 Section 9.11.2.8.| Return | |
|---|---|
Int |
Value is one of the following: |
getStatus
fun getStatus(): Int
Field to indicate the current status of the slice.
| Return | |
|---|---|
Int |
the current status for this slice info. 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. |
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:
|