AssociationInfo
class AssociationInfo : Parcelable
| kotlin.Any | |
| ↳ | 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 | |
|---|---|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| AssociatedDevice? |
Companion device that was associated. |
| UUID |
Association owner app can give this token to other apps to execute actions e. |
| Icon? |
Get the device icon of the associated device. |
| DeviceId? | |
| MacAddress? | |
| String? | |
| CharSequence? | |
| MutableSet<String!> | |
| Int |
getId() |
| Int | |
| IntArray | |
| Int |
hashCode()Returns a hash code value for the object. |
| Boolean | |
| Boolean | |
| Boolean |
Returns whether an association is a trusted device. |
| String |
toString()Returns a string representation of the object. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<AssociationInfo!> | |
Public methods
describeContents
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(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
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. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getAssociatedDevice
fun getAssociatedDevice(): AssociatedDevice?
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()
| Return | |
|---|---|
AssociatedDevice? |
the companion device that was associated, or null if the device is self-managed or this association info was retrieved from persistent storage. |
getAssociationToken
fun getAssociationToken(): UUID
Association owner app can give this token to other apps to execute actions e.g. request remote device authentication on this association without revealing the actual association information. This token is automatically refreshed whenever the companion app calls CompanionDeviceManager.createAndSetDeviceId(int,DeviceId).
| Return | |
|---|---|
UUID |
A system generated token for this association. This value cannot be null. |
getDeviceIcon
fun getDeviceIcon(): Icon?
Get the device icon of the associated device. The device icon represents the device type.
| Return | |
|---|---|
Icon? |
the device icon with size 24dp x 24dp. If the associated device has no icon set, it returns null. |
getDeviceId
fun getDeviceId(): DeviceId?
| Return | |
|---|---|
DeviceId? |
the DeviceId of this association. This value may be null. |
getDeviceMacAddress
fun getDeviceMacAddress(): MacAddress?
| Return | |
|---|---|
MacAddress? |
the MAC address of the device. This value may be null. |
getDeviceProfile
fun getDeviceProfile(): String?
| Return | |
|---|---|
String? |
the companion device profile used when establishing this association, or null if no specific profile was used. |
getDisplayName
fun getDisplayName(): CharSequence?
| Return | |
|---|---|
CharSequence? |
the display name of the companion device (optionally) provided by the companion application. This value may be null. |
getExtraPermissions
fun getExtraPermissions(): MutableSet<String!>
| Return | |
|---|---|
MutableSet<String!> |
A non-null, possibly empty, set of extra permissions. |
getSystemDataSyncFlags
fun getSystemDataSyncFlags(): Int
| Return | |
|---|---|
Int |
Enabled system data sync flags set via CompanionDeviceManager.enableSystemDataSyncForTypes(int,int) (int, int)} and CompanionDeviceManager.disableSystemDataSyncForTypes(int,int) (int, int)}. |
getTrustTypes
fun getTrustTypes(): IntArray
| Return | |
|---|---|
IntArray |
An array of enabled trust types for this association, or an empty array if none are enabled. This value cannot be null. |
hashCode
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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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. |
isSelfManaged
fun isSelfManaged(): Boolean
| Return | |
|---|---|
Boolean |
whether the association is managed by the companion application it belongs to. |
isTrusted
fun isTrusted(): Boolean
Returns whether an association is a trusted device.
A trusted device is a device that has been verified as user-owned via a combination of successful secure connection establishment as well as an internal handshake involving a direct user confirmation (e.g. Displayed PIN comparison).
| Return | |
|---|---|
Boolean |
True if the device had successfully verified its connection. False otherwise. |
See Also
toString
fun toString(): String
Returns a string representation of the object.
| 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 either 0 or a combination of the following:
|