mirror of
https://github.com/node-red/node-red.git
synced 2023-10-10 13:36:53 +02:00
Updated Editor Runtime API (markdown)
Nick O'Leary
parent
d91bbd50d3
commit
f8fa500c98
@ -234,7 +234,7 @@ The following table shows the simplified runtime api.
|
||||
|api/editor/comms.js|WebSocket /comms|Realtime comms between runtime and editor|*tbd*|
|
||||
</details>
|
||||
|
||||
### Work in progress API
|
||||
# Work in progress API
|
||||
|
||||
## Objects
|
||||
|
||||
@ -334,6 +334,9 @@ The following table shows the simplified runtime api.
|
||||
* [.isStarted(opts)](#RED.isStarted) ⇒ <code>Promise.<Boolean></code>
|
||||
* [.version(opts)](#RED.version) ⇒ <code>Promise.<String></code>
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.comms"></a>
|
||||
|
||||
### RED.comms : <code>object</code>
|
||||
@ -345,6 +348,9 @@ The following table shows the simplified runtime api.
|
||||
* [.subscribe(opts)](#RED.comms.subscribe) ⇒ <code>Promise.<Object></code>
|
||||
* [.unsubscribe(opts)](#RED.comms.unsubscribe) ⇒ <code>Promise.<Object></code>
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.comms.addConnection"></a>
|
||||
|
||||
#### comms.addConnection(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -359,6 +365,9 @@ Registers a new comms connection
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
| opts.client | [<code>CommsConnection</code>](#CommsConnection) | the client connection |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.comms.removeConnection"></a>
|
||||
|
||||
#### comms.removeConnection(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -373,6 +382,9 @@ Unregisters a comms connection
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
| opts.client | [<code>CommsConnection</code>](#CommsConnection) | the client connection |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.comms.subscribe"></a>
|
||||
|
||||
#### comms.subscribe(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -390,6 +402,9 @@ request will trigger retained messages to be sent.
|
||||
| opts.client | [<code>CommsConnection</code>](#CommsConnection) | the client connection |
|
||||
| opts.topic | <code>String</code> | the topic to subscribe to |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.comms.unsubscribe"></a>
|
||||
|
||||
#### comms.unsubscribe(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -405,6 +420,9 @@ TODO: Unsubscribes a comms connection from a given topic
|
||||
| opts.client | [<code>CommsConnection</code>](#CommsConnection) | the client connection |
|
||||
| opts.topic | <code>String</code> | the topic to unsubscribe from |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.flows"></a>
|
||||
|
||||
### RED.flows : <code>object</code>
|
||||
@ -419,6 +437,9 @@ TODO: Unsubscribes a comms connection from a given topic
|
||||
* [.deleteFlow(opts)](#RED.flows.deleteFlow) ⇒ <code>Promise</code>
|
||||
* [.getNodeCredentials(opts)](#RED.flows.getNodeCredentials) ⇒ <code>Promise.<Object></code>
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.flows.getFlows"></a>
|
||||
|
||||
#### flows.getFlows(opts) ⇒ [<code>Promise.<Flows></code>](#Flows)
|
||||
@ -432,6 +453,9 @@ Gets the current flow configuration
|
||||
| opts | <code>Object</code> | |
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.flows.setFlows"></a>
|
||||
|
||||
#### flows.setFlows(opts) ⇒ [<code>Promise.<Flows></code>](#Flows)
|
||||
@ -445,6 +469,9 @@ Sets the current flow configuration
|
||||
| opts | <code>Object</code> | |
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.flows.addFlow"></a>
|
||||
|
||||
#### flows.addFlow(opts) ⇒ <code>Promise.<String></code>
|
||||
@ -459,6 +486,9 @@ Adds a flow configuration
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
| opts.flow | <code>Object</code> | the flow to add |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.flows.getFlow"></a>
|
||||
|
||||
#### flows.getFlow(opts) ⇒ [<code>Promise.<Flow></code>](#Flow)
|
||||
@ -473,6 +503,9 @@ Gets an individual flow configuration
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
| opts.id | <code>Object</code> | the id of the flow to retrieve |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.flows.updateFlow"></a>
|
||||
|
||||
#### flows.updateFlow(opts) ⇒ <code>Promise.<String></code>
|
||||
@ -488,6 +521,9 @@ Updates an existing flow configuration
|
||||
| opts.id | <code>Object</code> | the id of the flow to update |
|
||||
| opts.flow | <code>Object</code> | the flow configuration |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.flows.deleteFlow"></a>
|
||||
|
||||
#### flows.deleteFlow(opts) ⇒ <code>Promise</code>
|
||||
@ -502,6 +538,9 @@ Deletes a flow
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
| opts.id | <code>Object</code> | the id of the flow to delete |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.flows.getNodeCredentials"></a>
|
||||
|
||||
#### flows.getNodeCredentials(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -517,6 +556,9 @@ Gets the safe credentials for a node
|
||||
| opts.type | <code>String</code> | the node type to return the credential information for |
|
||||
| opts.id | <code>String</code> | the node id |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.library"></a>
|
||||
|
||||
### RED.library : <code>object</code>
|
||||
@ -527,6 +569,9 @@ Gets the safe credentials for a node
|
||||
* [.saveEntry(opts)](#RED.library.saveEntry) ⇒ <code>Promise</code>
|
||||
* [.getEntries(opts)](#RED.library.getEntries) ⇒ <code>Promise.<Object></code>
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.library.getEntry"></a>
|
||||
|
||||
#### library.getEntry(opts) ⇒ <code>Promise.<(String\|Object)></code>
|
||||
@ -542,6 +587,9 @@ Gets an entry from the library.
|
||||
| opts.type | <code>String</code> | the type of entry |
|
||||
| opts.path | <code>String</code> | the path of the entry |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.library.saveEntry"></a>
|
||||
|
||||
#### library.saveEntry(opts) ⇒ <code>Promise</code>
|
||||
@ -559,6 +607,9 @@ Saves an entry to the library
|
||||
| opts.meta | <code>Object</code> | any meta data associated with the entry |
|
||||
| opts.body | <code>String</code> | the body of the entry |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.library.getEntries"></a>
|
||||
|
||||
#### library.getEntries(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -573,6 +624,9 @@ Returns a complete listing of all entries of a given type in the library.
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
| opts.type | <code>String</code> | the type of entry |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.nodes"></a>
|
||||
|
||||
### RED.nodes : <code>object</code>
|
||||
@ -591,6 +645,9 @@ Returns a complete listing of all entries of a given type in the library.
|
||||
* [.getIconList(opts)](#RED.nodes.getIconList) ⇒ <code>Promise.<IconList></code>
|
||||
* [.getIcon(opts)](#RED.nodes.getIcon) ⇒ <code>Promise.<Buffer></code>
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.nodes.getNodeInfo"></a>
|
||||
|
||||
#### nodes.getNodeInfo(opts) ⇒ <code>Promise.<NodeInfo></code>
|
||||
@ -605,6 +662,9 @@ Gets the info of an individual node set
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
| opts.id | <code>String</code> | the id of the node set to return |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.nodes.getNodeList"></a>
|
||||
|
||||
#### nodes.getNodeList(opts) ⇒ <code>Promise.<NodeList></code>
|
||||
@ -618,6 +678,9 @@ Gets the list of node modules installed in the runtime
|
||||
| opts | <code>Object</code> | |
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.nodes.getNodeConfig"></a>
|
||||
|
||||
#### nodes.getNodeConfig(opts) ⇒ <code>Promise.<String></code>
|
||||
@ -633,6 +696,9 @@ Gets an individual node's html content
|
||||
| opts.id | <code>String</code> | the id of the node set to return |
|
||||
| opts.lang | <code>String</code> | the locale language to return |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.nodes.getNodeConfigs"></a>
|
||||
|
||||
#### nodes.getNodeConfigs(opts) ⇒ <code>Promise.<String></code>
|
||||
@ -647,6 +713,9 @@ Gets all node html content
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
| opts.lang | <code>String</code> | the locale language to return |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.nodes.getModuleInfo"></a>
|
||||
|
||||
#### nodes.getModuleInfo(opts) ⇒ <code>Promise.<ModuleInfo></code>
|
||||
@ -661,6 +730,9 @@ Gets the info of a node module
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
| opts.module | <code>String</code> | the id of the module to return |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.nodes.addModule"></a>
|
||||
|
||||
#### nodes.addModule(opts) ⇒ <code>Promise.<ModuleInfo></code>
|
||||
@ -676,6 +748,9 @@ Install a new module into the runtime
|
||||
| opts.module | <code>String</code> | the id of the module to install |
|
||||
| opts.version | <code>String</code> | (optional) the version of the module to install |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.nodes.removeModule"></a>
|
||||
|
||||
#### nodes.removeModule(opts) ⇒ <code>Promise</code>
|
||||
@ -690,6 +765,9 @@ Removes a module from the runtime
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
| opts.module | <code>String</code> | the id of the module to remove |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.nodes.setModuleState"></a>
|
||||
|
||||
#### nodes.setModuleState(opts) ⇒ <code>Promise.<ModuleInfo></code>
|
||||
@ -705,6 +783,9 @@ Enables or disables a module in the runtime
|
||||
| opts.module | <code>String</code> | the id of the module to enable or disable |
|
||||
| opts.enabled | <code>String</code> | whether the module should be enabled or disabled |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.nodes.setNodeSetState"></a>
|
||||
|
||||
#### nodes.setNodeSetState(opts) ⇒ <code>Promise.<ModuleInfo></code>
|
||||
@ -720,6 +801,9 @@ Enables or disables a n individual node-set in the runtime
|
||||
| opts.id | <code>String</code> | the id of the node-set to enable or disable |
|
||||
| opts.enabled | <code>String</code> | whether the module should be enabled or disabled |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.nodes.getIconList"></a>
|
||||
|
||||
#### nodes.getIconList(opts) ⇒ <code>Promise.<IconList></code>
|
||||
@ -733,6 +817,9 @@ Gets the list of all icons available in the modules installed within the runtime
|
||||
| opts | <code>Object</code> | |
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.nodes.getIcon"></a>
|
||||
|
||||
#### nodes.getIcon(opts) ⇒ <code>Promise.<Buffer></code>
|
||||
@ -748,6 +835,9 @@ Gets a node icon
|
||||
| opts.module | <code>String</code> | the id of the module requesting the icon |
|
||||
| opts.icon | <code>String</code> | the name of the icon |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects"></a>
|
||||
|
||||
### RED.projects : <code>object</code>
|
||||
@ -785,6 +875,9 @@ Gets a node icon
|
||||
* [.pull(opts)](#RED.projects.pull) ⇒ <code>Promise.<Object></code>
|
||||
* [.push(opts)](#RED.projects.push) ⇒ <code>Promise.<Object></code>
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.listProjects"></a>
|
||||
|
||||
#### projects.listProjects(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -798,6 +891,9 @@ List projects known to the runtime
|
||||
| opts | <code>Object</code> | |
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.createProject"></a>
|
||||
|
||||
#### projects.createProject(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -812,6 +908,9 @@ Create a new project
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
| opts.project | <code>Object</code> | the project information |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.initialiseProject"></a>
|
||||
|
||||
#### projects.initialiseProject(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -827,6 +926,9 @@ Initialises an empty project
|
||||
| opts.id | <code>String</code> | the id of the project to initialise |
|
||||
| opts.project | <code>Object</code> | the project information |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.getActiveProject"></a>
|
||||
|
||||
#### projects.getActiveProject(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -840,6 +942,9 @@ Gets the active project
|
||||
| opts | <code>Object</code> | |
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.setActiveProject"></a>
|
||||
|
||||
#### projects.setActiveProject(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -852,6 +957,9 @@ Gets the active project
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
| opts.id | <code>String</code> | the id of the project to activate |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.getProject"></a>
|
||||
|
||||
#### projects.getProject(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -866,6 +974,9 @@ Gets a projects metadata
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
| opts.id | <code>String</code> | the id of the project to get |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.updateProject"></a>
|
||||
|
||||
#### projects.updateProject(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -881,6 +992,9 @@ Updates the metadata of an existing project
|
||||
| opts.id | <code>String</code> | the id of the project to update |
|
||||
| opts.project | <code>Object</code> | the project information |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.deleteProject"></a>
|
||||
|
||||
#### projects.deleteProject(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -895,6 +1009,9 @@ Deletes a project
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
| opts.id | <code>String</code> | the id of the project to update |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.getStatus"></a>
|
||||
|
||||
#### projects.getStatus(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -910,6 +1027,9 @@ Gets current git status of a project
|
||||
| opts.id | <code>String</code> | the id of the project |
|
||||
| opts.remote | <code>Boolean</code> | whether to include status of remote repos |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.getBranches"></a>
|
||||
|
||||
#### projects.getBranches(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -925,6 +1045,9 @@ Get a list of local branches
|
||||
| opts.id | <code>String</code> | the id of the project |
|
||||
| opts.remote | <code>Boolean</code> | whether to return remote branches (true) or local (false) |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.getBranchStatus"></a>
|
||||
|
||||
#### projects.getBranchStatus(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -940,6 +1063,9 @@ Gets the status of a branch
|
||||
| opts.id | <code>String</code> | the id of the project |
|
||||
| opts.branch | <code>String</code> | the name of the branch |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.setBranch"></a>
|
||||
|
||||
#### projects.setBranch(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -956,6 +1082,9 @@ Sets the current local branch
|
||||
| opts.branch | <code>String</code> | the name of the branch |
|
||||
| opts.create | <code>Boolean</code> | whether to create the branch if it doesn't exist |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.deleteBranch"></a>
|
||||
|
||||
#### projects.deleteBranch(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -972,6 +1101,9 @@ Deletes a branch
|
||||
| opts.branch | <code>String</code> | the name of the branch |
|
||||
| opts.force | <code>Boolean</code> | whether to force delete |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.commit"></a>
|
||||
|
||||
#### projects.commit(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -987,6 +1119,9 @@ Commits the current staged files
|
||||
| opts.id | <code>String</code> | the id of the project |
|
||||
| opts.message | <code>String</code> | the message to associate with the commit |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.getCommit"></a>
|
||||
|
||||
#### projects.getCommit(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -1002,6 +1137,9 @@ Gets the details of a single commit
|
||||
| opts.id | <code>String</code> | the id of the project |
|
||||
| opts.sha | <code>String</code> | the sha of the commit to return |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.getCommits"></a>
|
||||
|
||||
#### projects.getCommits(opts) ⇒ <code>Promise.<Array></code>
|
||||
@ -1018,6 +1156,9 @@ Gets the commit history of the project
|
||||
| opts.limit | <code>String</code> | limit how many to return |
|
||||
| opts.before | <code>String</code> | id of the commit to work back from |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.abortMerge"></a>
|
||||
|
||||
#### projects.abortMerge(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -1032,6 +1173,9 @@ Abort an in-progress merge
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
| opts.id | <code>String</code> | the id of the project |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.resolveMerge"></a>
|
||||
|
||||
#### projects.resolveMerge(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -1048,6 +1192,9 @@ Resolves a merge conflict
|
||||
| opts.path | <code>String</code> | the path of the file being merged |
|
||||
| opts.resolutions | <code>String</code> | how to resolve the merge conflict |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.getFiles"></a>
|
||||
|
||||
#### projects.getFiles(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -1062,6 +1209,9 @@ Gets a listing of the files in the project
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
| opts.id | <code>String</code> | the id of the project |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.getFile"></a>
|
||||
|
||||
#### projects.getFile(opts) ⇒ <code>Promise.<String></code>
|
||||
@ -1078,6 +1228,9 @@ Gets the contents of a file
|
||||
| opts.path | <code>String</code> | the path of the file |
|
||||
| opts.tree | <code>String</code> | the version control tree to use |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.stageFile"></a>
|
||||
|
||||
#### projects.stageFile(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -1091,6 +1244,9 @@ Gets the contents of a file
|
||||
| opts.id | <code>String</code> | the id of the project |
|
||||
| opts.path | <code>String</code> \| <code>Array</code> | the path of the file, or an array of paths |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.unstageFile"></a>
|
||||
|
||||
#### projects.unstageFile(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -1104,6 +1260,9 @@ Gets the contents of a file
|
||||
| opts.id | <code>String</code> | the id of the project |
|
||||
| opts.path | <code>String</code> | the path of the file. If not set, all staged files are unstaged |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.revertFile"></a>
|
||||
|
||||
#### projects.revertFile(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -1119,6 +1278,9 @@ Reverts changes to a file back to its commited version
|
||||
| opts.id | <code>String</code> | the id of the project |
|
||||
| opts.path | <code>String</code> | the path of the file |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.getFileDiff"></a>
|
||||
|
||||
#### projects.getFileDiff(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -1135,6 +1297,9 @@ Get the diff of a file
|
||||
| opts.path | <code>String</code> | the path of the file |
|
||||
| opts.type | <code>String</code> | the type of diff |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.getRemotes"></a>
|
||||
|
||||
#### projects.getRemotes(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -1149,6 +1314,9 @@ Gets a list of the project remotes
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
| opts.id | <code>String</code> | the id of the project |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.addRemote"></a>
|
||||
|
||||
#### projects.addRemote(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -1164,6 +1332,9 @@ Gets a list of the project remotes
|
||||
| opts.remote.name | <code>String</code> | the name of the remote |
|
||||
| opts.remote.url | <code>String</code> | the url of the remote |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.removeRemote"></a>
|
||||
|
||||
#### projects.removeRemote(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -1179,6 +1350,9 @@ Remove a project remote
|
||||
| opts.id | <code>String</code> | the id of the project |
|
||||
| opts.remote | <code>String</code> | the name of the remote |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.updateRemote"></a>
|
||||
|
||||
#### projects.updateRemote(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -1193,6 +1367,9 @@ Remove a project remote
|
||||
| opts.remote | <code>Object</code> | the remote metadata |
|
||||
| opts.remote.name | <code>String</code> | the name of the remote |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.pull"></a>
|
||||
|
||||
#### projects.pull(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -1206,6 +1383,9 @@ Pull changes from the remote
|
||||
| opts | <code>Object</code> | |
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.projects.push"></a>
|
||||
|
||||
#### projects.push(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -1222,6 +1402,9 @@ Push changes to a remote
|
||||
| opts.remote | <code>String</code> | the name of the remote |
|
||||
| opts.track | <code>String</code> | whether to set the remote as the upstream |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.settings"></a>
|
||||
|
||||
### RED.settings : <code>object</code>
|
||||
@ -1236,6 +1419,9 @@ Push changes to a remote
|
||||
* [.generateUserKey(opts)](#RED.settings.generateUserKey) ⇒ <code>Promise.<String></code>
|
||||
* [.removeUserKey(opts)](#RED.settings.removeUserKey) ⇒ <code>Promise</code>
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.settings.getRuntimeSettings"></a>
|
||||
|
||||
#### settings.getRuntimeSettings(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -1249,6 +1435,9 @@ Gets the runtime settings object
|
||||
| opts | <code>Object</code> | |
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.settings.getUserSettings"></a>
|
||||
|
||||
#### settings.getUserSettings(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -1262,6 +1451,9 @@ Gets an individual user's settings object
|
||||
| opts | <code>Object</code> | |
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.settings.updateUserSettings"></a>
|
||||
|
||||
#### settings.updateUserSettings(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -1276,6 +1468,9 @@ Updates an individual user's settings object.
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
| opts.settings | <code>Object</code> | the updates to the user settings |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.settings.getUserKeys"></a>
|
||||
|
||||
#### settings.getUserKeys(opts) ⇒ <code>Promise.<Object></code>
|
||||
@ -1289,6 +1484,9 @@ Gets a list of a user's ssh keys
|
||||
| opts | <code>Object</code> | |
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.settings.getUserKey"></a>
|
||||
|
||||
#### settings.getUserKey(opts) ⇒ <code>Promise.<String></code>
|
||||
@ -1303,6 +1501,9 @@ Gets a user's ssh public key
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
| opts.id | [<code>User</code>](#User) | the id of the key to return |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.settings.generateUserKey"></a>
|
||||
|
||||
#### settings.generateUserKey(opts) ⇒ <code>Promise.<String></code>
|
||||
@ -1320,6 +1521,9 @@ Generates a new ssh key pair
|
||||
| opts.comment | [<code>User</code>](#User) | (option) a comment to associate with the key pair |
|
||||
| opts.size | [<code>User</code>](#User) | (optional) the size of the key. Default: 2048 |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.settings.removeUserKey"></a>
|
||||
|
||||
#### settings.removeUserKey(opts) ⇒ <code>Promise</code>
|
||||
@ -1334,6 +1538,9 @@ Deletes a user's ssh key pair
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
| opts.id | [<code>User</code>](#User) | the id of the key to delete |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.isStarted"></a>
|
||||
|
||||
### RED.isStarted(opts) ⇒ <code>Promise.<Boolean></code>
|
||||
@ -1347,6 +1554,9 @@ Returns whether the runtime is started
|
||||
| opts | <code>Object</code> | |
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="RED.version"></a>
|
||||
|
||||
### RED.version(opts) ⇒ <code>Promise.<String></code>
|
||||
@ -1360,6 +1570,9 @@ Returns version number of the runtime
|
||||
| opts | <code>Object</code> | |
|
||||
| opts.user | [<code>User</code>](#User) | the user calling the api |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="CommsConnection"></a>
|
||||
|
||||
## CommsConnection : <code>object</code>
|
||||
@ -1372,6 +1585,9 @@ Returns version number of the runtime
|
||||
| user | <code>Object</code> | the user associated with the connection |
|
||||
| send | <code>function</code> | publish a message to the connection |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="Flows"></a>
|
||||
|
||||
## Flows : <code>object</code>
|
||||
@ -1383,6 +1599,9 @@ Returns version number of the runtime
|
||||
| rev | <code>string</code> | the flow revision identifier |
|
||||
| flows | <code>Array</code> | the flow configuration, an array of node configuration objects |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="Flow"></a>
|
||||
|
||||
## Flow : <code>object</code>
|
||||
@ -1395,6 +1614,9 @@ Returns version number of the runtime
|
||||
| label | <code>string</code> | a label for the flow |
|
||||
| nodes | <code>Array</code> | an array of node configuration objects |
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="User"></a>
|
||||
|
||||
## User : <code>object</code>
|
||||
@ -1402,4 +1624,5 @@ A user accessing the API
|
||||
|
||||
**Kind**: global typedef
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user