EmbeddedPhotoPickerFeatureInfo


class EmbeddedPhotoPickerFeatureInfo : Parcelable
kotlin.Any
   ↳ android.widget.photopicker.EmbeddedPhotoPickerFeatureInfo

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

Callers should use Builder to set the desired features.

Summary

Nested classes

Inherited constants
Public methods
Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

Long

String

Returns the highlight album set by the app

String

Returns the highlight media text query set by the app

Int

Returns the highlight type set by the app

Int

MutableList<String!>

MutableList<Uri!>

Int

Boolean

Boolean

Returns whether or not the picker was launched in expanded state

String

Returns a string representation of the object.

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<EmbeddedPhotoPickerFeatureInfo!>

Public methods

describeContents

Added in API level 36
fun describeContents(): Int

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 writeToParcel(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

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

getAccentColor

fun getAccentColor(): Long

getHighlightAlbumId

fun getHighlightAlbumId(): String

Returns the highlight album set by the app

Return
String This value cannot be null.

getHighlightSearchMediaTextQuery

fun getHighlightSearchMediaTextQuery(): String

Returns the highlight media text query set by the app

Return
String This value cannot be null.

getHighlightType

fun getHighlightType(): Int

Returns the highlight type set by the app

getMaxSelectionLimit

fun getMaxSelectionLimit(): Int

getMimeTypes

fun getMimeTypes(): MutableList<String!>
Return
MutableList<String!> This value cannot be null.

getPreSelectedUris

fun getPreSelectedUris(): MutableList<Uri!>
Return
MutableList<Uri!> This value cannot be null.

getThemeNightMode

fun getThemeNightMode(): Int

isOrderedSelection

fun isOrderedSelection(): Boolean

isPickerLaunchedInExpandedState

fun isPickerLaunchedInExpandedState(): Boolean

Returns whether or not the picker was launched in expanded state

toString

Added in API level 36
fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.

writeToParcel

Added in API level 36
fun writeToParcel(
    dest: Parcel,
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest Parcel: 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 the following:

Properties

CREATOR

static val CREATOR: Parcelable.Creator<EmbeddedPhotoPickerFeatureInfo!>