OLD | NEW |
1 // Copyright 2016 The Chromium Authors. All rights reserved. | 1 // Copyright 2016 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef COMPONENTS_NTP_SNIPPETS_CONTENT_SUGGESTION_H_ | 5 #ifndef COMPONENTS_NTP_SNIPPETS_CONTENT_SUGGESTION_H_ |
6 #define COMPONENTS_NTP_SNIPPETS_CONTENT_SUGGESTION_H_ | 6 #define COMPONENTS_NTP_SNIPPETS_CONTENT_SUGGESTION_H_ |
7 | 7 |
8 #include <memory> | 8 #include <memory> |
9 #include <string> | 9 #include <string> |
10 #include <vector> | 10 #include <vector> |
11 | 11 |
12 #include "base/macros.h" | 12 #include "base/macros.h" |
13 #include "base/time/time.h" | 13 #include "base/time/time.h" |
14 #include "components/ntp_snippets/content_suggestion_category.h" | |
15 #include "components/ntp_snippets/content_suggestions_provider_type.h" | |
16 #include "url/gurl.h" | 14 #include "url/gurl.h" |
17 | 15 |
18 namespace ntp_snippets { | 16 namespace ntp_snippets { |
19 | 17 |
20 // A content suggestion for the new tab page, which can be an article or an | 18 // A content suggestion for the new tab page, which can be an article or an |
21 // offline page, for example. | 19 // offline page, for example. |
22 // NOTE: This class is not yet in use, please use NTPSnippet for now | 20 // NOTE: This class is not yet in use, please use NTPSnippet for now |
23 // (see ntp_snippet.h). | 21 // (see ntp_snippet.h). |
24 class ContentSuggestion { | 22 class ContentSuggestion { |
25 public: | 23 public: |
| 24 // Creates a new ContentSuggestion. The caller must ensure that the |id| |
| 25 // passed in here is unique application-wide. |
26 ContentSuggestion(const std::string& id, | 26 ContentSuggestion(const std::string& id, |
27 const ContentSuggestionsProviderType provider, | |
28 const ContentSuggestionCategory category, | |
29 const GURL& url); | 27 const GURL& url); |
| 28 ContentSuggestion(ContentSuggestion&&); |
| 29 ContentSuggestion& operator=(ContentSuggestion&&); |
30 | 30 |
31 ~ContentSuggestion(); | 31 ~ContentSuggestion(); |
32 | 32 |
33 // An ID for identifying the suggestion. The ID is unique among all | 33 // An ID for identifying the suggestion. The ID is unique application-wide. |
34 // suggestions from the same provider, so to determine a globally unique | |
35 // identifier, combine this ID with the provider type. | |
36 const std::string& id() const { return id_; } | 34 const std::string& id() const { return id_; } |
37 | 35 |
38 // The provider that created this suggestion. | |
39 ContentSuggestionsProviderType provider() const { return provider_; } | |
40 | |
41 // The category that this suggestion belongs to. | |
42 ContentSuggestionCategory category() const { return category_; } | |
43 | |
44 // The normal content URL where the content referenced by the suggestion can | 36 // The normal content URL where the content referenced by the suggestion can |
45 // be accessed. | 37 // be accessed. |
46 const GURL& url() const { return url_; } | 38 const GURL& url() const { return url_; } |
47 | 39 |
48 // If available, this contains an URL to an AMP version of the same content. | 40 // If available, this contains an URL to an AMP version of the same content. |
49 // Otherwise, this is an empty GURL(). | 41 // Otherwise, this is an empty GURL(). |
50 const GURL& amp_url() const { return amp_url_; } | 42 const GURL& amp_url() const { return amp_url_; } |
51 void set_amp_url(const GURL& amp_url) { amp_url_ = amp_url; } | 43 void set_amp_url(const GURL& amp_url) { amp_url_ = amp_url; } |
52 | 44 |
53 // Title of the suggestion. | 45 // Title of the suggestion. |
(...skipping 11 matching lines...) Expand all Loading... |
65 void set_publish_date(const base::Time& publish_date) { | 57 void set_publish_date(const base::Time& publish_date) { |
66 publish_date_ = publish_date; | 58 publish_date_ = publish_date; |
67 } | 59 } |
68 | 60 |
69 // The name of the source/publisher of this suggestion. | 61 // The name of the source/publisher of this suggestion. |
70 const std::string& publisher_name() const { return publisher_name_; } | 62 const std::string& publisher_name() const { return publisher_name_; } |
71 void set_publisher_name(const std::string& publisher_name) { | 63 void set_publisher_name(const std::string& publisher_name) { |
72 publisher_name_ = publisher_name; | 64 publisher_name_ = publisher_name; |
73 } | 65 } |
74 | 66 |
75 // TODO(pke) Remove the score from the ContentSuggestion class. The UI only | 67 // TODO(pke): Remove the score from the ContentSuggestion class. The UI only |
76 // uses it to track user clicks (histogram data). Instead, the providers | 68 // uses it to track user clicks (histogram data). Instead, the providers |
77 // should be informed about clicks and do appropriate logging themselves. | 69 // should be informed about clicks and do appropriate logging themselves. |
78 // IMPORTANT: The score may simply be 0 for suggestions from providers which | 70 // IMPORTANT: The score may simply be 0 for suggestions from providers which |
79 // cannot provide score values. | 71 // cannot provide score values. |
80 float score() const { return score_; } | 72 float score() const { return score_; } |
81 void set_score(float score) { score_ = score; } | 73 void set_score(float score) { score_ = score; } |
82 | 74 |
83 private: | 75 private: |
84 std::string id_; | 76 std::string id_; |
85 ContentSuggestionsProviderType provider_; | |
86 ContentSuggestionCategory category_; | |
87 GURL url_; | 77 GURL url_; |
88 GURL amp_url_; | 78 GURL amp_url_; |
89 std::string title_; | 79 std::string title_; |
90 std::string snippet_text_; | 80 std::string snippet_text_; |
91 GURL salient_image_url_; | 81 GURL salient_image_url_; |
92 base::Time publish_date_; | 82 base::Time publish_date_; |
93 std::string publisher_name_; | 83 std::string publisher_name_; |
94 float score_; | 84 float score_; |
95 | 85 |
96 DISALLOW_COPY_AND_ASSIGN(ContentSuggestion); | 86 DISALLOW_COPY_AND_ASSIGN(ContentSuggestion); |
97 }; | 87 }; |
98 | 88 |
99 } // namespace ntp_snippets | 89 } // namespace ntp_snippets |
100 | 90 |
101 #endif // COMPONENTS_NTP_SNIPPETS_CONTENT_SUGGESTION_H_ | 91 #endif // COMPONENTS_NTP_SNIPPETS_CONTENT_SUGGESTION_H_ |
OLD | NEW |