ChannelAwareness

Implements *channel awareness* in a plugin module.

This maintains a cache of all current channels, their topics and modes, and their participants. The cache kept is an associative array, in IRCPluginState.channels.

Channel awareness explicitly requires user awareness and will halt compilation if it is not also mixed in.

Members

Functions

onChannelAwarenessChannelModeIsMixin
void onChannelAwarenessChannelModeIsMixin(IRCPlugin plugin, IRCEvent event)

Proxies to onChannelAwarenessChannelModeIs.

onChannelAwarenessCreationTimeMixin
void onChannelAwarenessCreationTimeMixin(IRCPlugin plugin, IRCEvent event)

Proxies to onChannelAwarenessCreationTime.

onChannelAwarenessJoinMixin
void onChannelAwarenessJoinMixin(IRCPlugin plugin, IRCEvent event)

Proxies to onChannelAwarenessJoin.

onChannelAwarenessModeListsMixin
void onChannelAwarenessModeListsMixin(IRCPlugin plugin, IRCEvent event)

Proxies to onChannelAwarenessModeLists.

onChannelAwarenessModeMixin
void onChannelAwarenessModeMixin(IRCPlugin plugin, IRCEvent event)

Proxies to onChannelAwarenessMode.

onChannelAwarenessNamesReplyMixin
void onChannelAwarenessNamesReplyMixin(IRCPlugin plugin, IRCEvent event)

Proxies to onChannelAwarenessNamesReply.

onChannelAwarenessNickMixin
void onChannelAwarenessNickMixin(IRCPlugin plugin, IRCEvent event)

Proxies to onChannelAwarenessNick.

onChannelAwarenessPartMixin
void onChannelAwarenessPartMixin(IRCPlugin plugin, IRCEvent event)

Proxies to onChannelAwarenessPart.

onChannelAwarenessQuitMixin
void onChannelAwarenessQuitMixin(IRCPlugin plugin, IRCEvent event)

Proxies to onChannelAwarenessQuit.

onChannelAwarenessSelfjoinMixin
void onChannelAwarenessSelfjoinMixin(IRCPlugin plugin, IRCEvent event)

Proxies to onChannelAwarenessSelfjoin.

onChannelAwarenessSelfpartMixin
void onChannelAwarenessSelfpartMixin(IRCPlugin plugin, IRCEvent event)

Proxies to onChannelAwarenessSelfpart.

onChannelAwarenessTopicMixin
void onChannelAwarenessTopicMixin(IRCPlugin plugin, IRCEvent event)

Proxies to onChannelAwarenessTopic.

onChannelAwarenessWhoReplyMixin
void onChannelAwarenessWhoReplyMixin(IRCPlugin plugin, IRCEvent event)

Proxies to onChannelAwarenessWhoReply.

Manifest constants

hasChannelAwareness
enum hasChannelAwareness;

Flag denoting that ChannelAwareness has been mixed in.

Parameters

channelPolicy

What ChannelPolicy to apply to enwrapped event handlers.

debug_

Whether or not to include debugging output.

module_

String name of the mixing-in module; generally leave as-is.

See Also