AssociationRequest

Kotlin |Java

class AssociationRequest : Parcelable

kotlin.Any
↳	android.companion.AssociationRequest

A request for the user to select a companion device to associate with. You can optionally set filters for which devices to show to the user to select from. The exact type and fields of the filter you can set depend on the medium type. See Builder's static factory methods for specific protocols that are supported. You can also set single device to request a popup with single device to be shown instead of a list to choose from

Summary

Nested classes
	`Builder` A builder for `AssociationRequest`

Constants
static String	`DEVICE_PROFILE_APP_STREAMING` Device profile: a virtual display capable of rendering Android applications, and sending back input events.
static String	`DEVICE_PROFILE_AUTOMOTIVE_PROJECTION` Device profile: Android Automotive Projection Only applications that have been granted `android.Manifest.permission#REQUEST_COMPANION_PROFILE_AUTOMOTIVE_PROJECTION` are allowed to request to be associated with such devices.
static String	`DEVICE_PROFILE_COMPUTER` Device profile: Allows the companion app to access notification, recent photos and media for computer cross-device features.
static String	`DEVICE_PROFILE_FITNESS_TRACKER` Device profile: fitness tracker.
static String	`DEVICE_PROFILE_GLASSES` Device profile: glasses.
static String	`DEVICE_PROFILE_MEDICAL` Device profile: A medical device, e.
static String	`DEVICE_PROFILE_NEARBY_DEVICE_STREAMING` Device profile: a virtual device capable of rendering content from an Android host to a nearby device.
static String	`DEVICE_PROFILE_WATCH` Device profile: watch.
static String	`PERMISSION_GROUP_NEARBY` Permission group to access nearby devices.

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public methods
Int	`describeContents()` 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.
Icon?	`getDeviceIcon()` Get the device icon of the self-managed association request.
String?	`getDeviceProfile()`
CharSequence?	`getDisplayName()` The Display name of the device to be shown in the CDM confirmation UI.
MutableSet<String!>	`getExtraPermissions()` Gets the extra permissions to request/grant for non-profile device.
Boolean	`isForceConfirmation()` Indicates whether the application requires the `CompanionDeviceManager` service to collect an explicit confirmation from the user before creating an association, even if such confirmation is not required from the service's perspective.
Boolean	`isSelfManaged()` Whether the association is to be managed by the companion application.
Boolean	`isSingleDevice()` Whether only a single device should match the provided filter.
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<AssociationRequest!>	`CREATOR`

Constants

DEVICE_PROFILE_APP_STREAMING

Added in API level 33

static val DEVICE_PROFILE_APP_STREAMING: String

Device profile: a virtual display capable of rendering Android applications, and sending back input events.

Only applications that have been granted android.Manifest.permission#REQUEST_COMPANION_PROFILE_APP_STREAMING are allowed to request to be associated with such devices.
Requires android.Manifest.permission#REQUEST_COMPANION_PROFILE_APP_STREAMING

Value: "android.app.role.COMPANION_DEVICE_APP_STREAMING"

See Also

android.companion.AssociationRequest.Builder#setDeviceProfile

DEVICE_PROFILE_AUTOMOTIVE_PROJECTION

Added in API level 33

static val DEVICE_PROFILE_AUTOMOTIVE_PROJECTION: String

Device profile: Android Automotive Projection Only applications that have been granted android.Manifest.permission#REQUEST_COMPANION_PROFILE_AUTOMOTIVE_PROJECTION are allowed to request to be associated with such devices.
Requires android.Manifest.permission#REQUEST_COMPANION_PROFILE_AUTOMOTIVE_PROJECTION

Value: "android.app.role.SYSTEM_AUTOMOTIVE_PROJECTION"

See Also

android.companion.AssociationRequest.Builder#setDeviceProfile

DEVICE_PROFILE_COMPUTER

Added in API level 33

static val DEVICE_PROFILE_COMPUTER: String

Device profile: Allows the companion app to access notification, recent photos and media for computer cross-device features. Only applications that have been granted android.Manifest.permission#REQUEST_COMPANION_PROFILE_COMPUTER are allowed to request to be associated with such devices.
Requires android.Manifest.permission#REQUEST_COMPANION_PROFILE_COMPUTER

Value: "android.app.role.COMPANION_DEVICE_COMPUTER"

See Also

android.companion.AssociationRequest.Builder#setDeviceProfile

DEVICE_PROFILE_FITNESS_TRACKER

Added in API level 26

static val DEVICE_PROFILE_FITNESS_TRACKER: String

Device profile: fitness tracker. If specified, the current request may have a modified UI to highlight that the device being set up is a specific kind of device, and some extra permissions may be granted to the app as a result. Using it requires declaring uses-permission android.Manifest.permission#REQUEST_COMPANION_PROFILE_WATCH in the manifest. Learn more about device profiles.
Requires android.Manifest.permission#REQUEST_COMPANION_PROFILE_WATCH

Value: "android.app.role.COMPANION_DEVICE_FITNESS_TRACKER"

See Also

android.companion.AssociationRequest.Builder#setDeviceProfile

DEVICE_PROFILE_GLASSES

