From d691b63be236f14d9f9029615b5dba6d29a0fe52 Mon Sep 17 00:00:00 2001 From: Ed Kellett Date: Wed, 29 Apr 2020 11:01:39 +0100 Subject: [PATCH] Document invite hooks --- doc/technical/hooks.txt | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/doc/technical/hooks.txt b/doc/technical/hooks.txt index e3fb1a01..32611a69 100644 --- a/doc/technical/hooks.txt +++ b/doc/technical/hooks.txt @@ -114,6 +114,23 @@ The following hooks are called during various events related to clients. oldsnomask = new snomask field +Channel Hooks +------------- + +"can_invite" - Called before deciding whether to allow the + /invite command + hdata->chptr = channel being invited to + hdata->msptr = membership of inviter + hdata->client = inviter + hdata->target = invite target + hdata->approved = zero to allow + hdata->error = NULL, or error message + if non-null, `approved` is the numeric +"invite" - Called just before effecting an invite on the + target's server + hdata = as above + + The following are for debugging and take struct hook_io_data for arguments. These can be used for a variety of purposes, but are aimed at the developer community.