Added in API level 36

DevicePresenceEvent

---

Kotlin |Java

class DevicePresenceEvent : Parcelable

kotlin.Any
↳	android.companion.DevicePresenceEvent

Event for observing device presence.

Summary

Constants
static Int	EVENT_ASSOCIATION_REMOVED A companion app will receives the callback CompanionDeviceService.onDevicePresenceEvent(DevicePresenceEvent) with this event when the AssociationInfo is removed.
static Int	EVENT_BLE_APPEARED Companion app receives CompanionDeviceService.onDevicePresenceEvent(DevicePresenceEvent) callback with this event if the device comes into BLE range.
static Int	EVENT_BLE_DISAPPEARED Companion app receives CompanionDeviceService.onDevicePresenceEvent(DevicePresenceEvent) callback with this event if the device is no longer in BLE range.
static Int	EVENT_BT_CONNECTED Companion app receives CompanionDeviceService.onDevicePresenceEvent(DevicePresenceEvent) callback with this event when the bluetooth device is connected.
static Int	EVENT_BT_DISCONNECTED Companion app receives CompanionDeviceService.onDevicePresenceEvent(DevicePresenceEvent) callback with this event if the bluetooth device is disconnected.
static Int	EVENT_SELF_MANAGED_APPEARED A companion app for a self-managed device will receive the callback CompanionDeviceService.onDevicePresenceEvent(DevicePresenceEvent) if it reports that a device has appeared on its own.
static Int	EVENT_SELF_MANAGED_DISAPPEARED A companion app for a self-managed device will receive the callback CompanionDeviceService.onDevicePresenceEvent(DevicePresenceEvent) if it reports that a device has disappeared on its own.
static Int	NO_ASSOCIATION Indicate observing device presence base on the ParcelUuid but not association id.

Inherited constants

From class Parcelable Int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. Int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel: 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)". Some implementations may want to release resources at this point.

Public constructors
DevicePresenceEvent(associationId: Int, event: Int, uuid: ParcelUuid?) Create a new DevicePresenceEvent.

Public methods
Int	describeContents()
Boolean	equals(other: Any?) Indicates whether some other object is "equal to" this one.
Int	getAssociationId()
Int	getEvent()
ParcelUuid?	getUuid()
Int	hashCode()
String	toString()
Unit	writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<DevicePresenceEvent!>	CREATOR

Constants

EVENT_ASSOCIATION_REMOVED

Added in API level 36.1

static val EVENT_ASSOCIATION_REMOVED: Int

A companion app will receives the callback CompanionDeviceService.onDevicePresenceEvent(DevicePresenceEvent) with this event when the AssociationInfo is removed.

Value: 6

EVENT_BLE_APPEARED

Added in API level 36

static val EVENT_BLE_APPEARED: Int

Companion app receives CompanionDeviceService.onDevicePresenceEvent(DevicePresenceEvent) callback with this event if the device comes into BLE range.

Value: 0

EVENT_BLE_DISAPPEARED

Added in API level 36

static val EVENT_BLE_DISAPPEARED: Int

Companion app receives CompanionDeviceService.onDevicePresenceEvent(DevicePresenceEvent) callback with this event if the device is no longer in BLE range.

Value: 1

EVENT_BT_CONNECTED

Added in API level 36

static val EVENT_BT_CONNECTED: Int

Companion app receives CompanionDeviceService.onDevicePresenceEvent(DevicePresenceEvent) callback with this event when the bluetooth device is connected.

Value: 2

EVENT_BT_DISCONNECTED

Added in API level 36

static val EVENT_BT_DISCONNECTED: Int

Companion app receives CompanionDeviceService.onDevicePresenceEvent(DevicePresenceEvent) callback with this event if the bluetooth device is disconnected.

Value: 3

EVENT_SELF_MANAGED_APPEARED

Added in API level 36

static val EVENT_SELF_MANAGED_APPEARED: Int

A companion app for a self-managed device will receive the callback CompanionDeviceService.onDevicePresenceEvent(DevicePresenceEvent) if it reports that a device has appeared on its own.

Value: 4

EVENT_SELF_MANAGED_DISAPPEARED

Added in API level 36

static val EVENT_SELF_MANAGED_DISAPPEARED: Int

A companion app for a self-managed device will receive the callback CompanionDeviceService.onDevicePresenceEvent(DevicePresenceEvent) if it reports that a device has disappeared on its own.

Value: 5

NO_ASSOCIATION

Added in API level 36

static val NO_ASSOCIATION: Int

Indicate observing device presence base on the ParcelUuid but not association id.

Value: -1

Public constructors

DevicePresenceEvent

Added in API level 36

DevicePresenceEvent(
    associationId: Int, 
    event: Int, 
    uuid: ParcelUuid?)

Create a new DevicePresenceEvent.

Parameters
event	Int: Value is android.companion.DevicePresenceEvent#EVENT_BLE_APPEARED, android.companion.DevicePresenceEvent#EVENT_BLE_DISAPPEARED, android.companion.DevicePresenceEvent#EVENT_BT_CONNECTED, android.companion.DevicePresenceEvent#EVENT_BT_DISCONNECTED, android.companion.DevicePresenceEvent#EVENT_SELF_MANAGED_APPEARED, android.companion.DevicePresenceEvent#EVENT_SELF_MANAGED_DISAPPEARED, android.companion.DevicePresenceEvent#EVENT_ASSOCIATION_REMOVED, android.companion.DevicePresenceEvent.EVENT_SELF_MANAGED_NEARBY, or android.companion.DevicePresenceEvent.EVENT_SELF_MANAGED_NOT_NEARBY
uuid	ParcelUuid?: This value may be null.

Public methods

describeContents

Added in API level 36

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 36

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 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.

Parameters
obj	the reference object with which to compare.
o	This value may be null.

Return
Boolean	true if this object is the same as the obj argument; false otherwise.

getAssociationId

Added in API level 36

fun getAssociationId(): Int

Return
Int	The association id has been used to observe device presence. Caller will receive the valid association id if only if using ObservingDevicePresenceRequest.Builder.setAssociationId(int), otherwise return NO_ASSOCIATION.

See Also

• android.companion.ObservingDevicePresenceRequest.Builder#setAssociationId(int)

getEvent

Added in API level 36

fun getEvent(): Int

Return
Int	Associated companion device's event.

getUuid

Added in API level 36

fun getUuid(): ParcelUuid?

Return
ParcelUuid?	The ParcelUuid has been used to observe device presence. Caller will receive the ParcelUuid if only if using ObservingDevicePresenceRequest.Builder.setUuid(ParcelUuid), otherwise return null.

See Also

• android.companion.ObservingDevicePresenceRequest.Builder#setUuid(ParcelUuid)

hashCode

Added in API level 36

fun hashCode(): Int

Return
Int	a hash code value for this object.

toString

Added in API level 36

fun toString(): String

Return
String	a string representation of the object.

writeToParcel

Added in API level 36

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 android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 36

static val CREATOR: Parcelable.Creator<DevicePresenceEvent!>