summaryrefslogtreecommitdiffstats
path: root/browser/components/extensions/schemas/search.json
blob: abd4f59440f9aea8e5168137e1314292407cdef0 (plain)
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
[
  {
    "namespace": "manifest",
    "types": [
      {
        "$extend": "OptionalPermissionNoPrompt",
        "choices": [
          {
            "type": "string",
            "enum": ["search"]
          }
        ]
      }
    ]
  },
  {
    "namespace": "search",
    "description": "Use browser.search to interact with search engines.",
    "permissions": ["search"],
    "types": [
      {
        "id": "SearchEngine",
        "type": "object",
        "description": "An object encapsulating a search engine",
        "properties": {
          "name": {
            "type": "string"
          },
          "isDefault": {
            "type": "boolean"
          },
          "alias": {
            "type": "string",
            "optional": true
          },
          "favIconUrl": {
            "type": "string",
            "optional": true,
            "format": "url"
          }
        }
      },
      {
        "id": "Disposition",
        "type": "string",
        "description": "Location where search results should be displayed.",
        "enum": ["CURRENT_TAB", "NEW_TAB", "NEW_WINDOW"]
      }
    ],
    "functions": [
      {
        "name": "get",
        "type": "function",
        "description": "Gets a list of search engines.",
        "async": true,
        "parameters": []
      },
      {
        "name": "search",
        "type": "function",
        "description": "Perform a search.",
        "async": true,
        "parameters": [
          {
            "type": "object",
            "name": "searchProperties",
            "properties": {
              "query": {
                "type": "string",
                "description": "Terms to search for."
              },
              "engine": {
                "type": "string",
                "optional": true,
                "description": "Search engine to use. Uses the default if not specified."
              },
              "disposition": {
                "$ref": "Disposition",
                "optional": true,
                "description": "Location where search results should be displayed. NEW_TAB is the default."
              },
              "tabId": {
                "type": "integer",
                "optional": true,
                "description": "The ID of the tab for the search results. If not specified, a new tab is created, unless disposition is set. tabId cannot be used with disposition."
              }
            }
          }
        ]
      },
      {
        "name": "query",
        "type": "function",
        "async": "callback",
        "description": "Use the chrome.search API to search via the default provider.",
        "parameters": [
          {
            "type": "object",
            "name": "queryInfo",
            "properties": {
              "text": {
                "type": "string",
                "description": "String to query with the default search provider."
              },
              "disposition": {
                "$ref": "Disposition",
                "optional": true,
                "description": "Location where search results should be displayed. CURRENT_TAB is the default."
              },
              "tabId": {
                "type": "integer",
                "optional": true,
                "description": "Location where search results should be displayed. tabId cannot be used with disposition."
              }
            }
          },
          {
            "type": "function",
            "name": "callback",
            "optional": true,
            "parameters": []
          }
        ]
      }
    ]
  }
]