AdiIRCAPI.IPluginHost Interface Reference

Overall plugin manager. More...

List of all members.

Public Member Functions

Boolean NotifyUser (IServer Server, String Message)
 Use this to show information to the user. Shows in IServer window. Returns if the message was shown Server IServer Message String.
Boolean NotifyUser (IChannel Channel, String Message)
 Use this to show information to the user. Shows in IChannel window Returns if the message was shown Channel IChannel Message String.
Boolean NotifyUser (IUser User, String Message)
 Use this to show information to the user. Shows in IUser window Returns if the message was shown User IUser Message String.
Boolean NotifyUser (String Message)
 Use this to show information to the user. Show in currently active window Message String.
Boolean HookCommand (IPlugin Plugin, String Command, String HelpSyntax, String Description)
 Use this to add /commands, you can then suscribe to OnCommand to get data from this command Plugin IPlugin Command String HelpSyntax String Description String.
Boolean UnHookCommand (IPlugin Plugin, String Command)
 Remove a /command, you have defined. Plugin IPlugin Command String.
Boolean SendRaw (IServer Server, String Data)
 Sends raw data to the IServer Server IServer Data String.
Boolean SendFakeRaw (IServer Server, String Data)
 Sends raw data to the client IServer, use this to fake messages E.g when you want to replace something in a PRIVMSG Server IServer Data String.
Boolean SendCommand (Object Window, String Command, String Args)
 Send a /command to a Window, window can be IServer, IChannel or IUser Window Object Data String Args String.

Public Attributes

event Connect OnConnect
 Delegate gets called when a IServer connects Server IServer.
event Disconnect OnDisconnect
 Delegate gets called when a IServer disconnects Server IServer.
event Registered OnRegistered
 Delegate gets called when a IServer is registered Server IServer.
event GetData OnGetData
 Delegate gets called when a IServer retrives raw data Server IServer Data String Return EatData.
event UserNotice OnUserNotice
 Delegate gets called when your IUser recives a notice Server IServer User IUser Notice String Return EatData.
event ChannelNotice OnChannelNotice
 Delegate gets called when a IChannel recives a notice Server IServer Channel IChannel User IUser Notice String Return EatData.
event ServerNotice OnServerNotice
 Delegate gets called when a IServer recives a notice Server IServer Notice String Return EatData.
event Part OnPart
 Delegate gets called when a IUser parts a IChannel Server IServer Channel IChannel User IUser PartMessage String Return EatData.
event UserPart OnUserPart
 Delegate gets called when your IUser parts a IChannel Server IServer Channel IChannel PartMessage String Return EatData.
event Message OnMessage
 Delegate gets called when a IChannel revices a message Server IServer Channel IChannel User IUser Message String Return EatData.
event PrivateMessage OnPrivateMessage
 Delegate gets called when your IUser recives a private message Server IServer User IUser Message String Return EatData.
event UserMessage OnUserMessage
 Delegate gets called when your IUser send a message to object object can be either IChannel or IUser IServer IServer Window Object Message String Return EatData.
event Mode OnMode
 Delegate gets called when a IChannel revices a mode Server IServer Channel IChannel User IUser Mode String Return EatData.
event UserMode OnUserMode
 Delegate gets called when your IUser revices a umode Server IServer Channel IChannel Mode String Return EatData.
event Invite OnInvite
 Delegate gets called when a user on IChannel revices an invite Server IServer Channel IChannel User IUser Return EatData.
event UserInvite OnUserInvite
 Delegate gets called when your IUser recives an IChannel invite Server IServer Channel IChannel User IUser Return EatData.
event Quit OnQuit
 Delegate gets called when a IUser quits the IServer Server IServer User IUser QuitMessage String Return EatData.
event UserQuit OnUserQuit
 Delegate gets called when your IUser quits the IServer Server IServer QuitMessage String Return EatData.
event Nick OnNick
 Delegate gets called when a IUser change nick Server IServer User IUser NewNick String Return EatData.
event UserNick OnUserNick
 Delegate gets called when your IUser change nick Server IServer NewNick String Return EatData.
event Topic OnTopic
 Delegate gets called when a IUser changes topic in IChannel Server IServer Channel IChannel User IUser NewTopic String Return EatData.
event Kick OnKick
 Delegate gets called when a IUser is kicked from IChannel Server IServer Channel IChannel User IUser ByUser IUser KickReason String Return EatData.
event UserKick OnUserKick
 Delegate gets called when your IUser is kicked from IChannel Server IServer Channel IChannel User IUser KickReason String Return EatData.
event Join OnJoin
 Delegate gets called when a IUser joines a IChannel Server IServer Channel IChannel User IUser Return EatData.
event UserJoin OnUserJoin
 Delegate gets called when your IUser joines a IChannel Server IServer Channel IChannel Return EatData.
event Command OnCommand
 Delegate gets called when your user types a command Window can be IServer (server window), IChannel (channel window), IUser (private window) Window Object Command String Args String.
event SendData OnSendData
 Delegate gets called when user sends data to the IServer Server IServer Data String Return EatData.

