MyFavMirrors/MeshCentral
1
0
Fork 0
mirror of https://github.com/Ylianst/MeshCentral.git synced 2024-12-26 23:25:53 -05:00
Code Issues Packages Projects Releases Wiki Activity

Documentation updates for new hooks

Browse Source
This commit is contained in:
Ryan Blenis 2019-12-26 10:56:10 -05:00
parent 26de76579c
commit d5fb308caa
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
plugin_development.md
View File

@ -62,6 +62,7 @@ These are separated into the following categories depending on the type of funct
`onDeviceRefeshEnd`: called when a device is selected in the MeshCentral web interface `onDeviceRefeshEnd`: called when a device is selected in the MeshCentral web interface
`registerPluginTab`: callable when a device is selected in the MeshCentral web interface to register a new tab for plugin data, if required. Accepts an object, or function that returns an object, with the following properties: { tabId: "yourShortNameHere", tabTitle: "Your Display Name"}. A tab and div with the associated ID and title will be created for your use `registerPluginTab`: callable when a device is selected in the MeshCentral web interface to register a new tab for plugin data, if required. Accepts an object, or function that returns an object, with the following properties: { tabId: "yourShortNameHere", tabTitle: "Your Display Name"}. A tab and div with the associated ID and title will be created for your use
`onDesktopDisconnect`: called when a remote desktop session is disconnected `onDesktopDisconnect`: called when a remote desktop session is disconnected
`onWebUIStartupEnd`: called when the page has loaded for the first time after a login / refresh
#### Exports #### Exports
Any function can be exported to the Web UI layer by adding the name of the function to an `exports` array in the plugin object. Any function can be exported to the Web UI layer by adding the name of the function to an `exports` array in the plugin object.
@ -70,6 +71,7 @@ Any function can be exported to the Web UI layer by adding the name of the funct
`server_startup`: called once when the server starts (or when the plugin is first installed) `server_startup`: called once when the server starts (or when the plugin is first installed)
`hook_agentCoreIsStable`: called once when an agent initially checks in `hook_agentCoreIsStable`: called once when an agent initially checks in
`hook_processAgentData`: called each time an agent transmits data back to the server `hook_processAgentData`: called each time an agent transmits data back to the server
`hook_userLoggedIn`: called when a user has logged into the web interface
### Mesh Agent ### Mesh Agent
Use of the optional file `plugin_name.js` in the optional folder `modules_meshcore` will include the file in the default meshcore file sent to each endpoint. This is useful to add functionality on each of the endpoints. Use of the optional file `plugin_name.js` in the optional folder `modules_meshcore` will include the file in the default meshcore file sent to each endpoint. This is useful to add functionality on each of the endpoints.