diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/hook/check_channelallowed.bb | 11 | ||||
| -rw-r--r-- | doc/hook/check_siteallowed.bb | 10 | ||||
| -rw-r--r-- | doc/hooklist.bb | 6 |
3 files changed, 27 insertions, 0 deletions
diff --git a/doc/hook/check_channelallowed.bb b/doc/hook/check_channelallowed.bb new file mode 100644 index 000000000..e7559c92f --- /dev/null +++ b/doc/hook/check_channelallowed.bb @@ -0,0 +1,11 @@ +[h2]check_channelallowed[/h2] + +Called when checking the channel (xchan) black and white lists to see if a channel is blocked. + +Hook data + + array('hash' => xchan_hash of xchan to check); + + create and set array element 'allowed' to true or false to override the system checks + + diff --git a/doc/hook/check_siteallowed.bb b/doc/hook/check_siteallowed.bb new file mode 100644 index 000000000..28134cbd2 --- /dev/null +++ b/doc/hook/check_siteallowed.bb @@ -0,0 +1,10 @@ +[h2]check_siteallowed[/h2] + +Called when checking the site black and white lists to see if a site is blocked. + +Hook data + + array('url' => URL of site to check); + + create and set array element 'allowed' to true or false to override the system checks + diff --git a/doc/hooklist.bb b/doc/hooklist.bb index 45a4861d9..9172628a0 100644 --- a/doc/hooklist.bb +++ b/doc/hooklist.bb @@ -82,6 +82,12 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the [zrl=[baseurl]/help/hook/check_account_password]check_account_password[/zrl] Used to provide policy control over account passwords (minimum length, character set inclusion, etc.) +[zrl=[baseurl]/help/hook/check_channelallowed]check_channelallowed[/zrl] + Used to over-ride or bypass the channel black/white block lists + +[zrl=[baseurl]/help/hook/check_siteallowed]check_siteallowed[/zrl] + Used to over-ride or bypass the site black/white block lists + [zrl=[baseurl]/help/hook/connect_premium]connect_premium[/zrl] Called when connecting to a premium channel |