blob: bbdd7860f11f6741906350cd86a04fae313b4c6c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
// Copyright 2015 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.
#ifndef COMPONENTS_NTP_TILES_POPULAR_SITES_H_
#define COMPONENTS_NTP_TILES_POPULAR_SITES_H_
#include <map>
#include <string>
#include <vector>
#include "base/callback.h"
#include "base/macros.h"
#include "base/strings/string16.h"
#include "components/ntp_tiles/section_type.h"
#include "components/ntp_tiles/tile_title_source.h"
#include "url/gurl.h"
namespace base {
class ListValue;
}
namespace ntp_tiles {
// Interface to provide a list of suggested popular sites, for display on the
// NTP when there are not enough personalized tiles.
class PopularSites {
public:
struct Site {
Site(const base::string16& title,
const GURL& url,
const GURL& favicon_url,
const GURL& large_icon_url,
TileTitleSource title_source);
Site(const Site& other);
~Site();
base::string16 title;
GURL url;
GURL favicon_url;
GURL large_icon_url;
TileTitleSource title_source;
bool baked_in;
int default_icon_resource; // < 0 if there is none. Used for popular sites.
};
using SitesVector = std::vector<Site>;
using FinishedCallback = base::OnceCallback<void(bool /* success */)>;
virtual ~PopularSites() = default;
// May start the process of retrieving popular sites. If an actual download
// gets triggered, returns true and invokes |callback| with the result, on the
// same thread as the caller. Never invokes |callback| before returning
// control to the caller.
//
// If the result is immediately known and hence no download is triggered, the
// function returns false and the callback will never be executed.
//
// Set |force_download| to enforce re-downloading the popular sites JSON, even
// if it already exists in cache.
//
// Must be called at most once on a given PopularSites object.
virtual bool MaybeStartFetch(bool force_download,
FinishedCallback callback) = 0;
// Returns the cached list of available sections and their sites.
virtual const std::map<SectionType, SitesVector>& sections() const = 0;
// Various internals exposed publicly for diagnostic pages only.
virtual GURL GetLastURLFetched() const = 0;
virtual GURL GetURLToFetch() = 0;
virtual std::string GetDirectoryToFetch() = 0;
virtual std::string GetCountryToFetch() = 0;
virtual std::string GetVersionToFetch() = 0;
virtual const base::ListValue* GetCachedJson() = 0;
};
} // namespace ntp_tiles
#endif // COMPONENTS_NTP_TILES_POPULAR_SITES_H_
|
