MediaBrowserService: Add more explanation on getBrowserRootHints()

Bug: 28840985
Change-Id: If4dbcaaa23093b2e6d5ab6158db67b1248464fb8
This commit is contained in:
Jae Seo
2016-05-19 14:17:27 -07:00
parent 2486cb2c89
commit bd6c16908d

View File

@@ -489,9 +489,15 @@ public abstract class MediaBrowserService extends Service {
/**
* Gets the root hints sent from the currently connected {@link MediaBrowser}.
* The root hints are service-specific arguments included in an optional bundle sent to the
* media browser service when connecting and retrieving the root id for browsing, or null if
* none. The contents of this bundle may affect the information returned when browsing.
*
* @throws IllegalStateException If this method is called outside of {@link #onLoadChildren}
* or {@link #onLoadItem}
* @see MediaBrowserService.BrowserRoot#EXTRA_RECENT
* @see MediaBrowserService.BrowserRoot#EXTRA_OFFLINE
* @see MediaBrowserService.BrowserRoot#EXTRA_SUGGESTED
*/
public final Bundle getBrowserRootHints() {
if (mCurConnection == null) {