Language

MediaStore.ExtraPickImagesHighlightSearchResults Field

Definition

The name of an optional intent-extra used to allow apps to highlight search results in the photopicker UI whenever feasible based on the given input text query in MediaStore#KEY_PICK_IMAGES_HIGHLIGHT_SEARCH_TEXT_QUERY The extra can only be specified in MediaStore#ACTION_PICK_IMAGES.

[Android.Runtime.Register("EXTRA_PICK_IMAGES_HIGHLIGHT_SEARCH_RESULTS", ApiSince=36)]
public const string ExtraPickImagesHighlightSearchResults;
[<Android.Runtime.Register("EXTRA_PICK_IMAGES_HIGHLIGHT_SEARCH_RESULTS", ApiSince=36)>]
val mutable ExtraPickImagesHighlightSearchResults : string

Field Value

Attributes

Remarks

The name of an optional intent-extra used to allow apps to highlight search results in the photopicker UI whenever feasible based on the given input text query in MediaStore#KEY_PICK_IMAGES_HIGHLIGHT_SEARCH_TEXT_QUERY The extra can only be specified in MediaStore#ACTION_PICK_IMAGES.

This intent extra will accept a Bundle object. The bundle object should have two keys specified. The first key MediaStore#KEY_PICK_IMAGES_HIGHLIGHT_TYPE will specify the type of media highlight the app wants to opt for and should be one of MediaStore#PICK_IMAGES_HIGHLIGHT_TYPE_COLLAPSED for a highlighted media section to be shown when the photopicker launches or MediaStore#PICK_IMAGES_HIGHLIGHT_TYPE_EXPANDED to open the photopicker to show a highlighted media results grid based on the given input query. Any other value for this key will result in throwing IllegalArgumentException. The second bundle key MediaStore#KEY_PICK_IMAGES_HIGHLIGHT_SEARCH_TEXT_QUERY will accept a string value specifying the query for highlighting media results. If this input value is empty, the request to highlight media will be ignored and no highlight will be shown at all. In case of null input query, IllegalArgumentException is thrown. Highlighting media results of a photopicker album is also supported. See MediaStore#EXTRA_PICK_IMAGES_HIGHLIGHT_ALBUM for more details. Only one of MediaStore#EXTRA_PICK_IMAGES_HIGHLIGHT_SEARCH_RESULTS or MediaStore#EXTRA_PICK_IMAGES_HIGHLIGHT_ALBUM should be used at any given time. Specifying both will result in IllegalArgumentException to be thrown.

Java documentation for android.provider.MediaStore.EXTRA_PICK_IMAGES_HIGHLIGHT_SEARCH_RESULTS.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to