Added in [API level 27](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/service/autofill/CustomDescription#nestedclasses) \| [Inherited Constants](https://developer.android.com/reference/android/service/autofill/CustomDescription#inhconstants) \| [Fields](https://developer.android.com/reference/android/service/autofill/CustomDescription#lfields) \| [Methods](https://developer.android.com/reference/android/service/autofill/CustomDescription#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/service/autofill/CustomDescription#inhmethods)

# CustomDescription

*** ** * ** ***

` public final class CustomDescription `   
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/android/os/Parcelable `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.service.autofill.CustomDescription |

<br />

*** ** * ** ***

Defines a custom description for the autofill save UI.

This is useful when the autofill service needs to show a detailed view of what would be saved; for example, when the screen contains a credit card, it could display a logo of the credit card bank, the last four digits of the credit card number, and its expiration number.

A custom description is made of 2 parts:

- A `https://developer.android.com/reference/android/widget/RemoteViews` containing children views.
- `https://developer.android.com/reference/android/service/autofill/Transformation` to populate the children views.

For the credit card example mentioned above, the (simplified) template would be:

```
<LinearLayout>
  <ImageView android:id="@+id/templateccLogo"/>
  <TextView android:id="@+id/templateCcNumber"/>
  <TextView android:id="@+id/templateExpDate"/>
</LinearLayout>
```

Which in code translates to:

```
  CustomDescription.Builder buider = new Builder(new RemoteViews(pgkName, R.layout.cc_template);
```

Then the value of each of the 3 children would be changed at runtime based on the the value of the screen fields and the `https://developer.android.com/reference/android/service/autofill/Transformation`:

```
// Image child - different logo for each bank, based on credit card prefix
builder.addChild(R.id.templateccLogo,
  new ImageTransformation.Builder(ccNumberId)
    .addOption(Pattern.compile("^4815.*$"), R.drawable.ic_credit_card_logo1)
    .addOption(Pattern.compile("^1623.*$"), R.drawable.ic_credit_card_logo2)
    .addOption(Pattern.compile("^42.*$"), R.drawable.ic_credit_card_logo3)
    .build();
// Masked credit card number (as .....LAST_4_DIGITS)
builder.addChild(R.id.templateCcNumber, new CharSequenceTransformation
    .Builder(ccNumberId, Pattern.compile("^.*(\\d\\d\\d\\d)$"), "...$1")
    .build();
// Expiration date as MM / YYYY:
builder.addChild(R.id.templateExpDate, new CharSequenceTransformation
    .Builder(ccExpMonthId, Pattern.compile("^(\\d\\d)$"), "Exp: $1")
    .addField(ccExpYearId, Pattern.compile("^(\\d\\d)$"), "/$1")
    .build();
```

See `https://developer.android.com/reference/android/service/autofill/ImageTransformation`, `https://developer.android.com/reference/android/service/autofill/CharSequenceTransformation` for more info about these transformations.

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/service/autofill/CustomDescription.Builder` Builder for `https://developer.android.com/reference/android/service/autofill/CustomDescription` objects. |

### Inherited constants

From interface `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`

Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`

Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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 https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/service/autofill/CustomDescription>` | `https://developer.android.com/reference/android/service/autofill/CustomDescription#CREATOR` <br /> |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/service/autofill/CustomDescription#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/service/autofill/CustomDescription#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/service/autofill/CustomDescription#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/android/os/Parcelable ` ` abstract int` ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() `

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
` abstract void` ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) `

Flatten this object in to a Parcel.

## Fields

### CREATOR

Added in [API level 27](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<CustomDescription> CREATOR
```

<br />

<br />

## Public methods

### describeContents

Added in [API level 27](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`, the return value of this method must include the `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### toString

Added in [API level 27](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

Returns a string representation of the object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |

### writeToParcel

Added in [API level 27](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: The Parcel in which the object should be written. This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |