File: remote_suggestions_fetcher.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 (60 lines) | stat: -rw-r--r-- 2,236 bytes parent folder | download | duplicates (9)
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
// 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_REMOTE_REMOTE_SUGGESTIONS_FETCHER_H_
#define COMPONENTS_NTP_SNIPPETS_REMOTE_REMOTE_SUGGESTIONS_FETCHER_H_

#include <string>
#include <vector>

#include "base/callback.h"
#include "base/optional.h"
#include "components/ntp_snippets/category.h"
#include "components/ntp_snippets/category_info.h"
#include "components/ntp_snippets/remote/json_to_categories.h"
#include "components/ntp_snippets/remote/remote_suggestion.h"
#include "components/ntp_snippets/remote/request_params.h"
#include "components/ntp_snippets/status.h"
#include "url/gurl.h"

namespace ntp_snippets {

// Returns the appropriate API endpoint for the fetcher, in consideration of
// variation parameters.
GURL GetFetchEndpoint();

// Fetches suggestion data for the NTP from the server.
class RemoteSuggestionsFetcher {
 public:
  using OptionalFetchedCategories = base::Optional<FetchedCategoriesVector>;
  using SnippetsAvailableCallback =
      base::OnceCallback<void(Status status,
                              OptionalFetchedCategories fetched_categories)>;

  virtual ~RemoteSuggestionsFetcher();

  // Initiates a fetch from the server. When done (successfully or not), calls
  // the callback.
  //
  // If an ongoing fetch exists, both fetches won't influence each other (i.e.
  // every callback will be called exactly once).
  virtual void FetchSnippets(const RequestParams& params,
                             SnippetsAvailableCallback callback) = 0;

  // Debug string representing the status/result of the last fetch attempt.
  virtual const std::string& GetLastStatusForDebugging() const = 0;

  // Returns the last JSON fetched from the server.
  virtual const std::string& GetLastJsonForDebugging() const = 0;

  // Returns whether the last fetch was authenticated.
  virtual bool WasLastFetchAuthenticatedForDebugging() const = 0;

  // Returns the URL endpoint used by the fetcher.
  virtual const GURL& GetFetchUrlForDebugging() const = 0;
};

}  // namespace ntp_snippets

#endif  // COMPONENTS_NTP_SNIPPETS_REMOTE_REMOTE_SUGGESTIONS_FETCHER_H_