ScanResult (Android Bluetooth LE Scanner Compat library)

java.lang.Object
- no.nordicsemi.android.support.v18.scanner.ScanResult

All Implemented Interfaces:: android.os.Parcelable

public final class ScanResult
extends Object
implements android.os.Parcelable

ScanResult for Bluetooth LE scan.

Nested Class Summary
- Nested classes/interfaces inherited from interface android.os.Parcelable
  android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields
Modifier and Type	Field and Description
`static android.os.Parcelable.Creator<ScanResult>`	`CREATOR`
`static int`	`DATA_COMPLETE` For chained advertisements, indicates that the data contained in this scan result is complete.
`static int`	`DATA_TRUNCATED` For chained advertisements, indicates that the controller was unable to receive all chained packets and the scan result contains incomplete truncated data.
`static int`	`PERIODIC_INTERVAL_NOT_PRESENT` Periodic advertising interval is not present in the packet.
`static int`	`PHY_UNUSED` Indicates that the secondary physical layer was not used.
`static int`	`SID_NOT_PRESENT` Advertising Set ID is not present in the packet.
`static int`	`TX_POWER_NOT_PRESENT` TX power is not present in the packet.

Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors
Constructor and Description
`ScanResult(android.bluetooth.BluetoothDevice device, int eventType, int primaryPhy, int secondaryPhy, int advertisingSid, int txPower, int rssi, int periodicAdvertisingInterval, ScanRecord scanRecord, long timestampNanos)` Constructs a new ScanResult.
`ScanResult(android.bluetooth.BluetoothDevice device, ScanRecord scanRecord, int rssi, long timestampNanos)` Deprecated. use `ScanResult(BluetoothDevice, int, int, int, int, int, int, int, ScanRecord, long)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`describeContents()`
`boolean`	`equals(Object obj)`
`int`	`getAdvertisingSid()` Returns the advertising set id.
`int`	`getDataStatus()` Returns the data status.
`android.bluetooth.BluetoothDevice`	`getDevice()` Returns the remote Bluetooth device identified by the Bluetooth device address.
`int`	`getPeriodicAdvertisingInterval()` Returns the periodic advertising interval in units of 1.25ms.
`int`	`getPrimaryPhy()` Returns the primary Physical Layer on which this advertisement was received.
`int`	`getRssi()` Returns the received signal strength in dBm.
`ScanRecord`	`getScanRecord()` Returns the scan record, which is a combination of advertisement and scan response.
`int`	`getSecondaryPhy()` Returns the secondary Physical Layer on which this advertisement was received.
`long`	`getTimestampNanos()` Returns timestamp since boot when the scan record was observed.
`int`	`getTxPower()` Returns the transmit power in dBm.
`int`	`hashCode()`
`boolean`	`isConnectable()` Returns true if this object represents connectable scan result.
`boolean`	`isLegacy()` Returns true if this object represents legacy scan result.
`String`	`toString()`
`void`	`writeToParcel(android.os.Parcel dest, int flags)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DATA_COMPLETE
```
public static final int DATA_COMPLETE
```
    For chained advertisements, indicates that the data contained in this scan result is complete.
    
    See Also:
    
    Constant Field Values
  - DATA_TRUNCATED
```
public static final int DATA_TRUNCATED
```
    For chained advertisements, indicates that the controller was unable to receive all chained packets and the scan result contains incomplete truncated data.
    
    See Also:
    
    Constant Field Values
  - PHY_UNUSED
```
public static final int PHY_UNUSED
```
    Indicates that the secondary physical layer was not used.
    
    See Also:
    
    Constant Field Values
  - SID_NOT_PRESENT
```
public static final int SID_NOT_PRESENT
```
    Advertising Set ID is not present in the packet.
    
    See Also:
    
    Constant Field Values
  - TX_POWER_NOT_PRESENT
```
public static final int TX_POWER_NOT_PRESENT
```
    TX power is not present in the packet.
    
    See Also:
    
    Constant Field Values
  - PERIODIC_INTERVAL_NOT_PRESENT
```
public static final int PERIODIC_INTERVAL_NOT_PRESENT
```
    Periodic advertising interval is not present in the packet.
    
    See Also:
    
    Constant Field Values
  - CREATOR
```
public static final android.os.Parcelable.Creator<ScanResult> CREATOR
```
- Constructor Detail
  - ScanResult
