Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

HandoffActivityData

---

Kotlin |Java

public final class HandoffActivityData
extends Object implements Parcelable

java.lang.Object
↳	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 ERROR(/#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
class	HandoffActivityData.Builder Builder for HandoffActivityData.

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<HandoffActivityData>	CREATOR

Public methods
static HandoffActivityData	createWebHandoff(Uri uri) Creates a HandoffActivityData object for a web handoff.
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
ComponentName	getComponentName()
PersistableBundle	getExtras()
Uri	getFallbackUri()
int	hashCode() Returns a hash code value for 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

public static final Creator<HandoffActivityData> CREATOR

Public methods

createWebHandoff

public static HandoffActivityData createWebHandoff (Uri uri)

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.

Returns
HandoffActivityData	the HandoffActivityData object. This value cannot be null.

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(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 obj)

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	Object: the reference object with which to compare.

Returns
boolean	true if this object is the same as the obj argument; false otherwise.

getComponentName

public ComponentName getComponentName ()

Returns
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

public PersistableBundle getExtras ()

Returns
PersistableBundle	extras to pass inside the launch intent via ERROR(/Intent#putExtras) for the activity specified by getComponentName() during handoff. This defaults to an empty bundle. This value cannot be null.

getFallbackUri

public Uri getFallbackUri ()

Returns
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

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.

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 the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE