org.kitteh.irc.client.library.event.user

Class PrivateCtcpQueryEvent

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.ActorMessageEventBase<A>

org.kitteh.irc.client.library.event.abstractbase.ActorPrivateMessageEventBase<User>

org.kitteh.irc.client.library.event.user.PrivateCtcpQueryEvent

All Implemented Interfaces:

ClientLinked, ActorEvent<User>, ActorMessageEvent<User>, ClientEvent, MessageEvent, PrivateEvent, ServerMessageEvent

public class PrivateCtcpQueryEvent
extends ActorPrivateMessageEventBase<User>
implements ActorMessageEvent<User>

The client has received a CTCP message! There are a few (FINGER, PING, TIME, VERSION) queries which have a default reply message. Others are simply ignored by default. The method ActorMessageEventBase.getMessage() returns the unescaped message with the delimiter removed. Note that the reply is not sent if the target is not the client.

See PrivateCtcpReplyEvent for received CTCP replies.

Constructor Summary

Constructors

Constructor and Description
PrivateCtcpQueryEvent(Client client, List<ServerMessage> originalMessages, User sender, String target, String message, String reply) Creates the event

Method Summary

Modifier and Type	Method and Description
Optional<String>	getReply() Gets the reply to be sent to the CTCP sender.
void	setReply(String reply) Sets the reply to send to the CTCP sender.
protected ToStringer	toStringer() Generates a partial ToStringer for the command.

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

getTarget, isToClient

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

getMessage

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

getOriginalMessages

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.MessageEvent

getMessage

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

getOriginalMessages

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

getClient

Constructor Detail

PrivateCtcpQueryEvent

public PrivateCtcpQueryEvent(@Nonnull
                             Client client,
                             @Nonnull
                             List<ServerMessage> originalMessages,
                             @Nonnull
                             User sender,
                             @Nonnull
                             String target,
                             @Nonnull
                             String message,
                             @Nullable
                             String reply)

Creates the event

Parameters:

client - client for which this is occurring

originalMessages - original messages

sender - sender of the query

target - target of the query

message - message sent

reply - reply to be sent, if any

Method Detail

getReply

@Nonnull
public Optional<String> getReply()

Gets the reply to be sent to the CTCP sender.

Returns:

the reply if one is set

setReply

public void setReply(@Nullable
                     String reply)

Sets the reply to send to the CTCP sender. Note that this method will not work if listening async. For async replies, set this to null and use Client.sendCtcpReply(String, String).

Parameters:

reply - message to send back

toStringer

@Nonnull
protected ToStringer toStringer()

Description copied from class: ClientEventBase

Generates a partial ToStringer for the command.

Overrides:

toStringer in class ActorPrivateMessageEventBase<User>

Returns:

the partial toString generator