IrcBotEvent Class Reference

A bot event to be handled. More...

#include <ircbot/ircbot.h>

Public Member Functions
IrcBotEventType	IrcBotEvent_type (const IrcBotEvent *self)
	The type of the event. More...
const IrcServer *	IrcBotEvent_server (const IrcBotEvent *self)
	The server the event came from. More...
const IrcChannel *	IrcBotEvent_channel (const IrcBotEvent *self)
	The channel the event occured on. More...
const char *	IrcBotEvent_origin (const IrcBotEvent *self)
	The origin of the event. More...
const char *	IrcBotEvent_command (const IrcBotEvent *self)
	The bot command. More...
const char *	IrcBotEvent_from (const IrcBotEvent *self)
	The sender of the message. More...
const char *	IrcBotEvent_arg (const IrcBotEvent *self)
	Additional arguments of the event. More...
IrcBotResponse *	IrcBotEvent_response (IrcBotEvent *self)
	Obtain a response object to configure. More...

Detailed Description

A bot event to be handled.

Member Function Documentation

IrcBotEvent_arg()

const char * IrcBotEvent_arg

(

const IrcBotEvent *

self

)

Additional arguments of the event.

Parameters

self	the IrcBotEvent

Returns

a string with all additional arguments, or NULL if there are none

IrcBotEvent_channel()

const IrcChannel * IrcBotEvent_channel

(

const IrcBotEvent *

self

)

The channel the event occured on.

Parameters

self	the IrcBotEvent

Returns

the channel, of NULL if there isn't one

IrcBotEvent_command()

const char * IrcBotEvent_command

(

const IrcBotEvent *

self

)

The bot command.

Parameters

self	the IrcBotEvent

Returns

the bot command, or NULL if this is not a command event

IrcBotEvent_from()

const char * IrcBotEvent_from

(

const IrcBotEvent *

self

)

The sender of the message.

Parameters

self	the IrcBotEvent

Returns

the nick who sent the originating message, of NULL if none

IrcBotEvent_origin()

const char * IrcBotEvent_origin

(

const IrcBotEvent *

self

)

The origin of the event.

Parameters

self	the IrcBotEvent

Returns

A channel name, or the nick of the bot for a private message, or NULL if not applicable

IrcBotEvent_response()

IrcBotResponse * IrcBotEvent_response

(

IrcBotEvent *

self

)

Obtain a response object to configure.

Parameters

self	the IrcBotEvent

Returns

an object to hold any responses a handler wants to add

IrcBotEvent_server()

const IrcServer * IrcBotEvent_server

(

const IrcBotEvent *

self

)

The server the event came from.

Parameters

self	the IrcBotEvent

Returns

the server

IrcBotEvent_type()

IrcBotEventType IrcBotEvent_type

(

const IrcBotEvent *

self

)

The type of the event.

Parameters

self	the IrcBotEvent

Returns

the type of the event

---

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

• ircbot/ircbot.h