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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
|
[
{
"namespace": "manifest",
"types": [
{
"$extend": "OptionalPermission",
"choices": [
{
"type": "string",
"enum": ["history"]
}
]
}
]
},
{
"namespace": "history",
"description": "Use the <code>browser.history</code> API to interact with the browser's record of visited pages. You can add, remove, and query for URLs in the browser's history. To override the history page with your own version, see $(topic:override)[Override Pages].",
"permissions": ["history"],
"types": [
{
"id": "TransitionType",
"type": "string",
"enum": [
"link",
"typed",
"auto_bookmark",
"auto_subframe",
"manual_subframe",
"generated",
"auto_toplevel",
"form_submit",
"reload",
"keyword",
"keyword_generated"
],
"description": "The $(topic:transition-types)[transition type] for this visit from its referrer."
},
{
"id": "HistoryItem",
"type": "object",
"description": "An object encapsulating one result of a history query.",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item."
},
"url": {
"type": "string",
"optional": true,
"description": "The URL navigated to by a user."
},
"title": {
"type": "string",
"optional": true,
"description": "The title of the page when it was last loaded."
},
"lastVisitTime": {
"type": "number",
"optional": true,
"description": "When this page was last loaded, represented in milliseconds since the epoch."
},
"visitCount": {
"type": "integer",
"optional": true,
"description": "The number of times the user has navigated to this page."
},
"typedCount": {
"type": "integer",
"optional": true,
"description": "The number of times the user has navigated to this page by typing in the address."
}
}
},
{
"id": "VisitItem",
"type": "object",
"description": "An object encapsulating one visit to a URL.",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item."
},
"visitId": {
"type": "string",
"description": "The unique identifier for this visit."
},
"visitTime": {
"type": "number",
"optional": true,
"description": "When this visit occurred, represented in milliseconds since the epoch."
},
"referringVisitId": {
"type": "string",
"description": "The visit ID of the referrer."
},
"transition": {
"$ref": "TransitionType",
"description": "The $(topic:transition-types)[transition type] for this visit from its referrer."
}
}
}
],
"functions": [
{
"name": "search",
"type": "function",
"description": "Searches the history for the last visit time of each page matching the query.",
"async": "callback",
"parameters": [
{
"name": "query",
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "A free-text query to the history service. Leave empty to retrieve all pages."
},
"startTime": {
"$ref": "extensionTypes.Date",
"optional": true,
"description": "Limit results to those visited after this date. If not specified, this defaults to 24 hours in the past."
},
"endTime": {
"$ref": "extensionTypes.Date",
"optional": true,
"description": "Limit results to those visited before this date."
},
"maxResults": {
"type": "integer",
"optional": true,
"minimum": 1,
"description": "The maximum number of results to retrieve. Defaults to 100."
}
}
},
{
"name": "callback",
"type": "function",
"parameters": [
{
"name": "results",
"type": "array",
"items": {
"$ref": "HistoryItem"
}
}
]
}
]
},
{
"name": "getVisits",
"type": "function",
"description": "Retrieves information about visits to a URL.",
"async": "callback",
"parameters": [
{
"name": "details",
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL for which to retrieve visit information. It must be in the format as returned from a call to history.search."
}
}
},
{
"name": "callback",
"type": "function",
"parameters": [
{
"name": "results",
"type": "array",
"items": {
"$ref": "VisitItem"
}
}
]
}
]
},
{
"name": "addUrl",
"type": "function",
"description": "Adds a URL to the history with a default visitTime of the current time and a default $(topic:transition-types)[transition type] of \"link\".",
"async": "callback",
"parameters": [
{
"name": "details",
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to add. Must be a valid URL that can be added to history."
},
"title": {
"type": "string",
"optional": true,
"description": "The title of the page."
},
"transition": {
"$ref": "TransitionType",
"optional": true,
"description": "The $(topic:transition-types)[transition type] for this visit from its referrer."
},
"visitTime": {
"$ref": "extensionTypes.Date",
"optional": true,
"description": "The date when this visit occurred."
}
}
},
{
"name": "callback",
"type": "function",
"optional": true,
"parameters": []
}
]
},
{
"name": "deleteUrl",
"type": "function",
"description": "Removes all occurrences of the given URL from the history.",
"async": "callback",
"parameters": [
{
"name": "details",
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to remove."
}
}
},
{
"name": "callback",
"type": "function",
"optional": true,
"parameters": []
}
]
},
{
"name": "deleteRange",
"type": "function",
"description": "Removes all items within the specified date range from the history. Pages will not be removed from the history unless all visits fall within the range.",
"async": "callback",
"parameters": [
{
"name": "range",
"type": "object",
"properties": {
"startTime": {
"$ref": "extensionTypes.Date",
"description": "Items added to history after this date."
},
"endTime": {
"$ref": "extensionTypes.Date",
"description": "Items added to history before this date."
}
}
},
{
"name": "callback",
"type": "function",
"parameters": []
}
]
},
{
"name": "deleteAll",
"type": "function",
"description": "Deletes all items from the history.",
"async": "callback",
"parameters": [
{
"name": "callback",
"type": "function",
"parameters": []
}
]
}
],
"events": [
{
"name": "onVisited",
"type": "function",
"description": "Fired when a URL is visited, providing the HistoryItem data for that URL. This event fires before the page has loaded.",
"parameters": [
{
"name": "result",
"$ref": "HistoryItem"
}
]
},
{
"name": "onVisitRemoved",
"type": "function",
"description": "Fired when one or more URLs are removed from the history service. When all visits have been removed the URL is purged from history.",
"parameters": [
{
"name": "removed",
"type": "object",
"properties": {
"allHistory": {
"type": "boolean",
"description": "True if all history was removed. If true, then urls will be empty."
},
"urls": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
},
{
"name": "onTitleChanged",
"type": "function",
"description": "Fired when the title of a URL is changed in the browser history.",
"parameters": [
{
"name": "changed",
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL for which the title has changed"
},
"title": {
"type": "string",
"description": "The new title for the URL."
}
}
}
]
}
]
}
]
|