Added in API level 34

static val DEVICE_PROFILE_GLASSES: String

Device profile: glasses. If specified, the current request may have a modified UI to highlight that the device being set up is a glasses device, and some extra permissions may be granted to the app as a result. Using it requires declaring uses-permission android.Manifest.permission#REQUEST_COMPANION_PROFILE_GLASSES in the manifest.
Requires android.Manifest.permission#REQUEST_COMPANION_PROFILE_GLASSES

Value: "android.app.role.COMPANION_DEVICE_GLASSES"

See Also

android.companion.AssociationRequest.Builder#setDeviceProfile

DEVICE_PROFILE_MEDICAL

Added in API level 26

static val DEVICE_PROFILE_MEDICAL: String

Device profile: A medical device, e.g. blood sugar level monitor, heart rate monitor, etc. If specified, the current request may have a modified UI to highlight that the device being set up is a medical device, and some extra permissions may be granted to the app as a result. Using it requires declaring uses-permission android.Manifest.permission#REQUEST_COMPANION_PROFILE_MEDICAL in the manifest.
Requires android.Manifest.permission#REQUEST_COMPANION_PROFILE_MEDICAL

Value: "android.app.role.COMPANION_DEVICE_MEDICAL"

DEVICE_PROFILE_NEARBY_DEVICE_STREAMING

Added in API level 34

static val DEVICE_PROFILE_NEARBY_DEVICE_STREAMING: String

Device profile: a virtual device capable of rendering content from an Android host to a nearby device.

Only applications that have been granted android.Manifest.permission#REQUEST_COMPANION_PROFILE_NEARBY_DEVICE_STREAMING are allowed to request to be associated with such devices.
Requires android.Manifest.permission#REQUEST_COMPANION_PROFILE_NEARBY_DEVICE_STREAMING

Value: "android.app.role.COMPANION_DEVICE_NEARBY_DEVICE_STREAMING"

See Also

android.companion.AssociationRequest.Builder#setDeviceProfile

DEVICE_PROFILE_WATCH

Added in API level 31

static val DEVICE_PROFILE_WATCH: String

Device profile: watch. If specified, the current request may have a modified UI to highlight that the device being set up is a specific kind of device, and some extra permissions may be granted to the app as a result. Using it requires declaring uses-permission android.Manifest.permission#REQUEST_COMPANION_PROFILE_WATCH in the manifest. Learn more about device profiles.

Value: "android.app.role.COMPANION_DEVICE_WATCH"

See Also

android.companion.AssociationRequest.Builder#setDeviceProfile

PERMISSION_GROUP_NEARBY

Added in API level 26

static val PERMISSION_GROUP_NEARBY: String

Permission group to access nearby devices.

Value: "NEARBY_DEVICES"

Public methods

describeContents

Added in API level 26

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

equals

Added in API level 26

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.

getDeviceIcon

Added in API level 36.1

fun getDeviceIcon(): Icon?

Get the device icon of the self-managed association request.

Return
`Icon?`	the device icon, or `null` if no device icon has been set.

See Also

android.companion.AssociationRequest.Builder#setDeviceIcon(Icon)

getDeviceProfile

Added in API level 33

fun getDeviceProfile(): String?

Return
`String?`	profile of the companion device. This value may be `null`. Value is one of the following: `DEVICE_PROFILE_WATCH` `DEVICE_PROFILE_COMPUTER` `DEVICE_PROFILE_AUTOMOTIVE_PROJECTION` `DEVICE_PROFILE_APP_STREAMING` `DEVICE_PROFILE_GLASSES` `DEVICE_PROFILE_NEARBY_DEVICE_STREAMING`

getDisplayName

Added in API level 33

fun getDisplayName(): CharSequence?

The Display name of the device to be shown in the CDM confirmation UI. Must be non-null for "self-managed" association.

getExtraPermissions

Added in API level 26

fun getExtraPermissions(): MutableSet<String!>

Gets the extra permissions to request/grant for non-profile device.

Return
`MutableSet<String!>`	A set of permission strings. This value cannot be `null`.

isForceConfirmation

Added in API level 33

fun isForceConfirmation(): Boolean

Indicates whether the application requires the CompanionDeviceManager service to collect an explicit confirmation from the user before creating an association, even if such confirmation is not required from the service's perspective.

See Also

android.companion.AssociationRequest.Builder#setForceConfirmation(boolean)

isSelfManaged

Added in API level 33

fun isSelfManaged(): Boolean

Whether the association is to be managed by the companion application.

See Also

android.companion.AssociationRequest.Builder#setSelfManaged(boolean)

isSingleDevice

Added in API level 33

fun isSingleDevice(): Boolean

Whether only a single device should match the provided filter. When scanning for a single device with a specific BluetoothDeviceFilter mac address, bonded devices are also searched among. This allows to obtain the necessary app privileges even if the device is already paired.

toString

Added in API level 26

fun toString(): String

Returns a string representation of the object.

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 26

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: `PARCELABLE_WRITE_RETURN_VALUE`

Properties

CREATOR

Added in API level 26

static val CREATOR: Parcelable.Creator<AssociationRequest!>