diff options
| -rw-r--r-- | doc/hook/change_channel.bb | 11 | ||||
| -rw-r--r-- | doc/hooklist.bb | 3 |
2 files changed, 14 insertions, 0 deletions
diff --git a/doc/hook/change_channel.bb b/doc/hook/change_channel.bb new file mode 100644 index 000000000..4514b9265 --- /dev/null +++ b/doc/hook/change_channel.bb @@ -0,0 +1,11 @@ +[h2]change_channel[/h2] + +Called when entering a logged in state in a channel context (as opposed to an account context). +The hook array provides two arguments, 'channel_id' and 'chanx'. 'chanx' is a union of the channel +and xchan records for the now active channel. + +Use this to capture what would traditionally be known as 'login events'. In this platform, login is +a separate authentication activity and doesn't necessarily require "connecting to an identity", which +is what the change_channel activity represents. + + diff --git a/doc/hooklist.bb b/doc/hooklist.bb index bb1bffcf0..66ff1cf71 100644 --- a/doc/hooklist.bb +++ b/doc/hooklist.bb @@ -73,6 +73,9 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the [zrl=[baseurl]/help/hook/bb_translate_video]bb_translate_video[/zrl] Called when extracting embedded services from bbcode video elements (rarely used) +[zrl=[baseurl]/help/hook/change_channel]change_channel[/zrl] + Called when logging in to a channel (either during login or afterward through the channel manager) + [zrl=[baseurl]/help/hook/channel_remove]channel_remove[/zrl] Called when removing a channel |