Class

IbisClient

since: 0.1

Description [src]

final class Ibis.Client : GObject.Object
{
  /* No available fields */
}

A representation of an IRCv3 client.

The client has a bit of functionality built-in but there are some cases where you may have to let the default handler run if you are listening to the generic IbisClient::message signal.

The client uses the IBIS_RPL_WELCOME message to update IbisClient:active-nick. This means your handler will need to return FALSE to let the default handler implement this feature.

Likewise, the client also uses IBIS_MSG_NICK to update the IbisClient:active-nick property if the nick name of the user has been changed via a bouncer or just via a NICK command. So again, your handler will need to return FALSE to let the default handler implement this feature.

Available since: 0.1

Ancestors

GObject

Constructors

ibis_client_new

Creates a new client.

since: 0.1

Instance methods

ibis_client_connect

Attempts to connect to hostname on port.

since: 0.1

ibis_client_disconnect

Disconnects client.

since: 0.1

ibis_client_get_active_nick

Gets the active nick for the client.

since: 0.11

ibis_client_get_alt_nick

Gets the alternative nick to use in the event that IbisClient:nick is already in use.

since: 0.1

ibis_client_get_cancellable

Gets the GCancellable for client.

since: 0.1

ibis_client_get_capabilities

Gets the IbisCapabilities from client.

since: 0.1

ibis_client_get_connected

Gets whether or not client is currently connected.

since: 0.1

ibis_client_get_error

Gets the GError that client encountered.

since: 0.1

ibis_client_get_features

Gets the IbisFeatures from client.

since: 0.4

ibis_client_get_hasl_context

Gets the HaslContext from client.

since: 0.1

ibis_client_get_network

Gets the network that the client is connected to.

since: 0.4

ibis_client_get_nick

Gets the nick from client.

since: 0.1

ibis_client_get_realname

Gets the realname that is being used when sending the USER command.

since: 0.1

ibis_client_get_registered

Checks whether the client has completed user registration.

since: 0.10

ibis_client_get_source_prefix

Gets the Channel Membership Prefix from source according to the prefixes that the server told us in IBIS_RPL_ISUPPORT.

since: 0.8

ibis_client_get_username

Gets the username that is being used when sending the USER command.

since: 0.1

ibis_client_is_channel

Checks if target is a channel.

since: 0.4

ibis_client_normalize

Normalizes input depending on the IBIS_FEATURE_CASEMAPPING feature.

since: 0.7

ibis_client_set_alt_nick

Sets the alternative nick of client to alt_nick.

since: 0.1

ibis_client_set_hasl_context

Sets the HaslContext for client to use.

since: 0.1

ibis_client_set_nick

Sets the nick of client to nick.

since: 0.1

ibis_client_set_realname

Sets the realname to use when sending the USER command.

since: 0.1

ibis_client_set_username

Sets the username to use when sending the USER command.

since: 0.1

ibis_client_start

Starts client.

since: 0.1

ibis_client_stop

Stops client.

since: 0.10

ibis_client_strip_source_prefix

Strips the Channel Membership Prefix from source according to the prefixes that the server told us in IBIS_RPL_ISUPPORT.

since: 0.8

ibis_client_write

Writes message to the server.

since: 0.1

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Ibis.Client:active-nick

The nick that the server has acknowledged.

since: 0.11

Ibis.Client:alt-nick

The alternative nick to use if IbisClient:nick is already in use.

since: 0.1

Ibis.Client:cancellable

The GCancellable for the client.

since: 0.1

Ibis.Client:capabilities

The IbisCapabilities that this client is using.

since: 0.1

Ibis.Client:connected

Set to whether or not the client is currently connected.

since: 0.1

Ibis.Client:error

A GError that the client encountered.

since: 0.1

Ibis.Client:features

The IbisFeatures for this connection.

since: 0.4

Ibis.Client:hasl-context

The HaslContext to use during SASL negotiation.

since: 0.1

Ibis.Client:network

The advertised name of the network from the server sending the IBIS_RPL_ISUPPORT message.

since: 0.4

Ibis.Client:nick

The primary nick to use.

since: 0.1

Ibis.Client:realname

The realname to use when sending the USER command.

since: 0.1

Ibis.Client:registered

Whether or not user registration has been completed.

since: 0.10

Ibis.Client:username

The username to use when sending the USER command.

since: 0.1

Signals inherited from GObject (1)

GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct IbisClientClass {
  GObjectClass parent_class;
  
}

No description available.

Class members

parent_class: GObjectClass: No description available.