IRCUser

Represents an IRC user and their connection prefix state.

Description

A data container that stores information about an IRC user, including their nickname, username, hostname, account registration, and away status. Typically assembled from IRC origin prefixes (nick!user@host).

Tutorials

IRCClient Developer Examples

Properties

String	account	`""`
String	away_message	`""`
String	hostname	`""`
bool	is_away	`false`
String	nick	`""`
String	realname	`""`
String	username	`""`

Methods

String

get_prefix() const

Property Descriptions

String account = "" 🔗

void set_account(value: String)
String get_account()

Services account name associated with the user.

String away_message = "" 🔗

void set_away_message(value: String)
String get_away_message()

Message explaining why the user is marked as away.

String hostname = "" 🔗

void set_hostname(value: String)
String get_hostname()

Hostname of the IRC user.

bool is_away = false 🔗

void set_is_away(value: bool)
bool get_is_away()

Whether the user is currently marked as away.

String nick = "" 🔗

void set_nick(value: String)
String get_nick()

Nickname of the IRC user.

String realname = "" 🔗

void set_realname(value: String)
String get_realname()

Real name (gecos field) of the IRC user.

String username = "" 🔗

void set_username(value: String)
String get_username()

Username (ident) of the IRC user.

Method Descriptions

String get_prefix() const 🔗

Returns the fully assembled user mask prefix in the format of 'nickname!username@hostname'.