Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [U Extensions 15](https://developer.android.com/sdkExtensions) Summary: [Nested Classes](https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#nestedclasses) \| [Constants](https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#constants) \| [Inherited Constants](https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#inhconstants) \| [Fields](https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#lfields) \| [Methods](https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#inhmethods)

# EmbeddedPhotoPickerFeatureInfo

*** ** * ** ***


`
public

final

class
EmbeddedPhotoPickerFeatureInfo
`


`

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.widget.photopicker.EmbeddedPhotoPickerFeatureInfo |

<br />

*** ** * ** ***

An immutable parcel to carry information regarding desired features of caller for
a given session.

Below features are currently supported in embedded photopicker.

- Mime type to filter media
- Accent color to change color of primary picker element
- Ordered selection of media items
- Max selection media count restriction
- Pre-selected uris
- Theme night mode
- Highlighting media results based on a given input query including highlighting media results from certain albums
- Location metadata request
- Selection options for media items
- UI customization options for the embedded photo picker

Callers should use `https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo.Builder` to set the desired features.

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo.Builder` |

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#TAB_ALBUMS` Constant to indicate the Albums tab as the launch tab. |
| `int` | `https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#TAB_IMAGES` Constant to indicate the Photos tab as the launch tab. |
| `int` | `https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#TAB_UNSET` Constant to indicate default tab when no tab has been set as the launch tab. |

| ### 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/widget/photopicker/EmbeddedPhotoPickerFeatureInfo>` | `https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#CREATOR` |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` long` | ` https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#getAccentColor()() ` |
| ` https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerUiCustomizationParams` | ` https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#getEmbeddedUiCustomizationParams()() ` Returns the embedded-specific UI customization options set by the app. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#getHighlightAlbumId()() ` Returns the highlight album set by the app |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#getHighlightSearchMediaTextQuery()() ` Returns the highlight media text query set by the app |
| ` int` | ` https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#getHighlightType()() ` Returns the highlight type set by the app |
| ` int` | ` https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#getLaunchTab()() ` Returns the launch tab set by the app. |
| ` int` | ` https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#getMaxSelectionLimit()() ` |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/java/lang/String>` | ` https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#getMimeTypes()() ` |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/net/Uri>` | ` https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#getPreSelectedUris()() ` |
| ` https://developer.android.com/reference/android/widget/photopicker/PhotoPickerSelectionParams` | ` https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#getSelectionParams()() ` Returns the selection options, which specify filters for media item properties. |
| ` int` | ` https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#getThemeNightMode()() ` |
| ` https://developer.android.com/reference/android/widget/photopicker/PhotoPickerUiCustomizationParams` | ` https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#getUiCustomizationParams()() ` *This method was deprecated in API level 37.1. Use `https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#getEmbeddedUiCustomizationParams()` instead.* |
| ` boolean` | ` https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#isCollapsedModeScrollingEnabled()() ` Returns whether the app enabled scrolling in collapsed mode. |
| ` boolean` | ` https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#isLocationMetadataRequested()() ` Returns whether the app is requesting location metadata for selected media items. |
| ` boolean` | ` https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#isOrderedSelection()() ` |
| ` boolean` | ` https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#isPickerLaunchedInExpandedState()() ` Returns whether or not the picker was launched in expanded state |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#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

### TAB_ALBUMS

Added in [version 37.1](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [U Extensions 23](https://developer.android.com/sdkExtensions)

```
public static final int TAB_ALBUMS
```

Constant to indicate the Albums tab as the launch tab.

<br />

Constant Value:

0
(0x00000000)


### TAB_IMAGES

Added in [version 37.1](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [U Extensions 23](https://developer.android.com/sdkExtensions)

```
public static final int TAB_IMAGES
```

Constant to indicate the Photos tab as the launch tab.

<br />

Constant Value:

1
(0x00000001)


### TAB_UNSET

Added in [version 37.1](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [U Extensions 23](https://developer.android.com/sdkExtensions)

```
public static final int TAB_UNSET
```

Constant to indicate default tab when no tab has been set as the launch tab.

<br />

Constant Value:

-1
(0xffffffff)


## Fields

### CREATOR

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

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

<br />

<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` |

### getAccentColor

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

```
public long getAccentColor ()
```

<br />

<br />

| Returns ||
|---|---|
| `long` | <br /> |

### getEmbeddedUiCustomizationParams

Added in [version 37.1](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [U Extensions 23](https://developer.android.com/sdkExtensions)

```
public EmbeddedPhotoPickerUiCustomizationParams getEmbeddedUiCustomizationParams ()
```

Returns the embedded-specific UI customization options set by the app.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerUiCustomizationParams` | The `https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerUiCustomizationParams` object, or `null` if no custom embedded options are set. <br /> |

### getHighlightAlbumId

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [U Extensions 19](https://developer.android.com/sdkExtensions)

```
public String getHighlightAlbumId ()
```

Returns the highlight album set by the app

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value cannot be `null`. <br /> |

### getHighlightSearchMediaTextQuery

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [U Extensions 19](https://developer.android.com/sdkExtensions)

```
public String getHighlightSearchMediaTextQuery ()
```

Returns the highlight media text query set by the app

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value cannot be `null`. <br /> |

### getHighlightType

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [U Extensions 21](https://developer.android.com/sdkExtensions)

```
public int getHighlightType ()
```

Returns the highlight type set by the app

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### getLaunchTab

Added in [version 37.1](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [U Extensions 23](https://developer.android.com/sdkExtensions)

```
public int getLaunchTab ()
```

Returns the launch tab set by the app.

<br />

| Returns ||
|---|---|
| `int` | The launch tab for the embedded PhotoPicker, which is one of the `https://developer.android.com/` values (e.g., `https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#TAB_IMAGES` or `https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#TAB_ALBUMS`). If no launch tab is set then `https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#TAB_UNSET` is the default value. Value is one of the following: - `https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#TAB_UNSET` - `https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#TAB_ALBUMS` - `https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#TAB_IMAGES` |

### getMaxSelectionLimit

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

```
public int getMaxSelectionLimit ()
```

<br />

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### getMimeTypes

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

```
public List<String> getMimeTypes ()
```

<br />

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/java/lang/String>` | This value cannot be `null`. <br /> |

### getPreSelectedUris

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

```
public List<Uri> getPreSelectedUris ()
```

<br />

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/net/Uri>` | This value cannot be `null`. <br /> |

### getSelectionParams

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [U Extensions 22](https://developer.android.com/sdkExtensions)

```
public PhotoPickerSelectionParams getSelectionParams ()
```

Returns the selection options, which specify filters for media item properties.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/widget/photopicker/PhotoPickerSelectionParams` | The `https://developer.android.com/reference/android/widget/photopicker/PhotoPickerSelectionParams` object containing the selection filters, or `null` if no custom selection options are set. <br /> |

### getThemeNightMode

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

```
public int getThemeNightMode ()
```

<br />

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### getUiCustomizationParams

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [U Extensions 22](https://developer.android.com/sdkExtensions)   
Deprecated in [API level
37.1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public PhotoPickerUiCustomizationParams getUiCustomizationParams ()
```


**This method was deprecated
in API level 37.1.**   

Use `https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo#getEmbeddedUiCustomizationParams()` instead.

Returns the ui customization options set by the app.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/widget/photopicker/PhotoPickerUiCustomizationParams` | The `https://developer.android.com/reference/android/widget/photopicker/PhotoPickerUiCustomizationParams` object containing the ui customization options, or `null` if no custom options are set. <br /> |

### isCollapsedModeScrollingEnabled

Added in [version 37.1](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [U Extensions 23](https://developer.android.com/sdkExtensions)

```
public boolean isCollapsedModeScrollingEnabled ()
```

Returns whether the app enabled scrolling in collapsed mode.

<br />

| Returns ||
|---|---|
| `boolean` | `true` if the app enabled scrolling in collapsed mode, `false` otherwise. <br /> |

### isLocationMetadataRequested

Added in [version 37.1](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [U Extensions 23](https://developer.android.com/sdkExtensions)

```
public boolean isLocationMetadataRequested ()
```

Returns whether the app is requesting location metadata for selected media items.

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

### isOrderedSelection

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

```
public boolean isOrderedSelection ()
```

<br />

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

### isPickerLaunchedInExpandedState

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [U Extensions 21](https://developer.android.com/sdkExtensions)

```
public boolean isPickerLaunchedInExpandedState ()
```

Returns whether or not the picker was launched in expanded state

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

### toString

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