Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(179)

Side by Side Diff: chrome/common/extensions/api/wallpaper.json

Issue 27335003: Add docs for chrome.wallpaper API (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 7 years, 2 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
OLDNEW
1 // Copyright 2013 The Chromium Authors. All rights reserved. 1 // Copyright 2013 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be 2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file. 3 // found in the LICENSE file.
4 4
5 [ 5 [
6 { 6 {
7 "namespace":"wallpaper", 7 "namespace":"wallpaper",
8 "compiler_options": { 8 "compiler_options": {
9 "implemented_in": "chrome/browser/chromeos/extensions/wallpaper_api.h" 9 "implemented_in": "chrome/browser/chromeos/extensions/wallpaper_api.h"
10 }, 10 },
11 "platforms": ["chromeos"], 11 "platforms": ["chromeos"],
12 "description": "none", 12 "description": "Use the <code>chrome.wallpaper</code> API to change the Chro meOS wallpaper.",
13 "functions": [ 13 "functions": [
14 { 14 {
15 "name": "setWallpaper", 15 "name": "setWallpaper",
16 "type": "function", 16 "type": "function",
17 "description": "Sets wallpaper to the image from url with specified layout ", 17 "description": "Sets wallpaper to the image at <code>url</code> or <code>w allpaperData</code> with the specified layout",
18 "nodoc": "true",
19 "parameters": [ 18 "parameters": [
20 { 19 {
21 "name": "details", 20 "name": "details",
22 "type": "object", 21 "type": "object",
23 "properties": { 22 "properties": {
24 "wallpaperData": { 23 "wallpaperData": {
25 "type": "binary", 24 "type": "binary",
26 "optional": true, 25 "optional": true,
27 "description": "The jpeg or png encoded wallpaper image." 26 "description": "The jpeg or png encoded wallpaper image."
28 }, 27 },
29 "url": { 28 "url": {
30 "type": "string", 29 "type": "string",
31 "optional": true, 30 "optional": true,
32 "description": "The url of online wallpaper." 31 "description": "The URL of the wallpaper to be set. If host permis sions for this URL are not specified in the manifest file, the API call will fai l."
33 }, 32 },
34 "layout": { 33 "layout": {
35 "type": "string", 34 "type": "string",
36 "enum": [ "STRETCH", "CENTER", "CENTER_CROPPED" ], 35 "enum": [ "STRETCH", "CENTER", "CENTER_CROPPED" ],
37 "description": "The supported wallpaper layouts." 36 "description": "The supported wallpaper layouts."
38 }, 37 },
39 "name": { 38 "name": {
40 "type": "string", 39 "type": "string",
41 "description": "The file name of saved wallpaper." 40 "description": "The file name of the saved wallpaper."
42 }, 41 },
43 "thumbnail": { 42 "thumbnail": {
44 "type": "boolean", 43 "type": "boolean",
45 "optional": true, 44 "optional": true,
46 "description": "True if a 128x60 thumbnail should be generated." 45 "description": "True if a 128x60 thumbnail should be generated."
47 } 46 }
48 } 47 }
49 }, 48 },
50 { 49 {
51 "type": "function", 50 "type": "function",
52 "name": "callback", 51 "name": "callback",
53 "parameters": [ 52 "parameters": [
54 { 53 {
55 "type": "binary", 54 "type": "binary",
56 "optional": true, 55 "optional": true,
57 "name": "thumbnail" 56 "name": "thumbnail",
57 "description": "The jpeg encoded wallpaper thumbnail. It is genera ted by resizing the wallpaper to 128x60."
58 } 58 }
59 ] 59 ]
60 } 60 }
61 ] 61 ]
62 } 62 }
63 ] 63 ]
64 } 64 }
65 ] 65 ]
66 66
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698