org.kitteh.irc.client.library.element

Interface Channel

All Superinterfaces:

Actor, ClientLinked, MessageReceiver, Snapshot, Staleable

All Known Implementing Classes:

DefaultChannel

public interface Channel
extends MessageReceiver, Staleable

Represents an IRC channel.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Channel.Commands Provides commands.
static interface	Channel.Topic Information about the channel's topic.

Method Summary

Modifier and Type	Method and Description
Channel.Commands	commands() Provides access to Commands.
default Optional<Channel>	getLatest() Gets the latest snapshot of this channel.
Optional<List<ModeInfo>>	getModeInfoList(ChannelMode mode) Gets the tracked mode info for the channel, if tracked.
ModeStatusList<ChannelMode>	getModes() Gets the channel's current known modes.
List<String>	getNicknames() Gets the nicknames of users in the channel, if the client is in the channel.
Channel.Topic	getTopic() Gets the channel's topic.
Optional<User>	getUser(String nick) Gets a user by their nick, if they are known to the client.
Optional<SortedSet<ChannelUserMode>>	getUserModes(String nick) Gets the user modes of a given nickname in the channel.
default Optional<SortedSet<ChannelUserMode>>	getUserModes(User user) Gets the user modes of a given user in the channel.
List<User>	getUsers() Gets all Users known to be in the channel.
boolean	hasCompleteUserData() Gets if this Channel has complete user data available, only possible if the Client is in the channel and the WHO list has sent.
default void	join() Joins the channel.
default void	join(String key) Joins the channel with a key.
default void	kick(User user) Kicks the given user from this channel without a reason.
default void	kick(User user, String reason) Kicks the given user from this channel for the given reason.
default void	part() Parts the channel without stating a reason.
default void	part(String reason) Parts the channel.
void	setModeInfoTracking(ChannelMode mode, boolean track) Sets whether a particular type A mode should be tracked for this channel, and sends a request for the full list.
default void	setTopic(String topic) Attempts to set the topic of the channel.

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

getLowerCaseMessagingName, getMessagingName, sendCtcpMessage, sendMessage, sendMultiLineMessage, sendMultiLineMessage, sendMultiLineNotice, sendMultiLineNotice, sendNotice

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

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

isStale

Method Detail

getLatest

@Nonnull
default Optional<Channel> getLatest()

Gets the latest snapshot of this channel.

Returns:

an updated snapshot if the channel is currently tracked by the client

getModeInfoList

@Nonnull
Optional<List<ModeInfo>> getModeInfoList(@Nonnull
                                                   ChannelMode mode)

Gets the tracked mode info for the channel, if tracked.

Parameters:

mode - type A mode to acquire

Returns:

list of mode info if tracked, empty if not tracked

Throws:

IllegalArgumentException - for null or non-type-A mode

getModes

@Nonnull
ModeStatusList<ChannelMode> getModes()

Gets the channel's current known modes.

Returns:

known modes

getNicknames

@Nonnull
List<String> getNicknames()

Gets the nicknames of users in the channel, if the client is in the channel.

Returns:

nicks in the channel

getTopic

@Nonnull
Channel.Topic getTopic()

Gets the channel's topic.

Returns:

channel topic

getUser

@Nonnull
Optional<User> getUser(@Nonnull
                                 String nick)

Gets a user by their nick, if they are known to the client. Note that the server may not have sent the User data over, while the nickname may be known to the channel.

Parameters:

nick - user's nick

Returns:

the user object, if known

Throws:

IllegalArgumentException - if nick is null

See Also:

hasCompleteUserData(), ChannelUsersUpdatedEvent

getUsers

@Nonnull
List<User> getUsers()

Gets all Users known to be in the channel. Note that the server may not have sent all User data over, while the nickname may be known to the channel. If you just want a list of nicknames, see getNicknames().

Returns:

users in the channel

See Also:

hasCompleteUserData(), ChannelUsersUpdatedEvent

getUserModes

@Nonnull
Optional<SortedSet<ChannelUserMode>> getUserModes(@Nonnull
                                                            String nick)

Gets the user modes of a given nickname in the channel.

Parameters:

nick - user's nick

Returns:

a set of modes the user is known to have, if the user is known

getUserModes

@Nonnull
default Optional<SortedSet<ChannelUserMode>> getUserModes(@Nonnull
                                                                    User user)

Gets the user modes of a given user in the channel.

Parameters:

user - user

Returns:

a set of modes the user is known to have, if the user is known

hasCompleteUserData

boolean hasCompleteUserData()

Gets if this Channel has complete user data available, only possible if the Client is in the channel and the WHO list has sent.

Returns:

true if Client is in channel and WHO has finished

See Also:

ChannelUsersUpdatedEvent

join

default void join()

Joins the channel.

See Also:

Client.addChannel(String...)

join

default void join(@Nonnull
                  String key)

Joins the channel with a key.

Parameters:

key - channel key

See Also:

Client.addKeyProtectedChannel(String, String)

kick

default void kick(@Nonnull
                  User user,
                  @Nonnull
                  String reason)

Kicks the given user from this channel for the given reason.

Parameters:

user - user to kick

reason - reason for the kick

kick

default void kick(@Nonnull
                  User user)

Kicks the given user from this channel without a reason.

Parameters:

user - user to kick

commands

@Nonnull
Channel.Commands commands()

Provides access to Commands.

Returns:

commands

part

default void part()

Parts the channel without stating a reason.

See Also:

Client.removeChannel(String)

part

default void part(@Nonnull
                  String reason)

Parts the channel.

Parameters:

reason - leaving reason

See Also:

Client.removeChannel(String, String)

setModeInfoTracking

void setModeInfoTracking(@Nonnull
                         ChannelMode mode,
                         boolean track)

Sets whether a particular type A mode should be tracked for this channel, and sends a request for the full list. Currently supports modes b, e, I, and q. The best time to request this would be in RequestedChannelJoinCompleteEvent to ensure it's always set.

Parameters:

mode - mode to track

track - true to track, false to stop tracking

Throws:

IllegalArgumentException - for null or non-type-A mode or non-supported type A mode

IllegalStateException - if not in channel

See Also:

ChannelModeInfoListEvent

setTopic

default void setTopic(@Nonnull
                      String topic)

Attempts to set the topic of the channel.

Parameters:

topic - new topic