Add ContentSuggestion, ContentSuggestionCategory and ContentSuggestionProviderType

components/ntp_snippets/content_suggestion.h

+// Copyright 2016 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_SNIPPETS_CONTENT_SUGGESTION_H_
+#define COMPONENTS_NTP_SNIPPETS_CONTENT_SUGGESTION_H_
+
+#include <memory>
+#include <string>
+#include <vector>
+
+#include "base/macros.h"
+#include "base/time/time.h"
+#include "components/ntp_snippets/content_suggestion_category.h"
+#include "components/ntp_snippets/content_suggestion_provider_type.h"
+#include "url/gurl.h"
+
+namespace ntp_snippets {
+
+// A content suggestion for the new tab page, which can be an article or an
+// offline page, for example.
+// NOTE: This class is not yet in use, please use NTPSnippet for now
+// (see ntp_snippet.h).
+class ContentSuggestion {
+ public:
+  using PtrVector = std::vector<std::unique_ptr<ContentSuggestion>>;

[Marc Treib, 2016/06/27 11:35:30]

Hm, we could consider passing around vectors of instances instead of vectors of
pointers. Any good reason for using pointers?

[Philipp Keck, 2016/06/27 12:05:04]

Done.

+
+  ContentSuggestion(const std::string& id,
+                    const ContentSuggestionProviderType provider,
+                    const ContentSuggestionCategory category,
+                    const GURL& url);
+
+  ~ContentSuggestion();
+
+  // An ID for identifying the suggestion. The ID is unique among all
+  // suggestions from the same provider, so to determine a globally unique
+  // identifier, combine this ID with the provider type.
+  const std::string& id() const { return id_; }
+
+  // The provider that created this suggestion.
+  ContentSuggestionProviderType provider() const { return provider_; }
+
+  // The category that this suggestion belongs to.
+  ContentSuggestionCategory category() const { return category_; }
+
+  // The normal content URL where the content referenced by the suggestion can
+  // be accessed.
+  const GURL& url() const { return url_; }
+
+  // If available, this contains an URL to an AMP version of the same content.
+  // Otherwise, this is an empty GURL().
+  const GURL& amp_url() const { return amp_url_; }
+  void set_amp_url(const GURL& amp_url) { amp_url_ = amp_url; }
+
+  // Title of the suggestion.
+  const std::string& title() const { return title_; }
+  void set_title(const std::string& title) { title_ = title; }
+
+  // Summary or relevant textual extract from the content.
+  const std::string& snippet_text() const { return snippet_text_; }
+  void set_snippet_text(const std::string& snippet_text) {
+    snippet_text_ = snippet_text;
+  }
+
+  // The time when the content represented by this suggestion was published.
+  const base::Time& publish_date() const { return publish_date_; }
+  void set_publish_date(const base::Time& publish_date) {
+    publish_date_ = publish_date;
+  }
+
+  // The name of the source/publisher of this suggestion.
+  const std::string& publisher_name() const { return publisher_name_; }
+  void set_publisher_name(const std::string& publisher_name) {
+    publisher_name_ = publisher_name;
+  }
+
+  // TODO(pke) Remove the score from the ContentSuggestion class. The UI only
+  // uses it to track user clicks (histogram data). Instead, the providers
+  // should be informed about clicks and do appropriate logging themselves.
+  // IMPORTANT: The score may simply be 0 for suggestions from providers which
+  // cannot provide score values.
+  float score() const { return score_; }
+  void set_score(float score) { score_ = score; }
+
+ private:
+  std::string id_;
+  ContentSuggestionProviderType provider_;
+  ContentSuggestionCategory category_;
+  GURL url_;
+  GURL amp_url_;
+  std::string title_;
+  std::string snippet_text_;
+  GURL salient_image_url_;
+  base::Time publish_date_;
+  std::string publisher_name_;
+  float score_;
+
+  DISALLOW_COPY_AND_ASSIGN(ContentSuggestion);
+};
+
+}  // namespace ntp_snippets
+
+#endif  // COMPONENTS_NTP_SNIPPETS_CONTENT_SUGGESTION_H_