Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Constants](https://developer.android.com/reference/android/telephony/NetworkScanRequest#constants) \| [Inherited Constants](https://developer.android.com/reference/android/telephony/NetworkScanRequest#inhconstants) \| [Fields](https://developer.android.com/reference/android/telephony/NetworkScanRequest#lfields) \| [Ctors](https://developer.android.com/reference/android/telephony/NetworkScanRequest#pubctors) \| [Methods](https://developer.android.com/reference/android/telephony/NetworkScanRequest#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/telephony/NetworkScanRequest#inhmethods)

# NetworkScanRequest

*** ** * ** ***

` public final class NetworkScanRequest `   
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/android/os/Parcelable `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.telephony.NetworkScanRequest |

<br />

*** ** * ** ***

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 ||
|---|---|
| `int` | `https://developer.android.com/reference/android/telephony/NetworkScanRequest#SCAN_TYPE_ONE_SHOT` Performs the scan only once |
| `int` | `https://developer.android.com/reference/android/telephony/NetworkScanRequest#SCAN_TYPE_PERIODIC` 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

From interface `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`

Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`

Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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 https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/telephony/NetworkScanRequest>` | `https://developer.android.com/reference/android/telephony/NetworkScanRequest#CREATOR` <br /> |

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/telephony/NetworkScanRequest#NetworkScanRequest(int,%20android.telephony.RadioAccessSpecifier[],%20int,%20int,%20boolean,%20int,%20java.util.ArrayList<java.lang.String>)(int scanType, https://developer.android.com/reference/android/telephony/RadioAccessSpecifier specifiers, int searchPeriodicity, int maxSearchTime, boolean incrementalResults, int incrementalResultsPeriodicity, https://developer.android.com/reference/java/util/ArrayList<https://developer.android.com/reference/java/lang/String> mccMncs) ` Creates a new NetworkScanRequest with mScanType and network mSpecifiers |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/telephony/NetworkScanRequest#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` boolean` | ` https://developer.android.com/reference/android/telephony/NetworkScanRequest#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object other) ` Indicates whether some other object is "equal to" this one. |
| ` boolean` | ` https://developer.android.com/reference/android/telephony/NetworkScanRequest#getIncrementalResults()() ` Returns whether incremental result is enabled. |
| ` int` | ` https://developer.android.com/reference/android/telephony/NetworkScanRequest#getIncrementalResultsPeriodicity()() ` Returns the periodicity in seconds of incremental results. |
| ` int` | ` https://developer.android.com/reference/android/telephony/NetworkScanRequest#getMaxSearchTime()() ` Returns maximum duration of the periodic search in seconds. |
| ` https://developer.android.com/reference/java/util/ArrayList<https://developer.android.com/reference/java/lang/String>` | ` https://developer.android.com/reference/android/telephony/NetworkScanRequest#getPlmns()() ` Returns the List of PLMN ids (MCC-MNC) for early termination of scan. |
| ` int` | ` https://developer.android.com/reference/android/telephony/NetworkScanRequest#getScanType()() ` Returns the type of the scan. |
| ` int` | ` https://developer.android.com/reference/android/telephony/NetworkScanRequest#getSearchPeriodicity()() ` Returns the search periodicity in seconds. |
| ` https://developer.android.com/reference/android/telephony/RadioAccessSpecifier` | ` https://developer.android.com/reference/android/telephony/NetworkScanRequest#getSpecifiers()() ` Returns the radio access technologies with bands or channels that need to be scanned. |
| ` int` | ` https://developer.android.com/reference/android/telephony/NetworkScanRequest#hashCode()() ` Returns a hash code value for the object. |
| ` void` | ` https://developer.android.com/reference/android/telephony/NetworkScanRequest#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/android/os/Parcelable ` ` abstract int` ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() `

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
` abstract void` ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) `

Flatten this object in to a Parcel.

## Constants

### SCAN_TYPE_ONE_SHOT

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int SCAN_TYPE_ONE_SHOT
```

Performs the scan only once

<br />

Constant Value: 0 (0x00000000)

### SCAN_TYPE_PERIODIC

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int SCAN_TYPE_PERIODIC
```

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

<br />

Constant Value: 1 (0x00000001)

## Fields

### CREATOR

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<NetworkScanRequest> CREATOR
```

<br />

<br />

## Public constructors

### NetworkScanRequest

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public NetworkScanRequest (int scanType, 
                RadioAccessSpecifier[] specifiers, 
                int searchPeriodicity, 
                int maxSearchTime, 
                boolean incrementalResults, 
                int incrementalResultsPeriodicity, 
                ArrayList<String> mccMncs)
```

Creates a new NetworkScanRequest with mScanType and network mSpecifiers

<br />

| Parameters ||
|---|---|
| `scanType` | `int`: The type of the scan, can be either one shot or periodic <br /> |
| `specifiers` | `RadioAccessSpecifier`: the radio network with bands / channels to be scanned <br /> |
| `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. <br /> |
| `maxSearchTime` | `int`: Maximum duration of the search (in seconds) <br /> |
| `incrementalResults` | `boolean`: Indicates whether the modem should report incremental results of the network scan to the client <br /> |
| `incrementalResultsPeriodicity` | `int`: Indicates the periodicity with which the modem should report incremental results to the client (in seconds), only valid when incrementalResults is true <br /> |
| `mccMncs` | `ArrayList`: 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. <br /> |

## Public methods

### describeContents

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`, the return value of this method must include the `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### equals

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean equals (Object other)
```

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.

<br />

| Parameters ||
|---|---|
| `other` | `Object`: the reference object with which to compare. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### getIncrementalResults

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean getIncrementalResults ()
```

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

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

### getIncrementalResultsPeriodicity

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getIncrementalResultsPeriodicity ()
```

Returns the periodicity in seconds of incremental results.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### getMaxSearchTime

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getMaxSearchTime ()
```

Returns maximum duration of the periodic search in seconds.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### getPlmns

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public ArrayList<String> getPlmns ()
```

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.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/ArrayList<https://developer.android.com/reference/java/lang/String>` | <br /> |

### getScanType

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getScanType ()
```

Returns the type of the scan.

<br />

| Returns ||
|---|---|
| `int` | Value is one of the following: - `https://developer.android.com/reference/android/telephony/NetworkScanRequest#SCAN_TYPE_ONE_SHOT` - `https://developer.android.com/reference/android/telephony/NetworkScanRequest#SCAN_TYPE_PERIODIC` |

### getSearchPeriodicity

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getSearchPeriodicity ()
```

Returns the search periodicity in seconds.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### getSpecifiers

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public RadioAccessSpecifier[] getSpecifiers ()
```

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

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/telephony/RadioAccessSpecifier` | <br /> |

### hashCode

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/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 `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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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.

<br />

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |

### writeToParcel

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: The Parcel in which the object should be written. This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |