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
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
|
// Copyright (c) 2012 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.
[
{
"namespace":"wallpaperPrivate",
"compiler_options": {
"implemented_in": "chrome/browser/chromeos/extensions/wallpaper_private_api.h"
},
"description": "none",
"types": [
{
"id": "WallpaperSource",
"type": "string",
"enum": [ "ONLINE", "OEM", "DAILY", "CUSTOM", "THIRDPARTY" ]
},
{
"id": "CollectionInfo",
"type": "object",
"description": "The name of a wallpaper collection (ie. a category such as Art, Landscape etc.) and its id.",
"properties": {
"collectionName": {
"type": "string",
"description": "The name of the collection used for display."
},
"collectionId": {
"type": "string",
"description": "The id of the collection used as a token to fetch images info."
}
}
},
{
"id": "ImageInfo",
"type": "object",
"description": "The info (url, description etc.) specific to each wallpaper image.",
"properties": {
"assetId": {
"type": "string",
"description": "The unique identifier for this image."
},
"imageUrl": {
"type": "string",
"description": "The url that points to the image."
},
"actionUrl": {
"type": "string",
"description": "The url of the Learn More link."
},
"displayText": {
"type": "array",
"description": "The descriptive text such as the name of the artist.",
"items": {"type": "string"}
}
}
}
],
"functions": [
{
"name": "getStrings",
"type": "function",
"description": "Gets translated strings and initialization data.",
"nodoc": true,
"parameters": [
{
"type": "function",
"name": "callback",
"parameters": [
{
"name": "result",
"type": "object",
"additionalProperties": {"type": "any"}
}
]
}
]
},
{
"name": "getSyncSetting",
"type": "function",
"description": "Gets the sync themes(and wallpaper on ChromeOS) setting value.",
"nodoc": true,
"parameters": [
{
"type": "function",
"name": "callback",
"parameters": [
{
"name": "result",
"type": "object",
"additionalProperties": {"type": "any"}
}
]
}
]
},
{
"name": "setWallpaperIfExists",
"type": "function",
"description": "Sets wallpaper if it exists in the local file system with specified layout",
"nodoc": true,
"parameters": [
{
"type": "string",
"name": "assetId",
"description": "The unique identifier of the wallpaper. The id is used for analytics. When empty, the metric will not be logged."
},
{
"type": "string",
"name": "url"
},
{
"type": "string",
"name": "collectionId",
"description": "The id of the collection that the wallpaper belongs to. The id is used for analytics. If it is empty, the metric will not be logged."
},
{
"name": "layout",
"$ref": "wallpaper.WallpaperLayout"
},
{
"type": "boolean",
"name": "previewMode",
"description": "If preview mode is desired."
},
{
"type": "function",
"name": "callback",
"parameters": [
{
"type": "boolean",
"name": "exists"
}
]
}
]
},
{
"name": "setWallpaper",
"type": "function",
"description": "Sets wallpaper to the image from url with specified layout",
"nodoc": true,
"parameters": [
{
"type": "binary",
"name": "wallpaper"
},
{
"name": "layout",
"$ref": "wallpaper.WallpaperLayout"
},
{
"type": "string",
"name": "url"
},
{
"type": "boolean",
"name": "previewMode",
"description": "If preview mode is desired."
},
{
"type": "function",
"name": "callback",
"parameters": []
}
]
},
{
"name": "resetWallpaper",
"type": "function",
"description": "Clears current user's active custom wallpaper and changes to default wallpaper.",
"nodoc": true,
"parameters": []
},
{
"name": "setCustomWallpaper",
"type": "function",
"description": "Sets wallpaper to the image from local file with specified layout and returns thumbnail if needed.",
"nodoc": true,
"parameters": [
{
"type": "binary",
"name": "wallpaper"
},
{
"name": "layout",
"$ref": "wallpaper.WallpaperLayout"
},
{
"type": "boolean",
"name": "generateThumbnail",
"description": "If true, callback should have a binary thumbnail."
},
{
"type": "string",
"name": "fileName"
},
{
"type": "boolean",
"name": "previewMode",
"description": "If preview mode is desired."
},
{
"type": "function",
"name": "callback",
"parameters": [
{
"type": "binary",
"optional": true,
"name": "thumbnail"
}
]
}
]
},
{
"name": "setCustomWallpaperLayout",
"type": "function",
"description": "Sets current custom wallpaper to the specified layout",
"nodoc": true,
"parameters": [
{
"name": "layout",
"$ref": "wallpaper.WallpaperLayout"
},
{
"type": "function",
"name": "callback",
"parameters": []
}
]
},
{
"name": "minimizeInactiveWindows",
"type": "function",
"description": "Minimizes all inactive open windows.",
"nodoc": true,
"parameters": []
},
{
"name": "restoreMinimizedWindows",
"type": "function",
"description": "Restores all previously minimized windows.",
"nodoc": true,
"parameters": []
},
{
"name": "getThumbnail",
"type": "function",
"description": "Gets thumbnail of wallpaper from thumbnail directory.",
"nodoc": true,
"parameters": [
{
"type": "string",
"name": "urlOrFile",
"description": "URL of ONLINE wallpaper or file name of CUSTOM wallpaper"
},
{
"name": "source",
"$ref": "WallpaperSource"
},
{
"type": "function",
"name": "callback",
"description": "Function called upon completion.",
"parameters": [
{
"type": "binary",
"name": "data",
"optional": true,
"description": "The binary data of loaded thumbnail."
}
]
}
]
},
{
"name": "saveThumbnail",
"type": "function",
"description": "Saves thumbnail to thumbnail directory.",
"nodoc": true,
"parameters": [
{
"type": "string",
"name": "url",
"description": "Wallpaper url."
},
{
"type": "binary",
"name": "data",
"description": "The binary data of downloaded thumbnail."
},
{
"type": "function",
"name": "callback",
"description": "Function called upon completion.",
"parameters": [],
"optional": true
}
]
},
{
"name": "getOfflineWallpaperList",
"type": "function",
"description": "Get the list of file names of downloaded wallpapers.",
"nodoc": true,
"parameters": [
{
"type": "function",
"name": "callback",
"description": "Function called upon completion.",
"parameters": [
{
"type": "array",
"name": "results",
"items": {"type": "string"}
}
]
}
]
},
{
"name": "recordWallpaperUMA",
"type": "function",
"description": "Record wallpaper UMA when a new wallpaper is set, either by Wallpaper Picker App, or by a third party App.",
"nodoc": true,
"parameters": [
{
"name": "source",
"$ref": "WallpaperSource"
}
]
},
{
"name": "getCollectionsInfo",
"type": "function",
"description": "Gets the info of wallpaper collections (ie. categories such as Art, Landscape etc.)",
"nodoc": true,
"parameters": [
{
"type": "function",
"name": "callback",
"description": "Function called upon completion.",
"parameters": [
{
"type": "array",
"name": "collectionsInfo",
"items": {"$ref": "CollectionInfo"}
}
]
}
]
},
{
"name": "getImagesInfo",
"type": "function",
"description": "Gets wallpaper related info (url, description etc.) for a particular collection (ie. category).",
"nodoc": true,
"parameters": [
{
"type": "string",
"name": "collectionId",
"description": "The id of the collection whose info is requested."
},
{
"type": "function",
"name": "callback",
"description": "Function called upon completion.",
"parameters": [
{
"type": "array",
"name": "imagesInfo",
"items": {"$ref": "ImageInfo"}
}
]
}
]
},
{
"name": "getLocalImagePaths",
"type": "function",
"description": "Gets the paths of the local image files that can be set as wallpaper.",
"nodoc": true,
"parameters": [
{
"type": "function",
"name": "callback",
"description": "Function called upon completion.",
"parameters": [
{
"type": "array",
"name": "localImagePaths",
"items": {"type": "string"}
}
]
}
]
},
{
"name": "getLocalImageData",
"type": "function",
"description": "Read the image data from the file path.",
"nodoc": true,
"parameters": [
{
"type": "string",
"name": "imagePath",
"description": "The path of the image."
},
{
"type": "function",
"name": "callback",
"description": "Function called upon completion.",
"parameters": [
{
"type": "binary",
"name": "imageData"
}
]
}
]
},
{
"name": "confirmPreviewWallpaper",
"type": "function",
"description": "Confirm the wallpaper being previewed to be set as the actual user wallpaper.",
"nodoc": true,
"parameters": [
{
"type": "function",
"name": "callback",
"description": "Function called upon completion.",
"parameters": []
}
]
},
{
"name": "cancelPreviewWallpaper",
"type": "function",
"description": "Cancel the wallpaper preview and revert to the user wallpaper.",
"nodoc": true,
"parameters": [
{
"type": "function",
"name": "callback",
"description": "Function called upon completion.",
"parameters": []
}
]
},
{
"name": "getCurrentWallpaperThumbnail",
"type": "function",
"description": "Get a thumbnail of the wallpaper currently on display.",
"nodoc": true,
"parameters": [
{
"type": "integer",
"name": "thumbnailWidth",
"description": "The desired width of the thumbnail in pixels."
},
{
"type": "integer",
"name": "thumbnailHeight",
"description": "The desired height of the thumbnail in pixels."
},
{
"type": "function",
"name": "callback",
"description": "Function called upon completion.",
"parameters": [
{
"type": "binary",
"name": "thumbnail"
}
]
}
]
},
{
"name": "getSurpriseMeImage",
"type": "function",
"description": "Gets the related info (url, description etc.) of a randomly selected wallpaper.",
"nodoc": true,
"parameters": [
{
"type": "string",
"name": "collectionId",
"description": "The id of the collection from which the surprise me wallpaper should be selected from."
},
{
"type": "string",
"name": "resumeToken",
"optional": true,
"description": " An opaque token returned the last time this function was called, to prevent image repetition. Leave empty if not available."
},
{
"type": "function",
"name": "callback",
"description": "Function called upon completion.",
"parameters": [
{
"name": "imageInfo",
"$ref": "ImageInfo"
},
{
"type": "string",
"name": "nextResumeToken",
"description": "An opaque token that should be passed the next time this function is called, to prevent image repetition."
}
]
}
]
},
{
"name": "isSwaEnabled",
"type": "function",
"description": "Gets if the new wallpaper picker SWA is enabled.",
"nodoc": true,
"parameters": [
{
"type": "function",
"name": "callback",
"parameters": [
{
"type": "boolean",
"name": "swaEnabled"
}
]
}
]
}
],
"events": [
{
"name": "onWallpaperChangedBy3rdParty",
"type": "function",
"description": "This event is sent when the current wallpaper was set by a third party application.",
"parameters": [
{
"type": "binary",
"name": "wallpaper",
"description": "The third party custom wallpaper data."
},
{
"type": "binary",
"name": "thumbnail",
"description": "The third party custom wallpaper thumbnail data."
},
{
"name": "layout",
"$ref": "wallpaper.WallpaperLayout"
},
{
"type": "string",
"name": "appName",
"description": "The third party wallpaper app name."
}
]
},
{
"name": "onClosePreviewWallpaper",
"type": "function",
"description": "This event is sent when the app side of preview wallpaper should be closed.",
"parameters": []
}
]
}
]
|
