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

# MetadataResult

*** ** * ** ***

` public final class MetadataResult `   
` 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.settings.preferences.MetadataResult |

<br />

*** ** * ** ***

Result object given a corresponding `https://developer.android.com/reference/android/service/settings/preferences/MetadataRequest`.

- If the request was successful, `https://developer.android.com/reference/android/service/settings/preferences/MetadataResult#getResultCode()` will be `https://developer.android.com/reference/android/service/settings/preferences/MetadataResult#RESULT_OK` and `https://developer.android.com/reference/android/service/settings/preferences/MetadataResult#getMetadataList()` will be populated with metadata for all available preferences within this application.
- If the request is unsuccessful, `https://developer.android.com/reference/android/service/settings/preferences/MetadataResult#getResultCode()` be a value other than `https://developer.android.com/reference/android/service/settings/preferences/MetadataResult#RESULT_OK` - see documentation for those possibilities to understand the cause of the failure.

<br />

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/service/settings/preferences/MetadataResult.Builder` Builder to construct `https://developer.android.com/reference/android/service/settings/preferences/MetadataResult`. |

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/service/settings/preferences/MetadataResult#RESULT_INTERNAL_ERROR` API call failed due to an issue with the service binding. |
| `int` | `https://developer.android.com/reference/android/service/settings/preferences/MetadataResult#RESULT_OK` Request is successful. |
| `int` | `https://developer.android.com/reference/android/service/settings/preferences/MetadataResult#RESULT_UNSUPPORTED` No preferences in this application support this API. |

### 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/settings/preferences/MetadataResult>` | `https://developer.android.com/reference/android/service/settings/preferences/MetadataResult#CREATOR` Parcelable Creator for `https://developer.android.com/reference/android/service/settings/preferences/MetadataResult`. |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/service/settings/preferences/MetadataResult#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata>` | ` https://developer.android.com/reference/android/service/settings/preferences/MetadataResult#getMetadataList()() ` Returns the list of available Preference Metadata. |
| ` int` | ` https://developer.android.com/reference/android/service/settings/preferences/MetadataResult#getResultCode()() ` Returns the result code indicating status of the request. |
| ` void` | ` https://developer.android.com/reference/android/service/settings/preferences/MetadataResult#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.

## Constants

### RESULT_INTERNAL_ERROR

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

```
public static final int RESULT_INTERNAL_ERROR
```

API call failed due to an issue with the service binding.

Retry may succeed.

<br />

Constant Value: 2 (0x00000002)

### RESULT_OK

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

```
public static final int RESULT_OK
```

Request is successful.

<br />

Constant Value: 0 (0x00000000)

### RESULT_UNSUPPORTED

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

```
public static final int RESULT_UNSUPPORTED
```

No preferences in this application support this API.

Retry not advised.

<br />

Constant Value: 1 (0x00000001)

## Fields

### CREATOR

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

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

Parcelable Creator for `https://developer.android.com/reference/android/service/settings/preferences/MetadataResult`.

<br />

## Public methods

### describeContents

Added in [API level 36](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` |

### getMetadataList

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

```
public List<SettingsPreferenceMetadata> getMetadataList ()
```

Returns the list of available Preference Metadata.

This instance is shared so this list should not be modified.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata>` | <br /> |

### getResultCode

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

```
public int getResultCode ()
```

Returns the result code indicating status of the request.

<br />

| Returns ||
|---|---|
| `int` | Value is one of the following: - `https://developer.android.com/reference/android/service/settings/preferences/MetadataResult#RESULT_OK` - `https://developer.android.com/reference/android/service/settings/preferences/MetadataResult#RESULT_UNSUPPORTED` - `https://developer.android.com/reference/android/service/settings/preferences/MetadataResult#RESULT_INTERNAL_ERROR` |

### writeToParcel

Added in [API level 36](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` |