From a0d5718675a4c66b5e4904c9b90c6f9ea5603160 Mon Sep 17 00:00:00 2001 From: John McLear Date: Tue, 3 Nov 2020 22:28:50 +0000 Subject: [PATCH] docs --- doc/api/hooks_server-side.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/api/hooks_server-side.md b/doc/api/hooks_server-side.md index a319910ba..224d3c7e4 100644 --- a/doc/api/hooks_server-side.md +++ b/doc/api/hooks_server-side.md @@ -751,6 +751,21 @@ exports.exportHtmlAdditionalTagsWithData = function(hook, pad, cb){ }; ``` +## exportEtherpadAdditionalContent +Called from src/node/utils/ExportEtherpad.js and src/node/utils/ImportEtherpad.js + +Things in context: + +Useful for exporting and importing non-pad centric data stored about a pad. For example in ep_comments_page the comments are stored as comments:padId:uniqueIdOfComment and as such when you export .etherpad this data is not included. + +Example: +``` +// Add support for exporting comments metadata +exports.exportEtherpadAdditionalContent = function(hook_name, context, callback){ + return callback(["comments"]); +}; +``` + ## userLeave Called from src/node/handler/PadMessageHandler.js