Added in API level 36

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 CompanionDeviceService.onDevicePresenceEvent(DevicePresenceEvent) with this event when the AssociationInfo is removed.

static Int

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

static Int

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

static Int

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

static Int

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

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

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

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

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.

Int

Int

ParcelUuid?

Int

Returns a hash code value for the object.

String

Returns a string representation of the object.

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: 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 one of the following:
uuid ParcelUuid?: This value may be null.

Public methods

describeContents

Added in API level 36
fun describeContents(): Int

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 writeToParcel(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.
Value is either 0 or

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.

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.

hashCode

Added in API level 36
fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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 equals 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 equals 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.
Return
Int a hash code value for this object.

toString

Added in API level 36
fun toString(): String

Returns a string representation of the object.

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 the following:

Properties

CREATOR

Added in API level 36
static val CREATOR: Parcelable.Creator<DevicePresenceEvent!>