aboutsummaryrefslogtreecommitdiffstats
path: root/doc/hook
diff options
context:
space:
mode:
authorzotlabs <mike@macgirvin.com>2017-01-31 15:28:25 -0800
committerzotlabs <mike@macgirvin.com>2017-01-31 15:28:25 -0800
commit732065bf13af96f680bc9874afee71c07f74e40a (patch)
treef7bacb814f9ca13dada49932778a41bdfb76e99a /doc/hook
parenta6cbebe03c4c1ca66b4b55c340ebb1d369d93c3a (diff)
downloadvolse-hubzilla-732065bf13af96f680bc9874afee71c07f74e40a.tar.gz
volse-hubzilla-732065bf13af96f680bc9874afee71c07f74e40a.tar.bz2
volse-hubzilla-732065bf13af96f680bc9874afee71c07f74e40a.zip
channel export - use a selected list of functional data categories to export; this allows one to export single data sets instead of always exporting everything we know about
Diffstat (limited to 'doc/hook')
-rw-r--r--doc/hook/get_default_export_sections10
-rw-r--r--doc/hook/identity_basic_export.bb9
2 files changed, 19 insertions, 0 deletions
diff --git a/doc/hook/get_default_export_sections b/doc/hook/get_default_export_sections
new file mode 100644
index 000000000..09b146643
--- /dev/null
+++ b/doc/hook/get_default_export_sections
@@ -0,0 +1,10 @@
+[h3]get_default_export_sections[/h3]
+
+The get_default_export_sections call returns the basic functional groups of data to export using channel_export_basic().
+
+The hook is passed an array
+ [
+ 'sections' => [ 'channel', 'connections', 'config', 'apps', 'chatrooms', 'events', 'webpages', 'mail', 'wikis' ]
+ ]
+
+If you desire the export to contain three months of items, add 'items' to the 'sections' array
diff --git a/doc/hook/identity_basic_export.bb b/doc/hook/identity_basic_export.bb
index 3f4e88799..71329ba1e 100644
--- a/doc/hook/identity_basic_export.bb
+++ b/doc/hook/identity_basic_export.bb
@@ -1 +1,10 @@
[h2]identity_basic_export[/h2]
+
+Called when exporting data for a channel
+Passed array contains
+
+ [
+ 'channel_id' => channel_id being exported
+ 'sections' => array of functional export sections which are being exported
+ 'data' => the export data array which has been generated
+ ]