chrome/common/extensions/api/file_browser_handler_internal.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": "fileBrowserHandlerInternal",
   8     "compiler_options": {
   9       "implemented_in": "chrome/browser/chromeos/extensions/file_manager/file_browser_handler_api.h"
  10     },
  11     "description": "none",
  12     "platforms": ["chromeos"],
  13     "types": [
  14       {
  15         "id": "FileEntryInfo",
  16         "type": "object",
  17         "description": "Information needed to build a file entry that will be returned through the API.",
  18         "properties": {
  19           "fileSystemName": {
  20             "type": "string"
  21           },
  22           "fileSystemRoot": {
  23             "type": "string"
  24           },
  25           "fileFullPath": {
  26             "type": "string"
  27           },
  28           "fileIsDirectory": {
  29             "type": "boolean"
  30           }
  31         }
  32       }
  33     ],
  34
  35     "functions": [
  36       {
  37         "name": "selectFile",
  38         "type": "function",
  39         "description": "Prompts user to select file path under which a new file will be created. If the user selects file, the file gets created or, if it already exists, truncated. The function has to be called with user gesture.",
  40         "parameters": [
  41           {
  42             "name": "selectionParams",
  43             "type": "object",
  44             "description": "Parameters that will be used to create new file.",
  45             "properties": {
  46               "suggestedName": {
  47                   "type": "string",
  48                   "description": "Suggested name for the new file."
  49               },
  50               "allowedFileExtensions": {
  51                   "type": "array",
  52                   "items": { "type": "string" },
  53                   "optional": true,
  54                   "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']"
  55               }
  56             }
  57           },
  58           {
  59             "name": "callback",
  60             "type": "function",
  61             "description": "Function called upon completion.",
  62             "parameters": [
  63               {
  64                 "name": "result",
  65                 "description": "Result of the method.",
  66                 "type": "object",
  67                 "properties": {
  68                   "success": {
  69                     "type": "boolean",
  70                     "description": "Has the file been selected."
  71                   },
  72                   "entry": {
  73                     "$ref": "FileEntryInfo",
  74                     "optional": true,
  75                     "description": "Selected file entry."
  76                   }
  77                 }
  78               }
  79             ]
  80           }
  81         ]
  82       }
  83     ]
  84   }
  85 ]