aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorzotlabs <mike@macgirvin.com>2017-08-01 22:25:55 -0700
committerzotlabs <mike@macgirvin.com>2017-08-01 22:25:55 -0700
commit9359f9fe4d77de392660c2bf6f1df8becc9fa6bf (patch)
tree51e60f04251f0c2334605a41554e5b53e4ca45a8 /doc
parent01526a9a79294fe5f96b7c3bfbd362f91feec433 (diff)
downloadvolse-hubzilla-9359f9fe4d77de392660c2bf6f1df8becc9fa6bf.tar.gz
volse-hubzilla-9359f9fe4d77de392660c2bf6f1df8becc9fa6bf.tar.bz2
volse-hubzilla-9359f9fe4d77de392660c2bf6f1df8becc9fa6bf.zip
plugin hook for update_unseen
Diffstat (limited to 'doc')
-rw-r--r--doc/hook/update_unseen.bb9
-rw-r--r--doc/hooklist.bb3
2 files changed, 12 insertions, 0 deletions
diff --git a/doc/hook/update_unseen.bb b/doc/hook/update_unseen.bb
new file mode 100644
index 000000000..8fb02c239
--- /dev/null
+++ b/doc/hook/update_unseen.bb
@@ -0,0 +1,9 @@
+[h3]update_unseen[/h3]
+
+Called prior to automatically marking items 'seen'; allowing a plugin the choice to not perform this action.
+
+hook data
+
+[ 'channel_id' => local_channel(), 'update' => 'unset' ];
+
+If 'update' is set to 0 or false on return, the update operation is not performed. \ No newline at end of file
diff --git a/doc/hooklist.bb b/doc/hooklist.bb
index da4d9596b..9a17fdb91 100644
--- a/doc/hooklist.bb
+++ b/doc/hooklist.bb
@@ -572,6 +572,9 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the
[zrl=[baseurl]/help/hook/tagged]tagged[/zrl]
Called when a delivery is processed which results in you being tagged
+[zrl=[baseurl]/help/hook/update_unseen]update_unseen[/zrl]
+ Called prior to automatically marking items seen which were loaded in the browser
+
[zrl=[baseurl]/help/hook/validate_channelname]validate_channelname[/zrl]
Used to validate the names used by a channel