Added in API level 36

Callback

interface Callback
android.ranging.RangingSession.Callback

Callback interface for receiving ranging session events.

Summary

Constants
static Int

Indicates that the session was closed because AutoCloseable.close() or RangingSession.stop() was called.
static Int

Indicates that the session was closed because none of the specified peers were found.
static Int

Indicates that the session was closed at the request of a remote peer.
static Int

Indicates that the local system policy forced the session to close, such as power management policy, airplane mode etc.
static Int

Indicates that the session was closed due to an unknown reason.
static Int

Indicates that the session closed because the provided session parameters were not supported.
Public methods
abstract Unit
onClosed(reason: Int)

Called when the ranging session has closed.
abstract Unit
onOpenFailed(reason: Int)

Called when the ranging session failed to open.
abstract Unit

Called when the ranging session opens successfully.
abstract Unit

Called when ranging data has been received from a peer.
abstract Unit
onStarted(peer: RangingDevice, technology: Int)

Called when ranging has started with a particular peer using a particular technology during an ongoing session.
abstract Unit
onStopped(peer: RangingDevice, technology: Int)

Called when ranging has stopped with a particular peer using a particular technology during an ongoing session.

Constants

REASON_LOCAL_REQUEST

Added in API level 36
static val REASON_LOCAL_REQUEST: Int

Indicates that the session was closed because AutoCloseable.close() or RangingSession.stop() was called.

Value: 1

REASON_NO_PEERS_FOUND

Added in API level 36
static val REASON_NO_PEERS_FOUND: Int

Indicates that the session was closed because none of the specified peers were found.

Value: 5

REASON_REMOTE_REQUEST

Added in API level 36
static val REASON_REMOTE_REQUEST: Int

Indicates that the session was closed at the request of a remote peer.

Value: 2

REASON_SYSTEM_POLICY

Added in API level 36
static val REASON_SYSTEM_POLICY: Int

Indicates that the local system policy forced the session to close, such as power management policy, airplane mode etc.

Value: 4

REASON_UNKNOWN

Added in API level 36
static val REASON_UNKNOWN: Int

Indicates that the session was closed due to an unknown reason.

Value: 0

REASON_UNSUPPORTED

Added in API level 36
static val REASON_UNSUPPORTED: Int

Indicates that the session closed because the provided session parameters were not supported.

Value: 3

Public methods

onClosed

Added in API level 36
abstract fun onClosed(reason: Int): Unit

Called when the ranging session has closed.

Parameters
reason Int: the reason why the session was closed, limited to values defined by android.ranging.RangingSession.Callback.Reason. Value is android.ranging.RangingSession.Callback#REASON_UNKNOWN, android.ranging.RangingSession.Callback#REASON_LOCAL_REQUEST, android.ranging.RangingSession.Callback#REASON_REMOTE_REQUEST, android.ranging.RangingSession.Callback#REASON_UNSUPPORTED, android.ranging.RangingSession.Callback#REASON_SYSTEM_POLICY, or android.ranging.RangingSession.Callback#REASON_NO_PEERS_FOUND

onOpenFailed

Added in API level 36
abstract fun onOpenFailed(reason: Int): Unit

Called when the ranging session failed to open.

Parameters
reason Int: the reason for the failure, limited to values defined by android.ranging.RangingSession.Callback.Reason. Value is android.ranging.RangingSession.Callback#REASON_UNKNOWN, android.ranging.RangingSession.Callback#REASON_LOCAL_REQUEST, android.ranging.RangingSession.Callback#REASON_REMOTE_REQUEST, android.ranging.RangingSession.Callback#REASON_UNSUPPORTED, android.ranging.RangingSession.Callback#REASON_SYSTEM_POLICY, or android.ranging.RangingSession.Callback#REASON_NO_PEERS_FOUND

onOpened

Added in API level 36
abstract fun onOpened(): Unit

Called when the ranging session opens successfully.

onResults

Added in API level 36
abstract fun onResults(
    peer: RangingDevice, 
    data: RangingData
): Unit

Called when ranging data has been received from a peer.

Parameters
peer RangingDevice: RangingDevice the peer from which ranging data was received. This value cannot be null.
data RangingData: RangingData the received. This value cannot be null.

onStarted

Added in API level 36
abstract fun onStarted(
    peer: RangingDevice, 
    technology: Int
): Unit

Called when ranging has started with a particular peer using a particular technology during an ongoing session.

Parameters
peer RangingDevice: RangingDevice the peer with which ranging has started. This value cannot be null.
technology Int: android.ranging.RangingManager.RangingTechnology the ranging technology that started. Value is android.ranging.RangingManager#UWB, android.ranging.RangingManager#BLE_CS, android.ranging.RangingManager#WIFI_NAN_RTT, or android.ranging.RangingManager#BLE_RSSI

onStopped

Added in API level 36
abstract fun onStopped(
    peer: RangingDevice, 
    technology: Int
): Unit

Called when ranging has stopped with a particular peer using a particular technology during an ongoing session.

Parameters
peer RangingDevice: RangingDevice the peer with which ranging has stopped. This value cannot be null.
technology Int: android.ranging.RangingManager.RangingTechnology the ranging technology that stopped. Value is android.ranging.RangingManager#UWB, android.ranging.RangingManager#BLE_CS, android.ranging.RangingManager#WIFI_NAN_RTT, or android.ranging.RangingManager#BLE_RSSI