org.kitteh.irc.client.library.element

Interface User

All Superinterfaces:

Actor, ClientLinked, MessageReceiver, Snapshot, Staleable

All Known Subinterfaces:

WhoisData

All Known Implementing Classes:

DefaultUser, DefaultWhoisData

public interface User
extends MessageReceiver, Staleable

Represents an IRC user.

Method Summary

Modifier and Type	Method and Description
@NonNull Optional<String>	getAccount() Gets the Services account this user is signed into.
@NonNull Optional<String>	getAwayMessage() Gets, if one is set and known, the away message for the user.
@NonNull Set<String>	getChannels() Gets the user's channels.
@NonNull String	getHost() Gets the user's host.
@NonNull String	getNick() Gets the user's nick.
@NonNull Optional<String>	getOperatorInformation() Gets a user's operator information, if they have any privileges, noting that this information may not imply actual IRC Operator status but some other IRC network status as well.
@NonNull Optional<String>	getRealName() Gets the user's real name
@NonNull Optional<String>	getServer() Gets the name of the server the user is on.
@NonNull String	getUserString() Gets the user's user string.
boolean	isAway() Gets if the user is away.

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

getAccount

@NonNull Optional<String> getAccount()

Gets the Services account this user is signed into. Only fully functional if the server supports the capabilities account-notify, extended-join, and WHOX and the user and client share a channel.

Returns:

the account name if known

See Also:

CapabilityManager.getCapabilities(), ServerInfo.hasWhoXSupport()

getAwayMessage

@NonNull Optional<String> getAwayMessage()

Gets, if one is set and known, the away message for the user.

Returns:

away message if known

getChannels

@NonNull Set<String> getChannels()

Gets the user's channels.

Returns:

channel names the user is in

getHost

@NonNull String getHost()

Gets the user's host.

Returns:

user host

getNick

@NonNull String getNick()

Gets the user's nick.

Returns:

user nick

getOperatorInformation

@NonNull Optional<String> getOperatorInformation()

Gets a user's operator information, if they have any privileges, noting that this information may not imply actual IRC Operator status but some other IRC network status as well.

Example: "is an Operator".

Returns:

operator info, or empty if none known

getRealName

@NonNull Optional<String> getRealName()

Gets the user's real name

Returns:

real name if known

getServer

@NonNull Optional<String> getServer()

Gets the name of the server the user is on.

Returns:

user's server if known

getUserString

@NonNull String getUserString()

Gets the user's user string.

Returns:

user

isAway

boolean isAway()

Gets if the user is away.

Returns:

true if away