AssociationRequest
public
final
class
AssociationRequest
extends Object
implements
Parcelable
java.lang.Object | |
↳ | 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 | |
---|---|
class |
AssociationRequest.Builder
A builder for |
Constants | |
---|---|
String |
DEVICE_PROFILE_APP_STREAMING
Device profile: a virtual display capable of rendering Android applications, and sending back input events. |
String |
DEVICE_PROFILE_AUTOMOTIVE_PROJECTION
Device profile: Android Automotive Projection
Only applications that have been granted
|
String |
DEVICE_PROFILE_COMPUTER
Device profile: Allows the companion app to access notification, recent photos and media for computer cross-device features. |
String |
DEVICE_PROFILE_GLASSES
Device profile: glasses. |
String |
DEVICE_PROFILE_NEARBY_DEVICE_STREAMING
Device profile: a virtual device capable of rendering content from an Android host to a nearby device. |
String |
DEVICE_PROFILE_WATCH
Device profile: watch. |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<AssociationRequest> |
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. |
String
|
getDeviceProfile()
|
CharSequence
|
getDisplayName()
The Display name of the device to be shown in the CDM confirmation UI. |
int
|
hashCode()
Returns a hash code value for the object. |
boolean
|
isForceConfirmation()
Indicates whether the application requires the |
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. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Constants
DEVICE_PROFILE_APP_STREAMING
public static final String DEVICE_PROFILE_APP_STREAMING
Device profile: a virtual display capable of rendering Android applications, and sending back
input events.
Only applications that have been granted
Manifest.permission.REQUEST_COMPANION_PROFILE_APP_STREAMING
are allowed to
request to be associated with such devices.
Requires Manifest.permission.REQUEST_COMPANION_PROFILE_APP_STREAMING
Constant Value: "android.app.role.COMPANION_DEVICE_APP_STREAMING"
DEVICE_PROFILE_AUTOMOTIVE_PROJECTION
public static final String DEVICE_PROFILE_AUTOMOTIVE_PROJECTION
Device profile: Android Automotive Projection
Only applications that have been granted
Manifest.permission.REQUEST_COMPANION_PROFILE_AUTOMOTIVE_PROJECTION
are
allowed to request to be associated with such devices.
Requires Manifest.permission.REQUEST_COMPANION_PROFILE_AUTOMOTIVE_PROJECTION
Constant Value: "android.app.role.SYSTEM_AUTOMOTIVE_PROJECTION"
DEVICE_PROFILE_COMPUTER
public static final String DEVICE_PROFILE_COMPUTER
Device profile: Allows the companion app to access notification, recent photos and media for
computer cross-device features.
Only applications that have been granted
Manifest.permission.REQUEST_COMPANION_PROFILE_COMPUTER
are allowed to
request to be associated with such devices.
Requires Manifest.permission.REQUEST_COMPANION_PROFILE_COMPUTER
Constant Value: "android.app.role.COMPANION_DEVICE_COMPUTER"
DEVICE_PROFILE_GLASSES
public static final String DEVICE_PROFILE_GLASSES
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
Manifest.permission.REQUEST_COMPANION_PROFILE_GLASSES
in the manifest.
Requires Manifest.permission.REQUEST_COMPANION_PROFILE_GLASSES
Constant Value: "android.app.role.COMPANION_DEVICE_GLASSES"
DEVICE_PROFILE_NEARBY_DEVICE_STREAMING
public static final String DEVICE_PROFILE_NEARBY_DEVICE_STREAMING
Device profile: a virtual device capable of rendering content from an Android host to a
nearby device.
Only applications that have been granted
Manifest.permission.REQUEST_COMPANION_PROFILE_NEARBY_DEVICE_STREAMING
are allowed to request to be associated with such devices.
Requires Manifest.permission.REQUEST_COMPANION_PROFILE_NEARBY_DEVICE_STREAMING
Constant Value: "android.app.role.COMPANION_DEVICE_NEARBY_DEVICE_STREAMING"
DEVICE_PROFILE_WATCH
public static final String DEVICE_PROFILE_WATCH
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
Manifest.permission.REQUEST_COMPANION_PROFILE_WATCH
in the manifest.
Learn more
about device profiles.
Constant Value: "android.app.role.COMPANION_DEVICE_WATCH"
Fields
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons 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 | |
---|---|
o |
Object : This value may be null . |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getDeviceProfile
public String getDeviceProfile ()
Returns | |
---|---|
String |
profile of the companion device.
This value may be null .
Value is DEVICE_PROFILE_WATCH , DEVICE_PROFILE_COMPUTER , DEVICE_PROFILE_AUTOMOTIVE_PROJECTION , DEVICE_PROFILE_APP_STREAMING , DEVICE_PROFILE_GLASSES , or DEVICE_PROFILE_NEARBY_DEVICE_STREAMING |
getDisplayName
public CharSequence getDisplayName ()
The Display name of the device to be shown in the CDM confirmation UI. Must be non-null for "self-managed" association.
Returns | |
---|---|
CharSequence |
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 inequals
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 thehashCode
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 thehashCode
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. |
isForceConfirmation
public 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.
Returns | |
---|---|
boolean |
isSelfManaged
public boolean isSelfManaged ()
Whether the association is to be managed by the companion application.
Returns | |
---|---|
boolean |
isSingleDevice
public boolean isSingleDevice ()
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.
Returns | |
---|---|
boolean |
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 |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-04-11 UTC.