org.kitteh.irc.client.library.element

Interface MessageReceiver

All Superinterfaces:

Actor, ClientLinked, Snapshot

All Known Subinterfaces:

Channel, User, WhoisData

All Known Implementing Classes:

DefaultChannel, DefaultUser, DefaultWhoisData

public interface MessageReceiver
extends Actor

Represents an Actor capable of receiving messages.

Method Summary

Modifier and Type	Method and Description
default String	getLowerCaseMessagingName() Gets the lowercase version of the name used when sending messages.
String	getMessagingName() Gets the name used when sending messages.
default void	sendCtcpMessage(String message) Sends this actor a CTCP message.
default void	sendMessage(String message) Sends this actor a message.
default void	sendMultiLineMessage(String message) Sends this actor a potentially multi-line message using the client's default message cutter.
default void	sendMultiLineMessage(String message, Cutter cutter) Sends this actor a potentially multi-line message using a specified message cutter.
default void	sendMultiLineNotice(String message) Sends this actor a potentially multi-line notice using the client's default message cutter.
default void	sendMultiLineNotice(String message, Cutter cutter) Sends this actor a potentially multi-line notice using a specified message cutter.
default void	sendNotice(String message) Sends this actor a notice.

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

getLowerCaseName, getName

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

getCreationTime

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

getClient

Method Detail

getMessagingName

@Nonnull
String getMessagingName()

Gets the name used when sending messages.

Returns:

the name by which you can message this receiver

getLowerCaseMessagingName

@Nonnull
default String getLowerCaseMessagingName()

Gets the lowercase version of the name used when sending messages.

Returns:

the lowercase version of the name by which you can message this receiver

sendCtcpMessage

default void sendCtcpMessage(@Nonnull
                             String message)

Sends this actor a CTCP message.

Parameters:

message - the message to send

See Also:

Client.sendCtcpMessage(MessageReceiver, String)

sendMessage

default void sendMessage(@Nonnull
                         String message)

Sends this actor a message.

Parameters:

message - the message to send

See Also:

Client.sendMessage(MessageReceiver, String)

sendMultiLineMessage

default void sendMultiLineMessage(@Nonnull
                                  String message)

Sends this actor a potentially multi-line message using the client's default message cutter.

Note that bots may not react appropriately to a message split across multiple lines.

Parameters:

message - message to send

See Also:

Client.sendMultiLineMessage(MessageReceiver, String)

sendMultiLineMessage

default void sendMultiLineMessage(@Nonnull
                                  String message,
                                  @Nonnull
                                  Cutter cutter)

Sends this actor a potentially multi-line message using a specified message cutter.

Note that bots may not react appropriately to a message split across multiple lines.

Parameters:

message - message to send

cutter - cutter to utilize

See Also:

Client.sendMultiLineMessage(MessageReceiver, String, Cutter)

sendNotice

default void sendNotice(@Nonnull
                        String message)

Sends this actor a notice.

Parameters:

message - the message to send

See Also:

Client.sendNotice(MessageReceiver, String)

sendMultiLineNotice

default void sendMultiLineNotice(@Nonnull
                                 String message)

Sends this actor a potentially multi-line notice using the client's default message cutter.

Note that bots may not react appropriately to a message split across multiple lines.

Parameters:

message - message to send

See Also:

Client.sendMultiLineNotice(MessageReceiver, String)

sendMultiLineNotice

default void sendMultiLineNotice(@Nonnull
                                 String message,
                                 @Nonnull
                                 Cutter cutter)

Sends this actor a potentially multi-line notice using a specified message cutter.

Note that bots may not react appropriately to a message split across multiple lines.

Parameters:

message - message to send

cutter - cutter to utilize

See Also:

Client.sendMultiLineNotice(MessageReceiver, String, Cutter)