Anope IRC Services  Version 2.0
Public Member Functions | Private Member Functions
CommandOSSession Class Reference
Inheritance diagram for CommandOSSession:
Inheritance graph
Collaboration diagram for CommandOSSession:
Collaboration graph

Public Member Functions

 CommandOSSession (Module *creator)
void Execute (CommandSource &source, const std::vector< Anope::string > &params) anope_override
bool OnHelp (CommandSource &source, const Anope::string &subcommand) anope_override
- Public Member Functions inherited from Command
virtual ~Command ()
bool AllowUnregistered () const
bool RequireUser () const
virtual const Anope::string GetDesc (CommandSource &source) const
virtual void OnServHelp (CommandSource &source)
virtual void OnSyntaxError (CommandSource &source, const Anope::string &subcommand)
- Public Member Functions inherited from Service
 Service (Module *o, const Anope::string &t, const Anope::string &n)
virtual ~Service ()
void Register ()
void Unregister ()
- Public Member Functions inherited from Base
 Base ()
virtual ~Base ()
void AddReference (ReferenceBase *r)
void DelReference (ReferenceBase *r)

Private Member Functions

void DoList (CommandSource &source, const std::vector< Anope::string > &params)
void DoView (CommandSource &source, const std::vector< Anope::string > &params)

Additional Inherited Members

- Static Public Member Functions inherited from Command
static void Run (CommandSource &source, const Anope::string &message)
static bool FindCommandFromService (const Anope::string &command_service, BotInfo *&bi, Anope::string &name)
- Static Public Member Functions inherited from Service
static ServiceFindService (const Anope::string &t, const Anope::string &n)
static std::vector< Anope::stringGetServiceKeys (const Anope::string &t)
static void AddAlias (const Anope::string &t, const Anope::string &n, const Anope::string &v)
static void DelAlias (const Anope::string &t, const Anope::string &n)
- Data Fields inherited from Command
size_t max_params
size_t min_params
- Data Fields inherited from Service
Anope::string type
Anope::string name
- Protected Member Functions inherited from Command
 Command (Module *owner, const Anope::string &sname, size_t min_params, size_t max_params=0)
void SetDesc (const Anope::string &d)
void ClearSyntax ()
void SetSyntax (const Anope::string &s)
void SendSyntax (CommandSource &)
void AllowUnregistered (bool b)
void RequireUser (bool b)

Detailed Description

Definition at line 173 of file os_session.cpp.

Constructor & Destructor Documentation

CommandOSSession::CommandOSSession ( Module creator)

Definition at line 243 of file os_session.cpp.

References _, Command::SetDesc(), and Command::SetSyntax().

Member Function Documentation

void CommandOSSession::DoList ( CommandSource source,
const std::vector< Anope::string > &  params 
void CommandOSSession::DoView ( CommandSource source,
const std::vector< Anope::string > &  params 
void CommandOSSession::Execute ( CommandSource source,
const std::vector< Anope::string > &  params 

Execute this command.

sourceThe source
paramsCommand parameters

Implements Command.

Definition at line 250 of file os_session.cpp.

References _, DoList(), DoView(), Anope::string::equals_ci(), LOG_ADMIN, and Command::OnSyntaxError().

bool CommandOSSession::OnHelp ( CommandSource source,
const Anope::string subcommand 

Requested when the user is requesting help on this command. Help on this command should be sent to the user.

sourceThe source
subcommandThe subcommand the user is requesting help on, or an empty string. (e.g. /ns help set foo bar lol gives a subcommand of "FOO BAR LOL")
true if help was provided to the user, false otherwise.

Reimplemented from Command.

Definition at line 266 of file os_session.cpp.

References _, and Command::SendSyntax().

The documentation for this class was generated from the following file: