Class

PurpleProtocol

Description [src]

abstract class Purple.Protocol : GObject.Object {
  parent_instance: GObject
}

PurpleProtocol is the base type for all protocols in libpurple.

Available since:3.0.0

Ancestors

Functions

purple_protocol_change_account_status

Informs the server that our account’s status changed.

purple_protocol_get_media_caps

Determines if the contact supports the given media session type.

purple_protocol_get_statuses

Retrieves the list of stock status types from a protocol.

purple_protocol_got_account_actions

Notifies Purple that our account’s actions have changed. This is only called after the initial connection. Emits the account-actions-changed signal.

purple_protocol_got_account_idle

Notifies Purple that our account’s idle state and time have changed.

purple_protocol_got_account_login_time

Notifies Purple of our account’s log-in time.

purple_protocol_got_account_status

Notifies Purple that our account’s status has changed.

purple_protocol_got_media_caps

Signals that the protocol received capabilities for the given contact.

purple_protocol_got_user_idle

Notifies Purple that a buddy’s idle state and time have changed.

purple_protocol_got_user_login_time

Notifies Purple of a buddy’s log-in time.

purple_protocol_got_user_status

Notifies Purple that a buddy’s status has been activated.

purple_protocol_got_user_status_deactive

Notifies libpurple that a buddy’s status has been deactivated.

purple_protocol_initiate_media

Initiates a media session with the given contact.

Instance methods

purple_protocol_close

Closes connection using protocol.

Available since: 3.0.0

purple_protocol_get_account_options

Gets the account options for a protocol.

Available since: 3.0.0

purple_protocol_get_description

Gets the description of a protocol.

Available since: 3.0.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().

Available since: 3.0.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.

Available since: 3.0.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.

Available since: 3.0.0

purple_protocol_get_icon_spec

Gets the icon spec of a protocol.

Available since: 3.0.0

purple_protocol_get_id

Gets the ID of a protocol.

Available since: 3.0.0

purple_protocol_get_name

Gets the translated name of a protocol.

Available since: 3.0.0

purple_protocol_get_options

Gets the options of a protocol.

Available since: 3.0.0

purple_protocol_get_status_types

Gets all of the PurpleStatusTypes for account which uses protocol.

Available since: 3.0.0

purple_protocol_get_user_splits

Gets the user splits of a protocol.

Available since: 3.0.0

purple_protocol_get_whiteboard_ops

Gets the whiteboard ops of a protocol.

Available since: 3.0.0

purple_protocol_login

Logs account in using protocol.

Available since: 3.0.0

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Purple.Protocol:description
No description available.
Purple.Protocol:icon-name
No description available.
Purple.Protocol:icon-resource-path
No description available.
Purple.Protocol:icon-search-path
No description available.
Purple.Protocol:id
No description available.
Purple.Protocol:name
No description available.
Purple.Protocol:options
No description available.

Signals

Signals inherited from GObject (1)
GObject.Object::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
  );
  PurpleBuddyIconSpec* (* get_buddy_icon_spec) (
    PurpleProtocol* protocol
  );
  PurpleWhiteboardOps* (* get_whiteboard_ops) (
    PurpleProtocol* protocol
  );
  void (* login) (
    PurpleAccount* account
  );
  void (* close) (
    PurpleConnection* connection
  );
  GList* (* status_types) (
    PurpleAccount* account
  );
  
}
Class members
parent_class
GObjectClass
  No description available.
get_user_splits
GList* (* get_user_splits) (
    PurpleProtocol* protocol
  )
  No description available.
get_account_options
GList* (* get_account_options) (
    PurpleProtocol* protocol
  )
  No description available.
get_buddy_icon_spec
PurpleBuddyIconSpec* (* get_buddy_icon_spec) (
    PurpleProtocol* protocol
  )
  No description available.
get_whiteboard_ops
PurpleWhiteboardOps* (* get_whiteboard_ops) (
    PurpleProtocol* protocol
  )
  No description available.
login
void (* login) (
    PurpleAccount* account
  )
  No description available.
close
void (* close) (
    PurpleConnection* connection
  )
  No description available.
status_types
GList* (* status_types) (
    PurpleAccount* account
  )
  No description available.

Virtual methods

Purple.ProtocolClass.get_account_options

Gets the account options for a protocol.

Available since: 3.0.0

Purple.ProtocolClass.get_buddy_icon_spec
No description available.
Purple.ProtocolClass.get_user_splits

Gets the user splits of a protocol.

Available since: 3.0.0

Purple.ProtocolClass.get_whiteboard_ops

Gets the whiteboard ops of a protocol.

Available since: 3.0.0