```
public ScanResult(android.bluetooth.BluetoothDevice device,
                  ScanRecord scanRecord,
                  int rssi,
                  long timestampNanos)
```
    Deprecated. use ScanResult(BluetoothDevice, int, int, int, int, int, int, int, ScanRecord, long)
    
    Constructs a new ScanResult.
    
    Parameters:
    
    device - Remote Bluetooth device found.
    
    scanRecord - Scan record including both advertising data and scan response data.
    
    rssi - Received signal strength.
    
    timestampNanos - Timestamp at which the scan result was observed.
  - ScanResult
```
public ScanResult(android.bluetooth.BluetoothDevice device,
                  int eventType,
                  int primaryPhy,
                  int secondaryPhy,
                  int advertisingSid,
                  int txPower,
                  int rssi,
                  int periodicAdvertisingInterval,
                  ScanRecord scanRecord,
                  long timestampNanos)
```
    Constructs a new ScanResult.
    
    Parameters:
    
    device - Remote Bluetooth device found.
    
    eventType - Event type.
    
    primaryPhy - Primary advertising phy.
    
    secondaryPhy - Secondary advertising phy.
    
    advertisingSid - Advertising set ID.
    
    txPower - Transmit power.
    
    rssi - Received signal strength.
    
    periodicAdvertisingInterval - Periodic advertising interval.
    
    scanRecord - Scan record including both advertising data and scan response data.
    
    timestampNanos - Timestamp at which the scan result was observed.
- Method Detail
  - writeToParcel
```
public void writeToParcel(android.os.Parcel dest,
                          int flags)
```
    Specified by:
    
    writeToParcel in interface android.os.Parcelable
  - describeContents
```
public int describeContents()
```
    Specified by:
    
    describeContents in interface android.os.Parcelable
  - getDevice
```
public android.bluetooth.BluetoothDevice getDevice()
```
    Returns the remote Bluetooth device identified by the Bluetooth device address.
  - getScanRecord
```
public ScanRecord getScanRecord()
```
    Returns the scan record, which is a combination of advertisement and scan response.
  - getRssi
```
public int getRssi()
```
    Returns the received signal strength in dBm. The valid range is [-127, 126].
  - getTimestampNanos
```
public long getTimestampNanos()
```
    Returns timestamp since boot when the scan record was observed.
  - isLegacy
```
public boolean isLegacy()
```
    Returns true if this object represents legacy scan result. Legacy scan results do not contain advanced advertising information as specified in the Bluetooth Core Specification v5.
  - isConnectable
```
public boolean isConnectable()
```
    Returns true if this object represents connectable scan result.
  - getDataStatus
```
public int getDataStatus()
```
    Returns the data status. Can be one of DATA_COMPLETE or DATA_TRUNCATED.
  - getPrimaryPhy
```
public int getPrimaryPhy()
```
    Returns the primary Physical Layer on which this advertisement was received. Can be one of BluetoothDevice.PHY_LE_1M or BluetoothDevice.PHY_LE_CODED.
  - getSecondaryPhy
```
public int getSecondaryPhy()
```
    Returns the secondary Physical Layer on which this advertisement was received. Can be one of BluetoothDevice.PHY_LE_1M, BluetoothDevice.PHY_LE_2M, BluetoothDevice.PHY_LE_CODED or PHY_UNUSED - if the advertisement was not received on a secondary physical channel.
  - getAdvertisingSid
```
public int getAdvertisingSid()
```
    Returns the advertising set id. May return SID_NOT_PRESENT if no set id was is present.
  - getTxPower
```
public int getTxPower()
```
    Returns the transmit power in dBm. Valid range is [-127, 126]. A value of TX_POWER_NOT_PRESENT indicates that the TX power is not present.
  - getPeriodicAdvertisingInterval
```
public int getPeriodicAdvertisingInterval()
```
    Returns the periodic advertising interval in units of 1.25ms. Valid range is 6 (7.5ms) to 65536 (81918.75ms). A value of PERIODIC_INTERVAL_NOT_PRESENT means periodic advertising interval is not present.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ScanResult

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Field Summary

Fields inherited from interface android.os.Parcelable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DATA_COMPLETE

DATA_TRUNCATED

PHY_UNUSED

SID_NOT_PRESENT

TX_POWER_NOT_PRESENT

PERIODIC_INTERVAL_NOT_PRESENT

CREATOR

Constructor Detail

ScanResult

ScanResult

Method Detail

writeToParcel

describeContents

getDevice

getScanRecord

getRssi

getTimestampNanos

isLegacy

isConnectable

getDataStatus

getPrimaryPhy

getSecondaryPhy

getAdvertisingSid

getTxPower

getPeriodicAdvertisingInterval

hashCode

equals

toString