AssociationInfo

public final class AssociationInfo
extends Object implements Parcelable

java.lang.Object
   ↳ android.companion.AssociationInfo


Details for a specific "association" that has been established between an app and companion device.

An association gives an app the ability to interact with a companion device without needing to acquire broader runtime permissions. An association only exists after the user has confirmed that an app should have access to a companion device.

Summary

Inherited constants

Fields

public static final Creator<AssociationInfo> CREATOR

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.

AssociatedDevice getAssociatedDevice()

Companion device that was associated.

MacAddress getDeviceMacAddress()
String getDeviceProfile()
CharSequence getDisplayName()
int getId()
int getSystemDataSyncFlags()
int hashCode()

Returns a hash code value for the object.

boolean isSelfManaged()
String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 33
public static final Creator<AssociationInfo> CREATOR

Public methods

describeContents

Added in API level 33
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

Added in API level 33
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: the reference object with which to compare.

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

getAssociatedDevice

Added in API level 34
public AssociatedDevice getAssociatedDevice ()

Companion device that was associated. Note that this field is not persisted across sessions. Device can be one of the following types:

Returns
AssociatedDevice the companion device that was associated, or null if the device is self-managed or this association info was retrieved from persistent storage.

getDeviceMacAddress

Added in API level 33
public MacAddress getDeviceMacAddress ()

Returns
MacAddress the MAC address of the device. This value may be null.

getDeviceProfile

Added in API level 33
public String getDeviceProfile ()

Returns
String the companion device profile used when establishing this association, or null if no specific profile was used.

getDisplayName

Added in API level 33
public CharSequence getDisplayName ()

Returns
CharSequence the display name of the companion device (optionally) provided by the companion application. This value may be null.

getId

Added in API level 33
public int getId ()

Returns
int the unique ID of this association record.

getSystemDataSyncFlags

Added in API level 34
public int getSystemDataSyncFlags ()

Returns
int Enabled system data sync flags set via CompanionDeviceManager#enableSystemDataSyncForTypes(int, int) (int, int)} and CompanionDeviceManager#disableSystemDataSyncForTypes(int, int) (int, int)}. Or by default all flags are 1 (enabled).

hashCode

Added in API level 33
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.

isSelfManaged

public boolean isSelfManaged ()

Returns
boolean whether the association is managed by the companion application it belongs to.

toString

Added in API level 33
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 33
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