Added in API level 28

NetworkScanRequest


class NetworkScanRequest : Parcelable
kotlin.Any
   ↳ android.telephony.NetworkScanRequest

Defines a request to perform a network scan. This class defines whether the network scan will be performed only once or periodically until cancelled, when the scan is performed periodically, the time interval is not controlled by the user but defined by the modem vendor.

Summary

Constants
static Int

Performs the scan only once

static Int

Performs the scan periodically until cancelled The modem will start new scans periodically, and the interval between two scans is usually multiple minutes.

Inherited constants
Public constructors
NetworkScanRequest(scanType: Int, specifiers: Array<RadioAccessSpecifier!>!, searchPeriodicity: Int, maxSearchTime: Int, incrementalResults: Boolean, incrementalResultsPeriodicity: Int, mccMncs: ArrayList<String!>!)

Creates a new NetworkScanRequest with mScanType and network mSpecifiers

Public methods
Int

Boolean
equals(other: Any?)

Boolean

Returns whether incremental result is enabled.

Int

Returns the periodicity in seconds of incremental results.

Int

Returns maximum duration of the periodic search in seconds.

ArrayList<String!>!

Returns the List of PLMN ids (MCC-MNC) for early termination of scan.

Int

Returns the type of the scan.

Int

Returns the search periodicity in seconds.

Array<RadioAccessSpecifier!>!

Returns the radio access technologies with bands or channels that need to be scanned.

Int

Unit
writeToParcel(dest: Parcel, flags: Int)

Properties
static Parcelable.Creator<NetworkScanRequest!>

Constants

SCAN_TYPE_ONE_SHOT

Added in API level 28
static val SCAN_TYPE_ONE_SHOT: Int

Performs the scan only once

Value: 0

SCAN_TYPE_PERIODIC

Added in API level 28
static val SCAN_TYPE_PERIODIC: Int

Performs the scan periodically until cancelled The modem will start new scans periodically, and the interval between two scans is usually multiple minutes.

Value: 1

Public constructors

NetworkScanRequest

Added in API level 28
NetworkScanRequest(
    scanType: Int,
    specifiers: Array<RadioAccessSpecifier!>!,
    searchPeriodicity: Int,
    maxSearchTime: Int,
    incrementalResults: Boolean,
    incrementalResultsPeriodicity: Int,
    mccMncs: ArrayList<String!>!)

Creates a new NetworkScanRequest with mScanType and network mSpecifiers

Parameters
scanType Int: The type of the scan, can be either one shot or periodic
specifiers Array<RadioAccessSpecifier!>!: the radio network with bands / channels to be scanned
searchPeriodicity Int: The modem will restart the scan every searchPeriodicity seconds if no network has been found, until it reaches the maxSearchTime. Only valid when scan type is periodic scan.
maxSearchTime Int: Maximum duration of the search (in seconds)
incrementalResults Boolean: Indicates whether the modem should report incremental results of the network scan to the client
incrementalResultsPeriodicity Int: Indicates the periodicity with which the modem should report incremental results to the client (in seconds), only valid when incrementalResults is true
mccMncs ArrayList<String!>!: Describes the list of PLMN ids (MCC-MNC), once any network in the list has been found, the scan will be terminated by the modem.

Public methods

describeContents

Added in API level 28
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 28
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.

getIncrementalResults

Added in API level 28
fun getIncrementalResults(): Boolean

Returns whether incremental result is enabled. FALSE – Incremental results is not enabled. TRUE – Incremental results is reported.

getIncrementalResultsPeriodicity

Added in API level 28
fun getIncrementalResultsPeriodicity(): Int

Returns the periodicity in seconds of incremental results.

getMaxSearchTime

Added in API level 28
fun getMaxSearchTime(): Int

Returns maximum duration of the periodic search in seconds.

getPlmns

Added in API level 28
fun getPlmns(): ArrayList<String!>!

Returns the List of PLMN ids (MCC-MNC) for early termination of scan. If any PLMN of this list is found, search should end at that point and results with all PLMN found till that point should be sent as response.

getScanType

Added in API level 28
fun getScanType(): Int

Returns the type of the scan.

Return
Int Value is android.telephony.NetworkScanRequest#SCAN_TYPE_ONE_SHOT, or android.telephony.NetworkScanRequest#SCAN_TYPE_PERIODIC

getSearchPeriodicity

Added in API level 28
fun getSearchPeriodicity(): Int

Returns the search periodicity in seconds.

getSpecifiers

Added in API level 28
fun getSpecifiers(): Array<RadioAccessSpecifier!>!

Returns the radio access technologies with bands or channels that need to be scanned.

hashCode

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

writeToParcel

Added in API level 28
fun writeToParcel(
    dest: Parcel,
    flags: Int
): Unit
Parameters
dest Parcel: The Parcel in which the object should be written. 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 28
static val CREATOR: Parcelable.Creator<NetworkScanRequest!>