UserAwareness

Implements *user awareness* in a plugin module.

This maintains a cache of all currently visible users, adding people to it upon discovering them and best-effort culling them when they leave or quit. The cache kept is an associative array, in IRCPluginState.users.

User awareness implicitly requires minimal authentication

and will silently include it if it was not already mixed in.

Members

Functions

onUserAwarenessCatchSenderMixin
void onUserAwarenessCatchSenderMixin(IRCPlugin plugin, IRCEvent event)

Proxies to onUserAwarenessCatchSender.

onUserAwarenessCatchTargetMixin
void onUserAwarenessCatchTargetMixin(IRCPlugin plugin, IRCEvent event)

Proxies to onUserAwarenessCatchTarget.

onUserAwarenessEndOfListMixin
void onUserAwarenessEndOfListMixin(IRCPlugin plugin, IRCEvent event)

Proxies to onUserAwarenessEndOfList.

onUserAwarenessNamesReplyMixin
void onUserAwarenessNamesReplyMixin(IRCPlugin plugin, IRCEvent event)

Proxies to onUserAwarenessNamesReply.

onUserAwarenessNickMixin
void onUserAwarenessNickMixin(IRCPlugin plugin, IRCEvent event)

Proxies to onUserAwarenessNick.

onUserAwarenessQuitMixin
void onUserAwarenessQuitMixin(IRCPlugin plugin, IRCEvent event)

Proxies to onUserAwarenessQuit.

Manifest constants

hasUserAwareness
enum hasUserAwareness;

Flag denoting that UserAwareness

has been mixed in.

Mixed In Members

From mixin kameloso.plugins.common.awareness.MinimalAuthentication!(debug_, module_)

hasMinimalAuthentication
enum hasMinimalAuthentication;

Flag denoting that MinimalAuthentication

has been mixed in.

onMinimalAuthenticationAccountInfoTargetMixin
void onMinimalAuthenticationAccountInfoTargetMixin(IRCPlugin plugin, IRCEvent event)

Proxies to onMinimalAuthenticationAccountInfoTarget.

onMinimalAuthenticationUnknownCommandWHOISMixin
void onMinimalAuthenticationUnknownCommandWHOISMixin(IRCPlugin plugin, IRCEvent event)

Proxies to onMinimalAuthenticationUnknownCommandWHOIS.

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