Stay organized with collections Save and categorize content based on your preferences.

public static class ActivityManager.TaskDescription
extends Object implements Parcelable


Information you can set and retrieve about the current activity within the recent task list.

Summary

Nested classes

class ActivityManager.TaskDescription.Builder

Provides a convenient way to set the fields of a TaskDescription when creating a new instance. 

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<ActivityManager.TaskDescription> CREATOR

Public constructors

TaskDescription(String label, int iconRes, int colorPrimary)

This constructor is deprecated. Use Builder instead.

TaskDescription(String label, int iconRes)

This constructor is deprecated. Use Builder instead.

TaskDescription(String label)

This constructor is deprecated. Use Builder instead.

TaskDescription()

This constructor is deprecated. Use Builder instead.

TaskDescription(String label, Bitmap icon, int colorPrimary)

This constructor is deprecated. Use Builder instead.

TaskDescription(String label, Bitmap icon)

This constructor is deprecated. Use Builder instead.

TaskDescription(ActivityManager.TaskDescription td)

Creates a copy of another TaskDescription.

Public methods

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.

int getBackgroundColor()
Bitmap getIcon()

This method was deprecated in API level 30. This call is no longer supported. The caller should keep track of any icons it sets for the task descriptions internally.

String getLabel()
int getNavigationBarColor()
int getPrimaryColor()
int getStatusBarColor()
void readFromParcel(Parcel source)
String toString()

Returns a string representation of 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

Added in API level 21 

public static final Creator<ActivityManager.TaskDescription> CREATOR

Public constructors

TaskDescription

Added in API level 28 

public TaskDescription (String label, 
                int iconRes, 
                int colorPrimary)

This constructor is deprecated.
Use Builder instead.

Creates the TaskDescription to the specified values.

Parameters
label String: A label and description of the current state of this task.
iconRes int: A drawable resource of an icon that represents the current state of this activity.
colorPrimary int: A color to override the theme's primary color. This color must be opaque.

TaskDescription

Added in API level 28 

public TaskDescription (String label, 
                int iconRes)

This constructor is deprecated.
Use Builder instead.

Creates the TaskDescription to the specified values.

Parameters
label String: A label and description of the current state of this activity.
iconRes int: A drawable resource of an icon that represents the current state of this activity.

TaskDescription

Added in API level 21 

public TaskDescription (String label)

This constructor is deprecated.
Use Builder instead.

Creates the TaskDescription to the specified values.

Parameters
label String: A label and description of the current state of this activity.

TaskDescription

Added in API level 21 

public TaskDescription ()

This constructor is deprecated.
Use Builder instead.

Creates an empty TaskDescription.

TaskDescription

Added in API level 21 

public TaskDescription (String label, 
                Bitmap icon, 
                int colorPrimary)

This constructor is deprecated.
Use Builder instead.

Creates the TaskDescription to the specified values.

Parameters
label String: A label and description of the current state of this task.
icon Bitmap: An icon that represents the current state of this task.
colorPrimary int: A color to override the theme's primary color. This color must be opaque.

TaskDescription

Added in API level 21 

public TaskDescription (String label, 
                Bitmap icon)

This constructor is deprecated.
Use Builder instead.

Creates the TaskDescription to the specified values.

Parameters
label String: A label and description of the current state of this activity.
icon Bitmap: An icon that represents the current state of this activity.

TaskDescription

Added in API level 21 

public TaskDescription (ActivityManager.TaskDescription td)

Creates a copy of another TaskDescription.

Parameters
td ActivityManager.TaskDescription

Public methods

describeContents

Added in API level 21 

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

Added in API level 21 

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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
obj Object: This value may be null.
Returns
boolean true if this object is the same as the obj argument; false otherwise.

getBackgroundColor

Added in API level 33 

public int getBackgroundColor ()
Returns
int The color override on the theme's background color.

getIcon

Added in API level 21
Deprecated in API level 30 

public Bitmap getIcon ()

This method was deprecated in API level 30.
This call is no longer supported. The caller should keep track of any icons it sets for the task descriptions internally.

Returns
Bitmap The in-memory or loaded icon that represents the current state of this task.

getLabel

Added in API level 21 

public String getLabel ()
Returns
String The label and description of the current state of this task.

getNavigationBarColor

Added in API level 33 

public int getNavigationBarColor ()
Returns
int The color override on the theme's navigation bar color.

getPrimaryColor

Added in API level 21 

public int getPrimaryColor ()
Returns
int The color override on the theme's primary color.

getStatusBarColor

Added in API level 33 

public int getStatusBarColor ()
Returns
int The color override on the theme's status bar color.

readFromParcel

Added in API level 21 

public void readFromParcel (Parcel source)
Parameters
source Parcel

toString

Added in API level 21 

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: 

 getClass().getName() + '@' + Integer.toHexString(hashCode())
Returns
String a string representation of the object.

writeToParcel

Added in API level 21 

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written. 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 2023-02-08 UTC.