Stay organized with collections
Save and categorize content based on your preferences.
public
static
final
class
CloudMediaProviderContract.SearchSuggestionColumns
extends Object
| java.lang.Object
|
| ↳ |
android.provider.CloudMediaProviderContract.SearchSuggestionColumns
|
Represents a search suggestion provided by the CloudMediaProvider.
This is based on the user entered query.
When the input query is empty (zero state), the provider can still return suggestions.
Photo picker will show these zero state suggestions to the user,
when nothing has been typed for search.
This class contains the fields of SearchSuggestion.
Summary
Inherited methods |
|---|
From class
java.lang.Object
Object
|
clone()
Creates and returns a copy of this object.
|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
void
|
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
final
Class<?>
|
getClass()
Returns the runtime class of this Object.
|
int
|
hashCode()
Returns a hash code value for the object.
|
final
void
|
notify()
Wakes up a single thread that is waiting on this object's
monitor.
|
final
void
|
notifyAll()
Wakes up all threads that are waiting on this object's monitor.
|
String
|
toString()
Returns a string representation of the object.
|
final
void
|
wait(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
|
wait(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
|
wait()
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted.
|
|
Constants
DISPLAY_TEXT
public static final String DISPLAY_TEXT
The display text for the search suggestion.
This is the text shown to the user as a suggestion.
Display text provided should match the current devices locale settings.
If no display text, pass null in this column.
Type: STRING
Constant Value:
"display_text"
public static final String MEDIA_COVER_ID
Media ID to use as the cover image for the search suggestion.
If this field is not provided,
the search suggestion will be shown with a default cover.
Type: LONG
Constant Value:
"media_cover_id"
public static final String MEDIA_SET_ID
The unique identifier of the media set associated with the search suggestion.
This will be used to query media items if user clicked on this suggestion.
Type: STRING
Constant Value:
"media_set_id"
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-03-13 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-13 UTC."],[],[],null,["# CloudMediaProviderContract.SearchSuggestionColumns\n\nAdded in [API level 36](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nAlso in [R Extensions 16](/sdkExtensions) \nSummary: [Constants](#constants) \\| [Inherited Methods](#inhmethods) \n\nCloudMediaProviderContract.SearchSuggestionColumns\n==================================================\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/android/provider/CloudMediaProviderContract.SearchSuggestionColumns \"View this page in Kotlin\") \\|Java\n\n\n`\npublic\nstatic\nfinal\n\nclass\nCloudMediaProviderContract.SearchSuggestionColumns\n`\n\n\n`\n\nextends `[Object](/reference/java/lang/Object)`\n\n\n`\n\n`\n\n\n`\n\n|---|---------------------------------------------------------------------|\n| [java.lang.Object](/reference/java/lang/Object) ||\n| ↳ | android.provider.CloudMediaProviderContract.SearchSuggestionColumns |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nRepresents a search suggestion provided by the [CloudMediaProvider](/reference/android/provider/CloudMediaProvider).\nThis is based on the user entered query.\nWhen the input query is empty (zero state), the provider can still return suggestions.\nPhoto picker will show these zero state suggestions to the user,\nwhen nothing has been typed for search.\n\nThis class contains the fields of SearchSuggestion. \n**See also:**\n\n- [CloudMediaProvider.onQuerySearchSuggestions(String, Bundle, CancellationSignal)](/reference/android/provider/CloudMediaProvider#onQuerySearchSuggestions(java.lang.String,%20android.os.Bundle,%20android.os.CancellationSignal))\n\nSummary\n-------\n\n| ### Constants ||\n|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [String](/reference/java/lang/String) | [DISPLAY_TEXT](/reference/android/provider/CloudMediaProviderContract.SearchSuggestionColumns#DISPLAY_TEXT) The display text for the search suggestion. |\n| [String](/reference/java/lang/String) | [MEDIA_COVER_ID](/reference/android/provider/CloudMediaProviderContract.SearchSuggestionColumns#MEDIA_COVER_ID) Media ID to use as the cover image for the search suggestion. |\n| [String](/reference/java/lang/String) | [MEDIA_SET_ID](/reference/android/provider/CloudMediaProviderContract.SearchSuggestionColumns#MEDIA_SET_ID) The unique identifier of the media set associated with the search suggestion. |\n| [String](/reference/java/lang/String) | [TYPE](/reference/android/provider/CloudMediaProviderContract.SearchSuggestionColumns#TYPE) The type of the search suggestion. |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` `[java.lang.Object](/reference/java/lang/Object)` ` |---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](/reference/java/lang/Object) | ` `[clone](/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](/reference/java/lang/Object)` obj) ` Indicates whether some other object is \"equal to\" this one. | | ` void` | ` `[finalize](/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 `[Class](/reference/java/lang/Class)`\u003c?\u003e` | ` `[getClass](/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this `Object`. | | ` int` | ` `[hashCode](/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](/reference/java/lang/String) | ` `[toString](/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](/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` | ` `[wait](/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` | ` `[wait](/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||\n\nConstants\n---------\n\n### DISPLAY_TEXT\n\nAdded in [API level 36](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nAlso in [R Extensions 16](/sdkExtensions) \n\n```\npublic static final String DISPLAY_TEXT\n```\n\nThe display text for the search suggestion.\n\n\nThis is the text shown to the user as a suggestion.\nDisplay text provided should match the current devices locale settings.\n\nIf no display text, pass `null` in this column.\n\n\nType: STRING\n\n\u003cbr /\u003e\n\nConstant Value:\n\n\"display_text\"\n\n\n### MEDIA_COVER_ID\n\nAdded in [API level 36](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nAlso in [R Extensions 16](/sdkExtensions) \n\n```\npublic static final String MEDIA_COVER_ID\n```\n\nMedia ID to use as the cover image for the search suggestion.\n\n\nIf this field is not provided,\nthe search suggestion will be shown with a default cover.\n\n\nType: LONG\n\n\u003cbr /\u003e\n\nConstant Value:\n\n\"media_cover_id\"\n\n\n### MEDIA_SET_ID\n\nAdded in [API level 36](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nAlso in [R Extensions 16](/sdkExtensions) \n\n```\npublic static final String MEDIA_SET_ID\n```\n\nThe unique identifier of the media set associated with the search suggestion.\nThis will be used to query media items if user clicked on this suggestion.\n\n\nType: STRING\n\n\u003cbr /\u003e\n\n**See also:**\n\n- [CloudMediaProviderContract.MediaSetColumns.ID](/reference/android/provider/CloudMediaProviderContract.MediaSetColumns#ID)\n\nConstant Value:\n\n\"media_set_id\"\n\n\n### TYPE\n\nAdded in [API level 36](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nAlso in [R Extensions 16](/sdkExtensions) \n\n```\npublic static final String TYPE\n```\n\nThe type of the search suggestion.\n\n\nThis must contain one of the values from various supported search suggestion types.\nThese are: [CloudMediaProviderContract.SEARCH_SUGGESTION_TEXT](/reference/android/provider/CloudMediaProviderContract#SEARCH_SUGGESTION_TEXT), [CloudMediaProviderContract.SEARCH_SUGGESTION_FACE](/reference/android/provider/CloudMediaProviderContract#SEARCH_SUGGESTION_FACE),\n[CloudMediaProviderContract.SEARCH_SUGGESTION_DATE](/reference/android/provider/CloudMediaProviderContract#SEARCH_SUGGESTION_DATE), [CloudMediaProviderContract.SEARCH_SUGGESTION_LOCATION](/reference/android/provider/CloudMediaProviderContract#SEARCH_SUGGESTION_LOCATION),\n[CloudMediaProviderContract.SEARCH_SUGGESTION_ALBUM](/reference/android/provider/CloudMediaProviderContract#SEARCH_SUGGESTION_ALBUM)\n\n\nThis will be used to display to user different suggestions in different way.\nAs examples: for Location type, a thumbnail of location will be used.\nFor faces, face cover id (if provided) will be used.\nType: INTEGER\n\n\u003cbr /\u003e\n\nConstant Value:\n\n\"type\""]]
