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" | 14 #include "components/ntp_snippets/content_suggestion_category.h" |
15 #include "components/ntp_snippets/content_suggestions_provider_type.h" | |
16 #include "url/gurl.h" | 15 #include "url/gurl.h" |
17 | 16 |
18 namespace ntp_snippets { | 17 namespace ntp_snippets { |
19 | 18 |
20 // A content suggestion for the new tab page, which can be an article or an | 19 // A content suggestion for the new tab page, which can be an article or an |
21 // offline page, for example. | 20 // offline page, for example. |
22 // NOTE: This class is not yet in use, please use NTPSnippet for now | 21 // NOTE: This class is not yet in use, please use NTPSnippet for now |
23 // (see ntp_snippet.h). | 22 // (see ntp_snippet.h). |
24 class ContentSuggestion { | 23 class ContentSuggestion { |
25 public: | 24 public: |
| 25 // This is the constructor that should be used by providers. |
| 26 // The caller must ensure that the |id| passed in here is unique |
| 27 // application-wide. Note: The provider should use its ::MakeUniqueID() |
| 28 // function to create the ID. |
26 ContentSuggestion(const std::string& id, | 29 ContentSuggestion(const std::string& id, |
27 const ContentSuggestionsProviderType provider, | |
28 const ContentSuggestionCategory category, | 30 const ContentSuggestionCategory category, |
29 const GURL& url); | 31 const GURL& url); |
| 32 ContentSuggestion(ContentSuggestion&&); |
| 33 ContentSuggestion& operator=(ContentSuggestion&&); |
30 | 34 |
31 ~ContentSuggestion(); | 35 ~ContentSuggestion(); |
32 | 36 |
33 // An ID for identifying the suggestion. The ID is unique among all | 37 // An ID for identifying the suggestion. The ID is unique among all |
34 // suggestions from the same provider, so to determine a globally unique | 38 // suggestions of all providers. |
35 // identifier, combine this ID with the provider type. | |
36 const std::string& id() const { return id_; } | 39 const std::string& id() const { return id_; } |
37 | 40 |
38 // The provider that created this suggestion. | |
39 ContentSuggestionsProviderType provider() const { return provider_; } | |
40 | |
41 // The category that this suggestion belongs to. | 41 // The category that this suggestion belongs to. |
42 ContentSuggestionCategory category() const { return category_; } | 42 ContentSuggestionCategory category() const { return category_; } |
43 | 43 |
44 // The normal content URL where the content referenced by the suggestion can | 44 // The normal content URL where the content referenced by the suggestion can |
45 // be accessed. | 45 // be accessed. |
46 const GURL& url() const { return url_; } | 46 const GURL& url() const { return url_; } |
47 | 47 |
48 // If available, this contains an URL to an AMP version of the same content. | 48 // If available, this contains an URL to an AMP version of the same content. |
49 // Otherwise, this is an empty GURL(). | 49 // Otherwise, this is an empty GURL(). |
50 const GURL& amp_url() const { return amp_url_; } | 50 const GURL& amp_url() const { return amp_url_; } |
(...skipping 24 matching lines...) Expand all Loading... |
75 // TODO(pke) Remove the score from the ContentSuggestion class. The UI only | 75 // TODO(pke) Remove the score from the ContentSuggestion class. The UI only |
76 // uses it to track user clicks (histogram data). Instead, the providers | 76 // uses it to track user clicks (histogram data). Instead, the providers |
77 // should be informed about clicks and do appropriate logging themselves. | 77 // should be informed about clicks and do appropriate logging themselves. |
78 // IMPORTANT: The score may simply be 0 for suggestions from providers which | 78 // IMPORTANT: The score may simply be 0 for suggestions from providers which |
79 // cannot provide score values. | 79 // cannot provide score values. |
80 float score() const { return score_; } | 80 float score() const { return score_; } |
81 void set_score(float score) { score_ = score; } | 81 void set_score(float score) { score_ = score; } |
82 | 82 |
83 private: | 83 private: |
84 std::string id_; | 84 std::string id_; |
85 ContentSuggestionsProviderType provider_; | |
86 ContentSuggestionCategory category_; | 85 ContentSuggestionCategory category_; |
87 GURL url_; | 86 GURL url_; |
88 GURL amp_url_; | 87 GURL amp_url_; |
89 std::string title_; | 88 std::string title_; |
90 std::string snippet_text_; | 89 std::string snippet_text_; |
91 GURL salient_image_url_; | 90 GURL salient_image_url_; |
92 base::Time publish_date_; | 91 base::Time publish_date_; |
93 std::string publisher_name_; | 92 std::string publisher_name_; |
94 float score_; | 93 float score_; |
95 | 94 |
96 DISALLOW_COPY_AND_ASSIGN(ContentSuggestion); | 95 DISALLOW_COPY_AND_ASSIGN(ContentSuggestion); |
97 }; | 96 }; |
98 | 97 |
99 } // namespace ntp_snippets | 98 } // namespace ntp_snippets |
100 | 99 |
101 #endif // COMPONENTS_NTP_SNIPPETS_CONTENT_SUGGESTION_H_ | 100 #endif // COMPONENTS_NTP_SNIPPETS_CONTENT_SUGGESTION_H_ |
OLD | NEW |