Class

PurpleConnection

Description [src]

class Purple.Connection : GObject.Object {
  parent_instance: GObject
}

Represents an active connection on an account.

Ancestors

GObject

Instance methods

purple_connection_connect

Tells the connection to connect. This is done by calling the Purple.ConnectionClass.connect function. State is managed by this function.

since: 3.0

purple_connection_disconnect

Tells the connection to disconnect. This is done by calling the Purple.ConnectionClass.disconnect function. State is managed by this function.

since: 3.0

purple_connection_error

Closes a connection with an error and a human-readable description of the error.

since: 2.0

purple_connection_g_error

Closes a connection similar to purple_connection_error(), but takes a GError which is then converted to purple error codes.

since: 3.0

purple_connection_get_account

Returns the connection’s account.

since: 2.0

purple_connection_get_cancellable

Gets the cancellable that should be used with connection.

since: 3.0

purple_connection_get_display_name

Returns the connection’s displayed name.

since: 2.0

purple_connection_get_error_info

Returns the PurpleConnectionErrorInfo instance of a connection if an error exists.

since: 3.0

purple_connection_get_id

Gets the identifier of the connection.

since: 3.0

purple_connection_get_password

Returns the connection’s password.

since: 2.0

purple_connection_get_protocol

Returns the protocol managing a connection.

since: 3.0

purple_connection_set_display_name

Sets the connection’s displayed name.

since: 2.0

purple_connection_set_password

Sets the password for connection to password.

since: 3.0

Sets the connection state. Protocols should call this and pass in the state #PURPLE_CONNECTION_CONNECTED when the account is completely signed on. What does it mean to be completely signed on? If the core can call protocol’s set_status, and it successfully changes your status, then the account is online.

since: 2.0

purple_connection_take_error

Closes a connection similar to purple_connection_error(), but takes a GError which is then converted to purple error codes.

since: 3.0

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Purple.Connection:account

The account this connection belongs to.

since: 3.0

Purple.Connection:cancellable

A GCancellable to be used with the connection.

since: 3.0

Purple.Connection:display-name

The display name for the account.

since: 3.0

Purple.Connection:flags

The flags for this connection.

since: 3.0

Purple.Connection:id

The unique identifier for the connection.

since: 3.0

Purple.Connection:password

The password for this connection.

since: 3.0

Purple.Connection:protocol

The protocol that this connection is for.

since: 3.0

Purple.Connection:state

The state of the connection.

since: 3.0

Signals

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 PurpleConnectionClass {
  gboolean (* connect) (
    PurpleConnection* connection,
    GError** error
  );
  gboolean (* disconnect) (
    PurpleConnection* connection,
    GError** error
  );
  
}

No description available.

Class members

connect: gboolean (* connect) ( PurpleConnection* connection, GError** error ): No description available.
disconnect: gboolean (* disconnect) ( PurpleConnection* connection, GError** error ): No description available.

Virtual methods

Purple.ConnectionClass.connect

Tells the connection to connect. This is done by calling the Purple.ConnectionClass.connect function. State is managed by this function.

since: 3.0

Purple.ConnectionClass.disconnect

Tells the connection to disconnect. This is done by calling the Purple.ConnectionClass.disconnect function. State is managed by this function.

since: 3.0