chrome/common/extensions/api/file_browser_handler.json

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 [
   6   {
   7     "namespace":"fileBrowserHandler",
   8     "description": "Use the <code>chrome.fileBrowserHandler</code> API to extend the Chrome OS file browser. For example, you can use this API to enable users to upload files to your website.",
   9     "platforms": ["chromeos"],
  10     "types": [
  11       {
  12         "id": "FileHandlerExecuteEventDetails",
  13         "type": "object",
  14         "description": "Event details payload for fileBrowserHandler.onExecute event.",
  15         "properties": {
  16           "entries": {
  17             "type": "array",
  18             "items": { "type": "any" },
  19             "description": "Array of Entry instances representing files that are targets of this action (selected in ChromeOS file browser)."
  20           },
  21           "tab_id" : {
  22             "type": "integer",
  23             "optional": true,
  24             "description": "The ID of the tab that raised this event. Tab IDs are unique within a browser session."
  25           }
  26         }
  27       }
  28     ],
  29
  30     "events": [
  31       {
  32         "name": "onExecute",
  33         "type": "function",
  34         "description": "Fired when file system action is executed from ChromeOS file browser.",
  35         "parameters": [
  36           {
  37             "name": "id",
  38             "type": "string",
  39             "description": "File browser action id as specified in the listener component's manifest."
  40           },
  41           {
  42             "name": "details",
  43             "$ref": "FileHandlerExecuteEventDetails",
  44             "description": "File handler execute event details."
  45           }
  46         ]
  47       }
  48     ],
  49
  50     "functions": [
  51       {
  52         "name": "selectFile",
  53         "type": "function",
  54         "description": "Prompts user to select file path under which file should be saved. When the file is selected, file access permission required to use the file (read, write and create) are granted to the caller. The file will not actually get created during the function call, so function caller must ensure its existence before using it. The function has to be invoked with a user gesture.",
  55         "parameters": [
  56           {
  57             "name": "selectionParams",
  58             "type": "object",
  59             "description": "Parameters that will be used while selecting the file.",
  60             "properties": {
  61               "suggestedName": {
  62                   "type": "string",
  63                   "description": "Suggested name for the file."
  64               },
  65               "allowedFileExtensions": {
  66                   "type": "array",
  67                   "items": { "type": "string" },
  68                   "optional": true,
  69                   "description": "List of file extensions that the selected file can have. The list is also used to specify what files to be shown in the select file dialog. Files with the listed extensions are only shown in the dialog. Extensions should not include the leading '.'. Example: ['jpg', 'png']"
  70               }
  71             }
  72           },
  73           {
  74             "name": "callback",
  75             "type": "function",
  76             "description": "Function called upon completion.",
  77             "parameters": [
  78               {
  79                 "name": "result",
  80                 "description": "Result of the method.",
  81                 "type": "object",
  82                 "properties": {
  83                   "success": {
  84                     "type": "boolean",
  85                     "description": "Whether the file has been selected."
  86                   },
  87                   "entry": {
  88                     "type": "object",
  89                     "constructor": "Entry",
  90                     "additionalProperties": { "type": "any" },
  91                     "optional": true,
  92                     "description": "Selected file entry. It will be null if a file hasn't been selected."
  93                   }
  94                 }
  95               }
  96             ]
  97           }
  98         ]
  99       }
 100     ]
 101   }
 102 ]