{
"name": "copy",
"type": "function",
- "description": "Copies the given bookmarks into the clipboard",
+ "description": "Copies the given bookmarks into the clipboard.",
"parameters": [
{
"name": "idList",
{
"name": "cut",
"type": "function",
- "description": "Cuts the given bookmarks into the clipboard",
+ "description": "Cuts the given bookmarks into the clipboard.",
"parameters": [
{
"name": "idList",
{
"name": "paste",
"type": "function",
- "description": "Pastes bookmarks from the clipboard into the parent folder after the last selected node",
+ "description": "Pastes bookmarks from the clipboard into the parent folder after the last selected node.",
"parameters": [
{"type": "string", "name": "parentId"},
{
"name": "selectedIdList",
- "description": "An array of string-valued ids for selected bookmarks",
+ "description": "An array of string-valued ids for selected bookmarks.",
"optional": true,
"type": "array",
"items": {"type": "string"},
{
"name": "canPaste",
"type": "function",
- "description": "Whether there are any bookmarks that can be pasted",
+ "description": "Whether there are any bookmarks that can be pasted.",
"parameters": [
- {"type": "string", "name": "parentId", "description": "The ID of the folder to paste into"},
+ {"type": "string", "name": "parentId", "description": "The ID of the folder to paste into."},
{"type": "function", "name": "callback", "parameters": [
{"name": "result", "type": "boolean"}
]}
{
"name": "sortChildren",
"type": "function",
- "description": "Sorts the children of a given folder",
+ "description": "Sorts the children of a given folder.",
"parameters": [
- {"type": "string", "name": "parentId", "description": "The ID of the folder to sort the children of"}
+ {"type": "string", "name": "parentId", "description": "The ID of the folder to sort the children of."}
]
},
{
"name": "getStrings",
"type": "function",
- "description": "Gets the i18n strings for the bookmark manager",
+ "description": "Gets the i18n strings for the bookmark manager.",
"parameters": [
{
"type": "function",
{
"name": "startDrag",
"type": "function",
- "description": "Begins dragging a set of bookmarks",
+ "description": "Begins dragging a set of bookmarks.",
"parameters": [
{
"name": "idList",
- "description": "An array of string-valued ids",
+ "description": "An array of string-valued ids.",
"type": "array",
"items": {"type": "string"},
"minItems": 1
{
"name": "isFromTouch",
"type": "boolean",
- "description": "True if the drag was initiated from touch"
+ "description": "True if the drag was initiated from touch."
}
]
},
{
"name": "drop",
"type": "function",
- "description": "Performs the drop action of the drag and drop session",
+ "description": "Performs the drop action of the drag and drop session.",
"parameters": [
{
"name": "parentId",
- "description": "The ID of the folder that the drop was made",
+ "description": "The ID of the folder that the drop was made.",
"type": "string"
},
{
"name": "index",
- "description": "The index of the position to drop at. If left out the dropped items will be placed at the end of the existing children",
+ "description": "The index of the position to drop at. If left out the dropped items will be placed at the end of the existing children.",
"type": "integer",
"minimum": 0,
"optional": true
{
"name": "canEdit",
"type": "function",
- "description": "Whether bookmarks can be modified",
+ "description": "Whether bookmarks can be modified.",
"parameters": [
{"type": "function", "name": "callback", "parameters": [
{"name": "result", "type": "boolean"}
{
"name": "canOpenNewWindows",
"type": "function",
- "description": "Whether bookmarks can be opened in new windows",
+ "description": "Whether bookmarks can be opened in new windows.",
"parameters": [
{"type": "function", "name": "callback", "parameters": [
{"name": "result", "type": "boolean"}
"parameters": [
{
"name": "idList",
- "description": "An array of string-valued ids",
+ "description": "An array of string-valued ids.",
"type": "array",
"items": {"type": "string"},
"minItems": 1
{
"name": "getMetaInfo",
"type": "function",
- "description": "Gets meta info from a bookmark node",
+ "description": "Gets meta info from a bookmark node.",
"allowAmbiguousOptionalArguments": true,
"parameters": [
{
},
{
"name": "key",
- "description": "The key for the meta info to retrieve. If omitted, all fields are returned",
+ "description": "The key for the meta info to retrieve. If omitted, all fields are returned.",
"optional": true,
"type": "string"
},
{
"name": "setMetaInfo",
"type": "function",
- "description": "Sets a meta info value for a bookmark node",
+ "description": "Sets a meta info value for a bookmark node.",
"parameters": [
{
"name": "id",
- "description": "The id of the bookmark node to set the meta info on",
+ "description": "The id of the bookmark node to set the meta info on.",
"type": "string"
},
{
"name": "key",
- "description": "The key of the meta info to set",
+ "description": "The key of the meta info to set.",
"type": "string"
},
{
"name": "value",
- "description": "The meta info to set",
+ "description": "The meta info to set.",
"type": "string"
},
{
{
"name": "undo",
"type": "function",
- "description": "Performs an undo of the last change to the bookmark model",
+ "description": "Performs an undo of the last change to the bookmark model.",
"parameters": []
},
{
"name": "redo",
"type": "function",
- "description": "Performs a redo of last undone change to the bookmark model",
+ "description": "Performs a redo of last undone change to the bookmark model.",
"parameters": []
},
{
"name": "getUndoInfo",
"type": "function",
- "description": "Gets the information for the undo if available",
+ "description": "Gets the information for the undo if available.",
"parameters": [
{
"type": "function",
"name": "result",
"type": "object",
"properties": {
- "enabled" : {"type": "boolean", "description": "Whether there is an action to undo"},
- "label" : {"type": "string", "description": "The i18n label to use for the undo action"}
+ "enabled" : {"type": "boolean", "description": "Whether there is an action to undo."},
+ "label" : {"type": "string", "description": "The i18n label to use for the undo action."}
}
}
]
{
"name": "getRedoInfo",
"type": "function",
- "description": "Gets the information for the redo if available",
+ "description": "Gets the information for the redo if available.",
"parameters": [
{
"type": "function",
"properties": {
"enabled" : {"type": "boolean", "description": "Whether there is an action to redo"},
"label" : {"type": "string", "description": "The i18n label to use for the redo action"}
- }
+ }
}
]
}
]
+ },
+ {
+ "name": "setVersion",
+ "type": "function",
+ "description": "Sets the version to use when updating enhanced bookmarks.",
+ "parameters": [
+ {
+ "type": "string",
+ "name": "version",
+ "description": "The version to set."
+ },
+ {
+ "type": "function",
+ "name": "callback",
+ "optional": true,
+ "parameters": []
+ }
+ ]
}
],
"events": [
{
"name": "onDragEnter",
"type": "function",
- "description": "Fired when dragging bookmarks over the document",
+ "description": "Fired when dragging bookmarks over the document.",
"parameters": [
{"name": "bookmarkNodeData", "$ref": "BookmarkNodeData"}
]
{
"name": "onDragLeave",
"type": "function",
- "description": "Fired when the drag and drop leaves the document",
+ "description": "Fired when the drag and drop leaves the document.",
"parameters": [
{"name": "bookmarkNodeData", "$ref": "BookmarkNodeData"}
]
{
"name": "onDrop",
"type": "function",
- "description": "Fired when the user drops bookmarks on the document",
+ "description": "Fired when the user drops bookmarks on the document.",
"parameters": [
{"name": "bookmarkNodeData", "$ref": "BookmarkNodeData"}
]