MetadataResult

Kotlin |Java

class MetadataResult : Parcelable

kotlin.Any
↳	android.service.settings.preferences.MetadataResult

Result object given a corresponding MetadataRequest.

If the request was successful, getResultCode will be RESULT_OK and getMetadataList will be populated with metadata for all available preferences within this application.
If the request is unsuccessful, getResultCode be a value other than RESULT_OK - see documentation for those possibilities to understand the cause of the failure.

Summary

Nested classes
	`Builder` Builder to construct `MetadataResult`.

Constants
static Int	`RESULT_INTERNAL_ERROR` API call failed due to an issue with the service binding.
static Int	`RESULT_OK` Request is successful.
static Int	`RESULT_UNSUPPORTED` No preferences in this application support this API.

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 methods
MutableList<SettingsPreferenceMetadata!>	`getMetadataList()` Returns the list of available Preference Metadata.
Int	`getResultCode()` Returns the result code indicating status of the request.

Properties
static Parcelable.Creator<MetadataResult!>	`CREATOR` Parcelable Creator for `MetadataResult`.

Constants

RESULT_INTERNAL_ERROR

Added in API level 36

static val RESULT_INTERNAL_ERROR: Int

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

Retry may succeed.

Value: 2

RESULT_OK

Added in API level 36

static val RESULT_OK: Int

Request is successful.

Value: 0

RESULT_UNSUPPORTED

Added in API level 36

static val RESULT_UNSUPPORTED: Int

No preferences in this application support this API.

Retry not advised.

Value: 1

Public methods

getMetadataList

Added in API level 36

fun getMetadataList(): MutableList<SettingsPreferenceMetadata!>

Returns the list of available Preference Metadata.

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

getResultCode

Added in API level 36

fun getResultCode(): Int

Returns the result code indicating status of the request.

Return
`Int`	Value is `android.service.settings.preferences.MetadataResult#RESULT_OK`, `android.service.settings.preferences.MetadataResult#RESULT_UNSUPPORTED`, or `android.service.settings.preferences.MetadataResult#RESULT_INTERNAL_ERROR`

Properties

CREATOR

Added in API level 36

static val CREATOR: Parcelable.Creator<MetadataResult!>

Parcelable Creator for MetadataResult.