Added in API level 33

Summary: Inherited Constants | Fields | Methods | Inherited Methods

AssociationInfo

Kotlin |Java

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

From interface android.os.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(Parcel, int)`: 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)`".

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.
`Icon`	`getDeviceIcon()` Get the device icon of the associated device.
`DeviceId`	`getDeviceId()`
`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

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

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:

for classic Bluetooth - AssociatedDevice.getBluetoothDevice()
for Bluetooth LE - AssociatedDevice.getBleDevice()
for WiFi - AssociatedDevice.getWifiDevice()

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.

getDeviceIcon

Added in version 36.1

public Icon getDeviceIcon ()

Get the device icon of the associated device. The device icon represents the device type.

Returns
`Icon`	the device icon with size 24dp x 24dp. If the associated device has no icon set, it returns `null`.

See also:

AssociationRequest.Builder.setDeviceIcon(Icon)

getDeviceId

Added in API level 36

public DeviceId getDeviceId ()

Returns
`DeviceId`	the `DeviceId` of this association. This value may be `null`.

See also:

CompanionDeviceManager.setDeviceId(int, DeviceId)

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.

See also:

AssociationRequest.Builder.setDeviceProfile(String)

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

See also:

AssociationRequest.Builder.setDisplayName(CharSequence)

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

Added in API level 35

public boolean isSelfManaged ()

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

See also:

AssociationRequest.Builder.setSelfManaged(boolean)

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