File: contextual_suggestion.h

package info (click to toggle)
chromium-browser 70.0.3538.110-1~deb9u1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 1,619,476 kB
  • sloc: cpp: 13,024,755; ansic: 1,349,823; python: 916,672; xml: 314,489; java: 280,047; asm: 276,936; perl: 75,771; objc: 66,634; sh: 45,860; cs: 28,354; php: 11,064; makefile: 10,911; yacc: 9,109; tcl: 8,403; ruby: 4,065; lex: 1,779; pascal: 1,411; lisp: 1,055; awk: 41; jsp: 39; sed: 17; sql: 3
file content (71 lines) | stat: -rw-r--r-- 2,221 bytes parent folder | download | duplicates (2)
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
// 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.

#ifndef COMPONENTS_NTP_SNIPPETS_CONTEXTUAL_CONTEXTUAL_SUGGESTION_H_
#define COMPONENTS_NTP_SNIPPETS_CONTEXTUAL_CONTEXTUAL_SUGGESTION_H_

#include <string>

#include "url/gurl.h"

namespace contextual_suggestions {

// Struct containing the data for a single contextual content suggestion.
struct ContextualSuggestion {
  ContextualSuggestion();
  ContextualSuggestion(const ContextualSuggestion&);
  ContextualSuggestion(ContextualSuggestion&&) noexcept;
  ~ContextualSuggestion();

  ContextualSuggestion& operator=(const ContextualSuggestion&);

  // The ID identifying the suggestion.
  std::string id;

  // Title of the suggestion.
  std::string title;

  // The URL of the suggested page.
  GURL url;

  // The name of the content's publisher.
  std::string publisher_name;

  // Summary or relevant extract from the content.
  std::string snippet;

  // Identifier of the image to display alongside the suggestion. This id can
  // be used to construct a URL to the image.
  std::string image_id;

  // As above, but for identifying the favicon for the site the suggestion
  // resides on.
  std::string favicon_image_id;

  // The favicon URL for the suggestion.
  std::string favicon_image_url;
};

// Allows compact, precise construction of a ContextualSuggestion. Its main
// purpose is to avoid using a confusing 6 param helper whose argument
// order has to be guessed at.
class SuggestionBuilder {
 public:
  explicit SuggestionBuilder(const GURL& url);

  SuggestionBuilder& Title(const std::string& title);
  SuggestionBuilder& PublisherName(const std::string& publisher_name);
  SuggestionBuilder& Snippet(const std::string& snippet);
  SuggestionBuilder& ImageId(const std::string& image_id);
  SuggestionBuilder& FaviconImageId(const std::string& favicon_image_id);
  SuggestionBuilder& FaviconImageUrl(const std::string& favicon_image_url);
  ContextualSuggestion Build();

 private:
  ContextualSuggestion suggestion_;
};

}  // namespace contextual_suggestions

#endif  // COMPONENTS_NTP_SNIPPETS_CONTEXTUAL_CONTEXTUAL_SUGGESTION_H_