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 @NonNull String	getLowerCaseMessagingName() Gets the lowercase version of the name used when sending messages.
@NonNull String	getMessagingName() Gets the name used when sending messages.
default void	sendCtcpMessage(@NonNull String message) Sends this actor a CTCP message.
default void	sendMessage(@NonNull String message) Sends this actor a message.
default void	sendMultiLineMessage(@NonNull String message) Sends this actor a potentially multi-line message using the client's default message cutter.
default void	sendMultiLineMessage(@NonNull String message, @NonNull Cutter cutter) Sends this actor a potentially multi-line message using a specified message cutter.
default void	sendMultiLineNotice(@NonNull String message) Sends this actor a potentially multi-line notice using the client's default message cutter.
default void	sendMultiLineNotice(@NonNull String message, @NonNull Cutter cutter) Sends this actor a potentially multi-line notice using a specified message cutter.
default void	sendNotice(@NonNull 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

default @NonNull 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)