🏠 Extract the ContentSuggestionManager interface from NTP

chrome/android/java/src/org/chromium/chrome/browser/suggestions/SuggestionsUiDelegate.java

+// Copyright 2017 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package org.chromium.chrome.browser.suggestions;
+
+import android.support.annotation.Nullable;
+
+import org.chromium.base.Callback;
+import org.chromium.chrome.browser.favicon.FaviconHelper.FaviconImageCallback;
+import org.chromium.chrome.browser.favicon.FaviconHelper.IconAvailabilityCallback;
+import org.chromium.chrome.browser.favicon.LargeIconBridge.LargeIconCallback;
+import org.chromium.chrome.browser.ntp.NewTabPage.DestructionObserver;
+import org.chromium.chrome.browser.ntp.snippets.SuggestionsSource;
+
+import java.util.Set;
+
+/**
+ * Interface between the suggestion surface and the rest of the browser.
+ */
+public interface SuggestionsUiDelegate {

[Bernhard Bauer, 2017/01/16 11:08:37]

I like how small this interface is becoming :)

+    // Dependency injection

[Michael van Ouwerkerk, 2017/01/16 15:31:15]

Is your plan to inject these dependencies directly in a future CL? If so, please
add a TODO for that.

[dgn, 2017/01/18 16:22:27]

Done.

+
+    /**
+     * Returns the SuggestionsSource or {@code null} if it doesn't exist. The SuggestionsSource is
+     * invalidated (has destroy() called) when the suggestion surface is destroyed so use this
+     * method instead of keeping your own reference.
+     */
+    @Nullable
+    SuggestionsSource getSuggestionsSource();
+
+    /**
+     * Returns the MetricsReporter or {@code null} if it doesn't exist. The
+     * SuggestionsMetricsReporter is invalidated (has destroy() called) when the suggestion surface
+     * is destroyed so use this method instead of keeping your own reference.
+     */
+    @Nullable
+    SuggestionsMetricsReporter getMetricsReporter();
+
+    /**
+     * Returns the NavigationDelegate or {@code null} if it doesn't exist. The
+     * SuggestionsNavigationDelegate is invalidated (has destroy() called) when the suggestion
+     * surface is destroyed so use this method instead of keeping your own reference.
+     */
+    @Nullable
+    SuggestionsNavigationDelegate getNavigationDelegate();
+
+    // Favicons
+
+    /**
+     * Checks if an icon with the given URL is available. If not,
+     * downloads it and stores it as a favicon/large icon for the given {@code pageUrl}.
+     * @param pageUrl The URL of the site whose icon is being requested.
+     * @param iconUrl The URL of the favicon/large icon.
+     * @param isLargeIcon Whether the {@code iconUrl} represents a large icon or favicon.
+     * @param callback The callback to be notified when the favicon has been checked.
+     */
+    void ensureIconIsAvailable(String pageUrl, String iconUrl, boolean isLargeIcon,
+            boolean isTemporary, IconAvailabilityCallback callback);
+
+    /**
+     * Gets the large icon (e.g. favicon or touch icon) for a given URL.
+     * @param url The URL of the site whose icon is being requested.
+     * @param size The desired size of the icon in pixels.
+     * @param callback The callback to be notified when the icon is available.
+     */
+    void getLargeIconForUrl(String url, int size, LargeIconCallback callback);
+
+    /**
+     * Gets the favicon image for a given URL.
+     * @param url The URL of the site whose favicon is being requested.
+     * @param size The desired size of the favicon in pixels.
+     * @param faviconCallback The callback to be notified when the favicon is available.
+     */
+    void getLocalFaviconImageForURL(String url, int size, FaviconImageCallback faviconCallback);
+
+    // Feature/State checks
+
+    /**
+     * Registers a {@link DestructionObserver}, notified when the New Tab Page goes away.
+     */
+    void addDestructionObserver(DestructionObserver destructionObserver);
+
+    // Offline
+
+    /**
+     * Checks if the pages with the given URLs are available offline.
+     * @param pageUrls The URLs of the sites whose offline availability is requested.
+     * @param callback Fired when the results are available.
+     */
+    void getUrlsAvailableOffline(Set<String> pageUrls, Callback<Set<String>> callback);
+}