Difference between revisions of "2.0/Modules/cs suspend"

From AnopeWiki
Jump to: navigation, search
(Created page with "{{Language|2.0/Modules/cs_suspend}} {{Syntax|cs_suspend|ChanServ|Anope}} == <div class="moduleheader">Description</div> == Disallows anyone from using the given channel when ...")
 
(No difference)

Latest revision as of 20:55, 6 May 2014

Language

English

Service ChanServ
Module cs_suspend
Author Anope

Description

Disallows anyone from using the given channel when suspended.

Commands

suspend channel [+expiry] [reason]
Disallows anyone from using the given channel. May be cancelled by using the UNSUSPEND command to preserve all previous channel data/settings. If an expiry is given the channel will be unsuspended after that period of time, else the default expiry from the configuration is used.
Reason may be required on certain networks.
Access to this command requires the permission chanserv/suspend to be present in your opertype.
unsuspend channel
Releases a suspended channel. All data and settings are preserved from before the suspension.
Access to this command requires the permission chanserv/suspend to be present in your opertype.

Examples

/msg ChanServ SUSPEND #myChannel +30d Locked out for abuse.

/msg ChanServ UNSUSPEND #myChannel

Default Configuration

/*
 * cs_suspend
 *
 * Provides the commands chanserv/suspend and chanserv/unsuspend.
 *
 * Used for suspending and unsuspending channels. Suspended channels can not be used but their settings are stored.
 */
module
{
        name = "cs_suspend"
 
        /*
         * The length of time before a suspended channel expires.
         *
         * This directive is optional.
         * If not set, the default is never.
         */
        expire = 90d
}
command { service = "ChanServ"; name = "SUSPEND"; command = "chanserv/suspend"; permission = "chanserv/suspend"; group = "chanserv/admin"; }
command { service = "ChanServ"; name = "UNSUSPEND"; command = "chanserv/unsuspend"; permission = "chanserv/suspend"; group = "chanserv/admin"; }