Properties

ICollection GetServers [get]
 Get a list of IServers.


Detailed Description

Overall plugin manager.


Member Function Documentation

Boolean AdiIRCAPI.IPluginHost.NotifyUser ( IServer  Server,
String  Message 
)

Use this to show information to the user. Shows in IServer window. Returns if the message was shown Server IServer Message String.

Boolean AdiIRCAPI.IPluginHost.NotifyUser ( IChannel  Channel,
String  Message 
)

Use this to show information to the user. Shows in IChannel window Returns if the message was shown Channel IChannel Message String.

Boolean AdiIRCAPI.IPluginHost.NotifyUser ( IUser  User,
String  Message 
)

Use this to show information to the user. Shows in IUser window Returns if the message was shown User IUser Message String.

Boolean AdiIRCAPI.IPluginHost.NotifyUser ( String  Message  ) 

Use this to show information to the user. Show in currently active window Message String.

Boolean AdiIRCAPI.IPluginHost.HookCommand ( IPlugin  Plugin,
String  Command,
String  HelpSyntax,
String  Description 
)

Use this to add /commands, you can then suscribe to OnCommand to get data from this command Plugin IPlugin Command String HelpSyntax String Description String.

Boolean AdiIRCAPI.IPluginHost.UnHookCommand ( IPlugin  Plugin,
String  Command 
)

Remove a /command, you have defined. Plugin IPlugin Command String.

Boolean AdiIRCAPI.IPluginHost.SendRaw ( IServer  Server,
String  Data 
)

Sends raw data to the IServer Server IServer Data String.

Boolean AdiIRCAPI.IPluginHost.SendFakeRaw ( IServer  Server,
String  Data 
)

Sends raw data to the client IServer, use this to fake messages E.g when you want to replace something in a PRIVMSG Server IServer Data String.

Boolean AdiIRCAPI.IPluginHost.SendCommand ( Object  Window,
String  Command,
String  Args 
)

Send a /command to a Window, window can be IServer, IChannel or IUser Window Object Data String Args String.


Member Data Documentation

Delegate gets called when a IServer connects Server IServer.

Delegate gets called when a IServer disconnects Server IServer.

Delegate gets called when a IServer is registered Server IServer.

Delegate gets called when a IServer retrives raw data Server IServer Data String Return EatData.

Delegate gets called when your IUser recives a notice Server IServer User IUser Notice String Return EatData.

Delegate gets called when a IChannel recives a notice Server IServer Channel IChannel User IUser Notice String Return EatData.

Delegate gets called when a IServer recives a notice Server IServer Notice String Return EatData.

Delegate gets called when a IUser parts a IChannel Server IServer Channel IChannel User IUser PartMessage String Return EatData.

Delegate gets called when your IUser parts a IChannel Server IServer Channel IChannel PartMessage String Return EatData.

Delegate gets called when a IChannel revices a message Server IServer Channel IChannel User IUser Message String Return EatData.

Delegate gets called when your IUser recives a private message Server IServer User IUser Message String Return EatData.

Delegate gets called when your IUser send a message to object object can be either IChannel or IUser IServer IServer Window Object Message String Return EatData.

Delegate gets called when a IChannel revices a mode Server IServer Channel IChannel User IUser Mode String Return EatData.

Delegate gets called when your IUser revices a umode Server IServer Channel IChannel Mode String Return EatData.

Delegate gets called when a user on IChannel revices an invite Server IServer Channel IChannel User IUser Return EatData.

Delegate gets called when your IUser recives an IChannel invite Server IServer Channel IChannel User IUser Return EatData.

Delegate gets called when a IUser quits the IServer Server IServer User IUser QuitMessage String Return EatData.

Delegate gets called when your IUser quits the IServer Server IServer QuitMessage String Return EatData.

Delegate gets called when a IUser change nick Server IServer User IUser NewNick String Return EatData.

Delegate gets called when your IUser change nick Server IServer NewNick String Return EatData.

Delegate gets called when a IUser changes topic in IChannel Server IServer Channel IChannel User IUser NewTopic String Return EatData.

Delegate gets called when a IUser is kicked from IChannel Server IServer Channel IChannel User IUser ByUser IUser KickReason String Return EatData.

Delegate gets called when your IUser is kicked from IChannel Server IServer Channel IChannel User IUser KickReason String Return EatData.

Delegate gets called when a IUser joines a IChannel Server IServer Channel IChannel User IUser Return EatData.

Delegate gets called when your IUser joines a IChannel Server IServer Channel IChannel Return EatData.

Delegate gets called when your user types a command Window can be IServer (server window), IChannel (channel window), IUser (private window) Window Object Command String Args String.

Delegate gets called when user sends data to the IServer Server IServer Data String Return EatData.


Property Documentation

ICollection AdiIRCAPI.IPluginHost.GetServers [get]

Get a list of IServers.


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

Generated on Thu Mar 27 08:55:21 2008 for AdiIRCAPI by  doxygen 1.5.5