aboutsummaryrefslogtreecommitdiffstats
path: root/doc/hook/channel_links.bb
diff options
context:
space:
mode:
Diffstat (limited to 'doc/hook/channel_links.bb')
-rw-r--r--doc/hook/channel_links.bb12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/hook/channel_links.bb b/doc/hook/channel_links.bb
new file mode 100644
index 000000000..c0243dac6
--- /dev/null
+++ b/doc/hook/channel_links.bb
@@ -0,0 +1,12 @@
+[h2]channel_links[/h2]
+
+Called when generating the Link HTTP header for the channel page. Different protocol stacks can add links to this header.
+
+Hook data = array
+ 'channel_address' => channel nickname, no checking is done to see if it is valid
+ 'channel_links' => array of channel links in the format
+ 'url' => url of resource
+ 'rel' => link relation
+ 'type' => MIME type
+
+All fields are required \ No newline at end of file