File: page_image_service.mojom

package info (click to toggle)
chromium 139.0.7258.138-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 6,120,676 kB
  • sloc: cpp: 35,100,869; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (48 lines) | stat: -rw-r--r-- 1,239 bytes parent folder | download | duplicates (6) 
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
 
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

[JavaPackage="org.chromium.page_image_service.mojom"]
module page_image_service.mojom;

import "url/mojom/url.mojom";

// The UI client that's calling the service. Used to track usage.
enum ClientId {
  // Approved as part of launch/4224996.
  Journeys,
  JourneysSidePanel,
  NtpRealbox,
  NtpQuests,

  // Tracked at launch/4225832.
  Bookmarks,

  // Tracked at launch/4279123.
  NtpTabResumption,

  // Tracked at launch/4341062.
  HistoryEmbeddings,
};

// Options for image fetching.
struct Options {
  // Turn these off if any UI client wants to disable a source.
  bool suggest_images = true;
  bool optimization_guide_images = true;
};

struct ImageResult {
  // URL of the representative image for this page.
  url.mojom.Url image_url;

  // TODO(tommycli): Add attribution fields below.
};

// Browser-side handler for requests from the WebUI page.
interface PageImageServiceHandler {
  // Gets the representative image URL for `page_url`.
  GetPageImageUrl(ClientId client_id,
                  url.mojom.Url page_url,
                  Options options) => (ImageResult? result);
};