DevicePresenceEvent
class DevicePresenceEvent : Parcelable
| kotlin.Any | |
| ↳ | android.companion.DevicePresenceEvent | 
Event for observing device presence.
Summary
| Constants | |
|---|---|
| static Int | A companion app will receives the callback  | 
| static Int | Companion app receives  | 
| static Int | Companion app receives  | 
| static Int | Companion app receives  | 
| static Int | Companion app receives  | 
| static Int | A companion app for a self-managed device will receive the callback  | 
| static Int | A companion app for a self-managed device will receive the callback  | 
| static Int | Indicate observing device presence base on the ParcelUuid but not association id. | 
| Inherited constants | |
|---|---|
| Public constructors | |
|---|---|
| DevicePresenceEvent(associationId: Int, event: Int, uuid: ParcelUuid?)Create a new DevicePresenceEvent. | |
| Public methods | |
|---|---|
| Int | |
| Boolean | Indicates whether some other object is "equal to" this one. | 
| Int | |
| 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!> | |
Constants
EVENT_ASSOCIATION_REMOVED
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: 6EVENT_BLE_APPEARED
static val EVENT_BLE_APPEARED: Int
Companion app receives CompanionDeviceService.onDevicePresenceEvent(DevicePresenceEvent) callback with this event if the device comes into BLE range.
Value: 0EVENT_BLE_DISAPPEARED
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: 1EVENT_BT_CONNECTED
static val EVENT_BT_CONNECTED: Int
Companion app receives CompanionDeviceService.onDevicePresenceEvent(DevicePresenceEvent) callback with this event when the bluetooth device is connected.
Value: 2EVENT_BT_DISCONNECTED
static val EVENT_BT_DISCONNECTED: Int
Companion app receives CompanionDeviceService.onDevicePresenceEvent(DevicePresenceEvent) callback with this event if the bluetooth device is disconnected.
Value: 3EVENT_SELF_MANAGED_APPEARED
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: 4EVENT_SELF_MANAGED_DISAPPEARED
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: 5NO_ASSOCIATION
static val NO_ASSOCIATION: Int
Indicate observing device presence base on the ParcelUuid but not association id.
Value: -1Public constructors
DevicePresenceEvent
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
fun describeContents(): Int
| Return | |
|---|---|
| Int | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0orandroid.os.Parcelable#CONTENTS_FILE_DESCRIPTOR | 
equals
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 returntrue.
- It is symmetric: for any non-null reference values xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue.
- It is transitive: for any non-null reference values x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue.
- It is consistent: for any non-null reference values xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified.
- For any non-null reference value x,x.equals(null)should returnfalse.
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 | trueif this object is the same as the obj argument;falseotherwise. | 
getAssociationId
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 returnNO_ASSOCIATION. | 
getUuid
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. | 
toString
fun toString(): String
| Return | |
|---|---|
| String | a string representation of the object. | 
writeToParcel
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 either0or a combination ofandroid.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES | 
