DevicePresenceEvent


public final class DevicePresenceEvent
extends Object implements Parcelable

java.lang.Object
   ↳ android.companion.DevicePresenceEvent


Event for observing device presence.

Summary

Constants

int EVENT_BLE_APPEARED

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

int EVENT_BLE_DISAPPEARED

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

int EVENT_BT_CONNECTED

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

int EVENT_BT_DISCONNECTED

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

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.

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.

int NO_ASSOCIATION

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

Inherited constants

Fields

public static final Creator<DevicePresenceEvent> CREATOR

Public constructors

DevicePresenceEvent(int associationId, int event, ParcelUuid uuid)

Create a new DevicePresenceEvent.

Public methods

int describeContents()

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

boolean equals(Object o)

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

int getAssociationId()
int getEvent()
ParcelUuid getUuid()
int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

EVENT_BLE_APPEARED

public static final int EVENT_BLE_APPEARED

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

Constant Value: 0 (0x00000000)

EVENT_BLE_DISAPPEARED

public static final int EVENT_BLE_DISAPPEARED

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

Constant Value: 1 (0x00000001)

EVENT_BT_CONNECTED

public static final int EVENT_BT_CONNECTED

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

Constant Value: 2 (0x00000002)

EVENT_BT_DISCONNECTED

public static final int EVENT_BT_DISCONNECTED

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

Constant Value: 3 (0x00000003)

EVENT_SELF_MANAGED_APPEARED

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

Constant Value: 4 (0x00000004)

EVENT_SELF_MANAGED_DISAPPEARED

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

Constant Value: 5 (0x00000005)

NO_ASSOCIATION

public static final int NO_ASSOCIATION

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

Constant Value: -1 (0xffffffff)

Fields

CREATOR

public static final Creator<DevicePresenceEvent> CREATOR

Public constructors

DevicePresenceEvent

public DevicePresenceEvent (int associationId, 
                int event, 
                ParcelUuid uuid)

Create a new DevicePresenceEvent.

Parameters
associationId int

event int: Value is EVENT_BLE_APPEARED, EVENT_BLE_DISAPPEARED, EVENT_BT_CONNECTED, EVENT_BT_DISCONNECTED, EVENT_SELF_MANAGED_APPEARED, or EVENT_SELF_MANAGED_DISAPPEARED

uuid ParcelUuid: This value may be null.

Public methods

describeContents

public int describeContents ()

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.

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

equals

public boolean equals (Object o)

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
o Object: This value may be null.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getAssociationId

public int getAssociationId ()

Returns
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

public int getEvent ()

Returns
int Associated companion device's event.

getUuid

public ParcelUuid getUuid ()

Returns
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

public int hashCode ()

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

Returns
int a hash code value for this object.

toString

public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES