Added in API level 37

HandoffActivityData

class HandoffActivityData : Parcelable
kotlin.Any
   ↳ android.app.HandoffActivityData

Represents information needed to recreate an activity on a remote device owned by the user.

This class is returned by Activity.onHandoffActivityDataRequested, and is passed to a remote device owned by the user. The remote device will create a launch intent for the activity specified by getComponentName(), passing along any extras specified by getExtras().

If getComponentName() cannot be launched on the remote device, developers can optionally specify a fallback URI in #setFallbackUri(). The URI specified will be launched on the remote device's web browser in this case. If no fallback URI is specified, the user will be presented with an error. If the system is attempting to hand off the entire task, failure to resolve getComponentName() will result in only the top activity of the task being handed off. It is also possible to simply specify a fallback URI, rather than specifying a component name.

Summary

Nested classes

Builder for HandoffActivityData.
Inherited constants
Public methods
static HandoffActivityData

Creates a HandoffActivityData object for a web handoff.
Int

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.
ComponentName?

PersistableBundle

Uri?

Int

Returns a hash code value for the object.
Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.
Properties
static Parcelable.Creator<HandoffActivityData!>

Public methods

createWebHandoff

Added in API level 37
static fun createWebHandoff(uri: Uri): HandoffActivityData

Creates a HandoffActivityData object for a web handoff.

Parameters
uri Uri: the URI to be launched on the remote device's web browser.
This value cannot be null.
Return
HandoffActivityData the HandoffActivityData object.
This value cannot be null.

describeContents

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

Added in API level 37
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.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getComponentName

Added in API level 37
fun getComponentName(): ComponentName?
Return
ComponentName? the component name of an activity to launch on the remote device when the activity represented by this object is handed off. When this is null, the getFallbackUri() will be used.

getExtras

Added in API level 37
fun getExtras(): PersistableBundle
Return
PersistableBundle extras to pass inside the launch intent via Intent#putExtras for the activity specified by getComponentName() during handoff. This defaults to an empty bundle.
This value cannot be null.

getFallbackUri

Added in API level 37
fun getFallbackUri(): Uri?
Return
Uri? the URI which will be launched on the remote device's web browser if the activity specified by getComponentName() cannot be launched, or null if no fallback URI was specified.

hashCode

Added in API level 37
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 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.
Return
Int a hash code value for this object.

writeToParcel

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

Properties

CREATOR

Added in API level 37
static val CREATOR: Parcelable.Creator<HandoffActivityData!>