Class

PurpleProtocol

unstable since: 3.0

Description [src]

abstract class Purple.Protocol : GObject.Object
{
  /* No available fields */
}

PurpleProtocol is the base type for all protocols in libpurple.

Available since: 3.0

Ancestors

GObject

Instance methods

purple_protocol_can_connect_async

Asks protocol if it can determine if account can be connected.

unstable since: 3.0

purple_protocol_can_connect_finish

This should be called from the callback of purple_protocol_can_connect_async() to get the result of the call.

unstable since: 3.0

purple_protocol_create_connection

Creates a PurpleConnection for account.

unstable since: 3.0

purple_protocol_generate_account_name

Generates a name for an account.

unstable since: 3.0

purple_protocol_get_account_options

Gets the account options for a protocol.

unstable since: 3.0

purple_protocol_get_action_menu

Gets a BirbActionMenu for account.

unstable since: 3.0

purple_protocol_get_description

Gets the description of a protocol.

unstable since: 3.0

purple_protocol_get_icon_name

Gets the name of the icon that the protocol made available via either purple_protocol_get_icon_search_path() or purple_protocol_get_resource_path().

unstable since: 3.0

purple_protocol_get_icon_resource_path

Gets the icon resource path for protocol. This is used to make icons that have been embedded into a plugin available to libpurple. The returned value should be the path of where the icons are in the resource. See gtk_icon_theme_add_resource_path() for additional information.

unstable since: 3.0

purple_protocol_get_icon_search_path

Gets the icon search path for protocol. This is used to allow protocol plugins to install their icons in any XDG icon theme compliant directory. The returned value should be the path of where the icons are on disk. See gtk_icon_theme_add_search_path() for additional information.

unstable since: 3.0

purple_protocol_get_id

Gets the ID of a protocol.

unstable since: 3.0

purple_protocol_get_name

Gets the translated name of a protocol.

unstable since: 3.0

purple_protocol_get_options

Gets the options of a protocol.

unstable since: 3.0

purple_protocol_get_tags

Gets the tags object from the protocol.

unstable since: 3.0

purple_protocol_get_user_splits

Gets the user splits of a protocol.

unstable since: 3.0

purple_protocol_get_whiteboard_ops

Gets the whiteboard ops of a protocol.

unstable since: 3.0

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Purple.Protocol:description

The description to show in user interface for the protocol.

unstable since: 3.0

Purple.Protocol:icon-name

The name of an icon that has been installed to either the path specified via PurpleProtocol::icon-search-path or PurpleProtocol::icon-resource-path.

unstable since: 3.0

Purple.Protocol:icon-resource-path

A GResource path which contains the icons for the protocol. See purple_protocol_get_icon_resource_path() for more information.

unstable since: 3.0

Purple.Protocol:icon-search-path

The path to an XDG Icon Theme directory which contains the icons for the protocol. See purple_protocol_get_icon_search_path() for more information.

unstable since: 3.0

Purple.Protocol:id

The identifier for the protocol.

unstable since: 3.0

Purple.Protocol:name

The name to show in user interface for the protocol.

unstable since: 3.0

Purple.Protocol:options

The PurpleProtocolOptions for the protocol.

unstable since: 3.0

Purple.Protocol:tags

A PurpleTags instance for the protocol.

unstable 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 PurpleProtocolClass {
  GObjectClass parent_class;
  GList* (* get_user_splits) (
    PurpleProtocol* protocol
  );
  GList* (* get_account_options) (
    PurpleProtocol* protocol
  );
  PurpleWhiteboardOps* (* get_whiteboard_ops) (
    PurpleProtocol* protocol
  );
  char* (* generate_account_name) (
    PurpleProtocol* protocol,
    PurpleAccount* account,
    guint n_accounts
  );
  void (* can_connect_async) (
    PurpleProtocol* protocol,
    PurpleAccount* account,
    GCancellable* cancellable,
    GAsyncReadyCallback callback,
    gpointer data
  );
  gboolean (* can_connect_finish) (
    PurpleProtocol* protocol,
    GAsyncResult* result,
    GError** error
  );
  PurpleConnection* (* create_connection) (
    PurpleProtocol* protocol,
    PurpleAccount* account,
    const char* password,
    GError** error
  );
  BirbActionMenu* (* get_action_menu) (
    PurpleProtocol* protocol,
    PurpleAccount* account
  );
  
}

The base class for all protocols.

All protocol types must implement the methods in this class.

Class members

parent_class: GObjectClass: No description available.
get_user_splits: GList* (* get_user_splits) ( PurpleProtocol* protocol ): Returns a list of all PurpleAccountUserSplit‘s that the procotol provides.
get_account_options: GList* (* get_account_options) ( PurpleProtocol* protocol ): Returns a list of all PurpleAccountOption‘s for the protocol.
get_whiteboard_ops: PurpleWhiteboardOps* (* get_whiteboard_ops) ( PurpleProtocol* protocol ): Return the PurpleWhiteboardOps that should be used.
generate_account_name: char* (* generate_account_name) ( PurpleProtocol* protocol, PurpleAccount* account, guint n_accounts ): No description available.
can_connect_async: void (* can_connect_async) ( PurpleProtocol* protocol, PurpleAccount* account, GCancellable* cancellable, GAsyncReadyCallback callback, gpointer data ): No description available.
can_connect_finish: gboolean (* can_connect_finish) ( PurpleProtocol* protocol, GAsyncResult* result, GError** error ): No description available.
create_connection: PurpleConnection* (* create_connection) ( PurpleProtocol* protocol, PurpleAccount* account, const char* password, GError** error ): No description available.
get_action_menu: BirbActionMenu* (* get_action_menu) ( PurpleProtocol* protocol, PurpleAccount* account ): No description available.

Description [src]

Ancestors

Instance methods

Methods inherited from GObject (43)

Properties

Signals

Signals inherited from GObject (1)

Class structure

Class members

Virtual methods