Anope IRC Services  Version 2.0
Public Member Functions | Private Attributes
AnopeXMLRPC Class Reference

Public Member Functions

 __construct ($Host)
 
 RunXMLRPC ($name, $params)
 
 DoCommand ($Service, $User, $Command)
 
 CheckAuthentication ($Account, $Pass)
 
 DoStats ()
 
 DoChannel ($Channel)
 
 DoUser ($User)
 

Private Attributes

 $Host
 

Detailed Description

Definition at line 9 of file xmlrpc.php.

Constructor & Destructor Documentation

AnopeXMLRPC::__construct (   $Host)

Definition at line 13 of file xmlrpc.php.

References $Host.

Member Function Documentation

AnopeXMLRPC::CheckAuthentication (   $Account,
  $Pass 
)

Check an account/nick name and password to see if they are valid Returns the account display name if valid

Definition at line 55 of file xmlrpc.php.

References RunXMLRPC().

AnopeXMLRPC::DoChannel (   $Channel)

Definition at line 75 of file xmlrpc.php.

References RunXMLRPC().

AnopeXMLRPC::DoCommand (   $Service,
  $User,
  $Command 
)

Do Command on Service as User, eg: $anope->DoCommand("ChanServ", "Adam", "REGISTER #adam"); Returns an array of information regarding the command execution, if If 'online' is set to yes, then the reply to the command was sent to the user on IRC. If 'online' is set to no, then the reply to the command is in the array member 'return'

Definition at line 47 of file xmlrpc.php.

References RunXMLRPC().

AnopeXMLRPC::DoStats ( )

Definition at line 66 of file xmlrpc.php.

References RunXMLRPC().

AnopeXMLRPC::DoUser (   $User)

Definition at line 82 of file xmlrpc.php.

References RunXMLRPC().

AnopeXMLRPC::RunXMLRPC (   $name,
  $params 
)

Run an XMLRPC command. Name should be a query name and params an array of parameters, eg: $this->RunXMLRPC("checkAuthentication", array("adam", "qwerty")); If successful returns back an array of useful information.

Note that $params["id"] is reserved for query ID, you may set it to something if you wish. If you do, the same ID will be passed back with the reply from Anope.

Definition at line 25 of file xmlrpc.php.

Referenced by CheckAuthentication(), DoChannel(), DoCommand(), DoStats(), and DoUser().

Field Documentation

AnopeXMLRPC::$Host
private

Definition at line 11 of file xmlrpc.php.

Referenced by __construct().


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