TaskDescription

Kotlin |Java

open class TaskDescription : Parcelable

kotlin.Any
↳	android.app.ActivityManager.TaskDescription

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

Summary

Nested classes
	`Builder` Provides a convenient way to set the fields of a `TaskDescription` when creating a new instance.

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 constructors
`TaskDescription()` Creates an empty TaskDescription.
`TaskDescription(td: ActivityManager.TaskDescription!)` Creates a copy of another TaskDescription.
`TaskDescription(label: String!)` Creates the TaskDescription to the specified values.
`TaskDescription(label: String!, icon: Bitmap!)` Creates the TaskDescription to the specified values.
`TaskDescription(label: String!, icon: Bitmap!, colorPrimary: Int)` Creates the TaskDescription to the specified values.
`TaskDescription(label: String!, iconRes: Int)` Creates the TaskDescription to the specified values.
`TaskDescription(label: String!, iconRes: Int, colorPrimary: Int)` Creates the TaskDescription to the specified values.

Public methods
open Int	`describeContents()`
open Boolean	`equals(other: Any?)` Indicates whether some other object is "equal to" this one.
open Int	`getBackgroundColor()`
open Bitmap!	`getIcon()`
open String!	`getLabel()`
open Int	`getNavigationBarColor()`
open Int	`getPrimaryColor()`
open Int	`getStatusBarColor()`
open Int	`hashCode()`
open Unit	`readFromParcel(source: Parcel!)`
open String	`toString()`
open Unit	`writeToParcel(dest: Parcel, flags: Int)`

Properties
static Parcelable.Creator<ActivityManager.TaskDescription!>	`CREATOR`

Public constructors

TaskDescription

Added in API level 21

TaskDescription()

Deprecated: Use Builder instead.

Creates an empty TaskDescription.

TaskDescription

Added in API level 21

TaskDescription(td: ActivityManager.TaskDescription!)

Creates a copy of another TaskDescription.

TaskDescription

Added in API level 21

TaskDescription(label: String!)

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

TaskDescription(
    label: String!, 
    icon: Bitmap!)

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

TaskDescription(
    label: String!, 
    icon: Bitmap!, 
    colorPrimary: Int)

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 28

TaskDescription(
    label: String!, 
    iconRes: Int)

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 28

TaskDescription(
    label: String!, 
    iconRes: Int, 
    colorPrimary: Int)

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.

Public methods

describeContents

Added in API level 21

open fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level 21

open 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`	This value may be `null`.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getBackgroundColor

Added in API level 33

open fun getBackgroundColor(): Int

Return
`Int`	The color override on the theme's background color.

getIcon

Added in API level 21
Deprecated in API level 30

open fun getIcon(): Bitmap!

Deprecated: This call is no longer supported. The caller should keep track of any icons it sets for the task descriptions internally.

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

getLabel

Added in API level 21

open fun getLabel(): String!

Return
`String!`	The label and description of the current state of this task.

getNavigationBarColor

Added in API level 33

open fun getNavigationBarColor(): Int

Return
`Int`	The color override on the theme's navigation bar color.

getPrimaryColor

Added in API level 21

open fun getPrimaryColor(): Int

Return
`Int`	The color override on the theme's primary color.

getStatusBarColor

Added in API level 33

open fun getStatusBarColor(): Int

Return
`Int`	The color override on the theme's status bar color.

hashCode

Added in API level 21

open fun hashCode(): Int

Return
`Int`	a hash code value for this object.

readFromParcel

Added in API level 21

open fun readFromParcel(source: Parcel!): Unit

toString

Added in API level 21

open fun toString(): String

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 21

open fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

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_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 21

static val CREATOR: Parcelable.Creator<ActivityManager.TaskDescription!>