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.

@safe

mixin template UserAwareness (

ChannelPolicy channelPolicy = ChannelPolicy.home

Flag!"debug_" debug_ = No.debug_

string module_ = __MODULE__

) {

struct IRCEvent via import dialect.defs : IRCEvent;;

mixintemplate MixinConstraints(MixinScope mixinScope, string mixinName = "a constrained mixin") via import lu.traits : MixinConstraints, MixinScope;;

enum MixinScope via import lu.traits : MixinConstraints, MixinScope;;

package

enum hasUserAwareness;

void onUserAwarenessQuitMixin(IRCPlugin plugin, IRCEvent event);

void onUserAwarenessNickMixin(IRCPlugin plugin, IRCEvent event);

void onUserAwarenessCatchTargetMixin(IRCPlugin plugin, IRCEvent event);

void onUserAwarenessCatchSenderMixin(IRCPlugin plugin, IRCEvent event);

void onUserAwarenessNamesReplyMixin(IRCPlugin plugin, IRCEvent event);

void onUserAwarenessEndOfListMixin(IRCPlugin plugin, IRCEvent event);

}

Members

Functions

onUserAwarenessCatchSenderMixin void onUserAwarenessCatchSenderMixin(IRCPlugin plugin, IRCEvent event): Adds a user to the IRCPlugin's IRCPluginState.users array, potentially including their services account name.
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;: Constant denoting that UserAwareness
has been mixed in.

Mixed In Members

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

hasMinimalAuthentication enum hasMinimalAuthentication;: Constant 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.