org.kitteh.irc.client.library.event.channel

Class ChannelTargetedTagMessageEvent

java.lang.Object

org.kitteh.irc.client.library.event.abstractbase.ClientEventBase

org.kitteh.irc.client.library.event.abstractbase.ServerMessageEventBase

org.kitteh.irc.client.library.event.abstractbase.ActorEventBase<A>

org.kitteh.irc.client.library.event.abstractbase.ActorChannelEventBase<Actor>

org.kitteh.irc.client.library.event.channel.ChannelTargetedTagMessageEvent

All Implemented Interfaces:

ClientLinked, ActorEvent<Actor>, ChannelEvent, ChannelTargetedEvent, ClientEvent, ServerMessageEvent, TagMessageEvent

public class ChannelTargetedTagMessageEvent
extends ActorChannelEventBase<Actor>
implements TagMessageEvent, ChannelTargetedEvent

Fires when a tag message is sent to a subset of users in a channel. Note that the sender may be the client itself if the capability "echo-message" is enabled.

Constructor Summary

Constructors

Constructor and Description
ChannelTargetedTagMessageEvent(@NonNull Client client, @NonNull ServerMessage sourceMessage, @NonNull Actor sender, @NonNull Channel channel, @NonNull ChannelUserMode prefix) Creates the event.

Method Summary

Modifier and Type	Method and Description
@NonNull ChannelUserMode	getPrefix() Gets the prefix to which the message was sent.
protected @NonNull ToStringer	toStringer() Generates a partial ToStringer for the command.

Methods inherited from class org.kitteh.irc.client.library.event.abstractbase.ActorChannelEventBase

getChannel

Methods inherited from class org.kitteh.irc.client.library.event.abstractbase.ActorEventBase

getActor

Methods inherited from class org.kitteh.irc.client.library.event.abstractbase.ServerMessageEventBase

getSource

Methods inherited from class org.kitteh.irc.client.library.event.abstractbase.ClientEventBase

getClient, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.kitteh.irc.client.library.event.helper.ActorEvent

getActor

Methods inherited from interface org.kitteh.irc.client.library.event.helper.ChannelTargetedEvent

getTargetedName

Methods inherited from interface org.kitteh.irc.client.library.event.helper.ChannelEvent

getChannel

Methods inherited from interface org.kitteh.irc.client.library.element.ClientLinked

getClient

Methods inherited from interface org.kitteh.irc.client.library.event.helper.ServerMessageEvent

getTag, getTag, getTags

Constructor Detail

ChannelTargetedTagMessageEvent

public ChannelTargetedTagMessageEvent(@NonNull Client client,
                                      @NonNull ServerMessage sourceMessage,
                                      @NonNull Actor sender,
                                      @NonNull Channel channel,
                                      @NonNull ChannelUserMode prefix)

Creates the event.

Parameters:

client - client for which this is occurring

sourceMessage - source message

sender - who sent it

channel - channel receiving

prefix - targeted prefix

Method Detail

getPrefix

public final @NonNull ChannelUserMode getPrefix()

Description copied from interface: ChannelTargetedEvent

Gets the prefix to which the message was sent.

Specified by:

getPrefix in interface ChannelTargetedEvent

Returns:

the prefix targeted

toStringer

protected @NonNull ToStringer toStringer()

Description copied from class: ClientEventBase

Generates a partial ToStringer for the command.

Overrides:

toStringer in class ActorChannelEventBase<Actor>

Returns:

the partial toString generator