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 |
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_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_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_got_user_status_with_attributes
Notifies Purple that a buddy’s status has been activated.
Available since: 3.0.0
purple_protocol_initiate_media
Initiates a media session with the given contact.
Instance methods
purple_protocol_can_connect_async
Asks protocol if it can determine if account can be connected.
Available since: 3.0.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.
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_status_types
Gets all of the PurpleStatusType‘s for account which uses protocol.
Available since: 3.0.0
Properties
Purple.Protocol:description
Purple.Protocol:icon-name
Purple.Protocol:icon-resource-path
Purple.Protocol:icon-search-path
Purple.Protocol:id
Purple.Protocol:name
Purple.Protocol:options
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) (
PurpleProtocol* protocol,
PurpleAccount* account
);
void (* close) (
PurpleProtocol* protocol,
PurpleConnection* connection
);
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
);
GList* (* status_types) (
PurpleProtocol* protocol,
PurpleAccount* account
);
}Class members
parent_class |
|
| No description available. | |
get_user_splits |
|
| No description available. | |
get_account_options |
|
| No description available. | |
get_buddy_icon_spec |
|
| No description available. | |
get_whiteboard_ops |
|
| No description available. | |
login |
|
| No description available. | |
close |
|
| No description available. | |
can_connect_async |
|
| No description available. | |
can_connect_finish |
|
| No description available. | |
create_connection |
|
| No description available. | |
status_types |
|
| No description available. |
Virtual methods
Purple.ProtocolClass.can_connect_async
Asks protocol if it can determine if account can be connected.
Available since: 3.0.0
Purple.ProtocolClass.can_connect_finish
This should be called from the callback of
purple_protocol_can_connect_async() to get the result of the call.
Available since: 3.0.0
Purple.ProtocolClass.create_connection
Creates a PurpleConnection for account.
Available since: 3.0.0
Purple.ProtocolClass.get_account_options
Gets the account options for a protocol.
Available since: 3.0.0
Purple.ProtocolClass.get_buddy_icon_spec
Purple.ProtocolClass.get_whiteboard_ops
Gets the whiteboard ops of a protocol.
Available since: 3.0.0