IPluginHost Interface |
Overall plugin manager
Namespace: AdiIRCAPI
Assembly: AdiIRCAPI (in AdiIRCAPI.dll) Version: 1.8.0.0 (1.8.0.0)
SyntaxThe IPluginHost type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ActiveIWindow |
Returns the current active IWindow
|
| ActiveWindow | Obsolete.
Returns the current active window
|
| ConfigFolder |
Returns the AdiIRC config folder.
|
| EditboxOptions |
IEditboxOptions
|
| GetServers |
Get a list of IServers
|
| GetVariables |
Returns a list of global variables which are saved across sessions
|
| GetWindows |
Get a list of IWindows
|
| MessagesOptions |
IMessagesOptions
|
| ProgramFolder |
Returns the AdiIRC program folder.
|
Methods| Name | Description | |
|---|---|---|
 | Evaluate |
Evaluates identifiers in a script line
|
| HookCommand |
Use this to add /commands, you can then suscribe to OnCommand to get data from this command
|
| NotifyUser(String) |
Use this to show information to the user. Show in currently active window
|
| NotifyUser(Object, String) |
Use this to show information to the user. Shows in the specified window of any type.
Returns if the message was shown
|
| NotifyUser(IChannel, String) |
Use this to show information to the user. Shows in IChannel window
Returns if the message was shown
|
| NotifyUser(IServer, String) |
Use this to show information to the user. Shows in IServer window.
Returns if the message was shown
|
| NotifyUser(IUser, String) |
Use this to show information to the user. Shows in IUser window
Returns if the message was shown
|
| SendCommand |
Send a /command to a Window, window can be IServer, IChannel or IUser
|
| SendFakeRaw |
Sends raw data to the client IServer, use this to fake messages
E.g when you want to replace something in a PRIVMSG
|
| SendRaw |
Sends raw data to the IServer
|
| SendRawData |
Sends raw bytes to the IServer, bypasssing any encodings, AdiIRC is not aware when this messages are sent.
|
| SystemUptime |
Returns System Uptime in milliseconds
if type = 1 returns a duration, if type = 2 returns a duration but without seconds, and if type = 3 returns seconds instead of milliseconds.
|
| UnHookCommand |
Remove a /command, you have defined.
|
| Uptime |
Returns AdiIRC Uptime in milliseconds
if type = 1 returns a duration, if type = 2 returns a duration but without seconds, and if type = 3 returns seconds instead of milliseconds.
|
Events| Name | Description | |
|---|---|---|
 | OnChannelNotice |
Delegate gets called when a IChannel recives a notice
|
| OnCommand |
Delegate gets called when your user types a command
Window can be IServer (server window), IChannel (channel window), IUser (private window)
|
| OnConnect |
Delegate gets called when a IServer connects
|
| OnDisconnect |
Delegate gets called when a IServer disconnects
|
| OnEditboxKeyDown |
Delegate gets called when a key is pressed down in a Editbox
|
| OnGetData |
Delegate gets called when a IServer retrives raw data
|
| OnIdentifier |
Delegate gets called when the command is called as a $identifier in a script
Window can be IServer (server window), IChannel (channel window), IUser (private window)
|
| OnInvite |
Delegate gets called when a user on IChannel revices an invite
|
| OnJoin |
Delegate gets called when a IUser joines a IChannel
|
| OnKick |
Delegate gets called when a IUser is kicked from IChannel
|
| OnMenu |
Delegate gets called when a menu is opened
|
| OnMessage |
Delegate gets called when a IChannel revices a message
|
| OnMode |
Delegate gets called when a IChannel revices a mode
|
| OnNick |
Delegate gets called when a IUser change nick
|
| OnOptionsChanged |
Delegate gets called when the user changes a options and the config file is reloaded.
|
| OnPart |
Delegate gets called when a IUser parts a IChannel
|
| OnPrivateMessage |
Delegate gets called when your IUser recives a private message
|
| OnQuit |
Delegate gets called when a IUser quits the IServer
|
| OnRawData |
Sends raw bytes to the IServer, bypasssing any encodings, AdiIRC is not aware when this messages are sent.
|
| OnRegistered |
Delegate gets called when a IServer is registered
|
| OnSendData |
Delegate gets called when user sends data to the IServer
|
| OnServerNotice |
Delegate gets called when a IServer recives a notice
|
| OnTopic |
Delegate gets called when a IUser changes topic in IChannel
|
| OnUserInvite |
Delegate gets called when your IUser recives an IChannel invite
|
| OnUserJoin |
Delegate gets called when your IUser joines a IChannel
|
| OnUserKick |
Delegate gets called when your IUser is kicked from IChannel
|
| OnUserMessage |
Delegate gets called when your IUser send a message to object
object can be either IChannel or IUser
|
| OnUserMode |
Delegate gets called when your IUser revices a umode
|
| OnUserNick |
Delegate gets called when your IUser change nick
|
| OnUserNotice |
Delegate gets called when your IUser recives a notice
|
| OnUserPart |
Delegate gets called when your IUser parts a IChannel
|
| OnUserQuit |
Delegate gets called when your IUser quits the IServer
|
See Also