document the new change_channel hook

This commit is contained in:
redmatrix
2016-07-11 17:43:10 -07:00
parent 833de9180e
commit 17c3e12eab
2 changed files with 14 additions and 0 deletions

View File

@@ -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.