kameloso.plugins.services.chanquery

The Channel Query service queries channels for information about them (in terms of topic and modes) as well as their lists of participants. It does this shortly after having joined a channel, as a service to all other plugins, so they don't each have to independently do it themselves.

It is qualified as a service, so while it is not technically mandatory, it is highly recommended if you plan on mixing in ChannelAwareness into your plugins.

Members

Classes

ChanQueryService
class ChanQueryService

The Channel Query service queries channels for information about them (in terms of topic and modes) as well as its list of participants.

Enums

ChannelState
enum ChannelState

Different states which tracked channels can be in.

Functions

onEndOfNames
void onEndOfNames(ChanQueryService service)

After listing names (upon joining a channel), initiate a channel query run unless one is already running. Additionally don't do it before it has been done at least once, after login.

onMyInfo
void onMyInfo(ChanQueryService service)

After successful connection, start a delayed channel query on all channels.

onNoSuchChannel
void onNoSuchChannel(ChanQueryService service, IRCEvent event)

If we get an error that a channel doesn't exist, remove it from channelStates. This stops it from being queried in startChannelQueries.

onSelfjoin
void onSelfjoin(ChanQueryService service, IRCEvent event)

Adds a channel we join to the internal ChanQueryService.channels list of channel states.

onSelfpart
void onSelfpart(ChanQueryService service, IRCEvent event)

Removes a channel we part from the internal ChanQueryService.channels list of channel states.

onTopic
void onTopic(ChanQueryService service, IRCEvent event)

Registers that we have seen the topic of a channel.

startChannelQueries
void startChannelQueries(ChanQueryService service)

Queries channels for information about them and their users.

Manifest constants

omniscientChannelPolicy
enum omniscientChannelPolicy;

The ChannelPolicy to mix in awareness with depending on whether version OmniscientQueries is set or not.

See Also

Meta