Interface

PurpleProtocolRoster

since: 3.0.0

Description [src] 

interface Purple.ProtocolRoster : Purple.Protocol

The PurpleProtocolRoster interface defines the behavior to tell a protocol when the users wants to manage contacts on the server side roster.

Available since: 3.0.0

Prerequisite

In order to implement ProtocolRoster, your type must inherit fromPurpleProtocol.

Instance methods

purple_protocol_roster_add_async

Requests that roster adds contact to the server side roster. When callback is called, purple_protocol_roster_add_finish() should be called to get the result.

since: 3.0.0

purple_protocol_roster_add_finish

Gets the result of a previous call to purple_protocol_roster_add_async().

since: 3.0.0

purple_protocol_roster_remove_async

Requests that roster removes contact from the server side roster. When callback is called, purple_protocol_roster_remove_finish() should be called to get the result.

since: 3.0.0

purple_protocol_roster_remove_finish

Gets the result of a previous call to purple_protocol_roster_remove_async().

since: 3.0.0

purple_protocol_roster_update_async

Requests that roster updates contact on the server side roster. When callback is called, purple_protocol_roster_update_finish() should be called to get the result.

since: 3.0.0

purple_protocol_roster_update_finish

Gets the result of a previous call to purple_protocol_roster_update_async().

since: 3.0.0

Interface structure 

struct PurpleProtocolRosterInterface {
  void (* add_async) (
    PurpleProtocolRoster* roster,
    PurpleAccount* account,
    PurpleContact* contact,
    GCancellable* cancellable,
    GAsyncReadyCallback callback,
    gpointer data
  );
  gboolean (* add_finish) (
    PurpleProtocolRoster* roster,
    GAsyncResult* result,
    GError** error
  );
  void (* update_async) (
    PurpleProtocolRoster* roster,
    PurpleAccount* account,
    PurpleContact* contact,
    GCancellable* cancellable,
    GAsyncReadyCallback callback,
    gpointer data
  );
  gboolean (* update_finish) (
    PurpleProtocolRoster* roster,
    GAsyncResult* result,
    GError** error
  );
  void (* remove_async) (
    PurpleProtocolRoster* roster,
    PurpleAccount* account,
    PurpleContact* contact,
    GCancellable* cancellable,
    GAsyncReadyCallback callback,
    gpointer data
  );
  gboolean (* remove_finish) (
    PurpleProtocolRoster* roster,
    GAsyncResult* result,
    GError** error
  );
  
}

The interface for managing the server side roster.

This interface provides a gateway between purple and the protocol for managing the server side roster. All of the functions are asynchronous to make sure nothing blocks the rest of the program.

Interface members
add_async 
void (* add_async) (
    PurpleProtocolRoster* roster,
    PurpleAccount* account,
    PurpleContact* contact,
    GCancellable* cancellable,
    GAsyncReadyCallback callback,
    gpointer data
  )
 No description available.
add_finish 
gboolean (* add_finish) (
    PurpleProtocolRoster* roster,
    GAsyncResult* result,
    GError** error
  )
 No description available.
update_async 
void (* update_async) (
    PurpleProtocolRoster* roster,
    PurpleAccount* account,
    PurpleContact* contact,
    GCancellable* cancellable,
    GAsyncReadyCallback callback,
    gpointer data
  )
 No description available.
update_finish 
gboolean (* update_finish) (
    PurpleProtocolRoster* roster,
    GAsyncResult* result,
    GError** error
  )
 No description available.
remove_async 
void (* remove_async) (
    PurpleProtocolRoster* roster,
    PurpleAccount* account,
    PurpleContact* contact,
    GCancellable* cancellable,
    GAsyncReadyCallback callback,
    gpointer data
  )
 No description available.
remove_finish 
gboolean (* remove_finish) (
    PurpleProtocolRoster* roster,
    GAsyncResult* result,
    GError** error
  )
 No description available.

Virtual methods

Purple.ProtocolRoster.add_async

Requests that roster adds contact to the server side roster. When callback is called, purple_protocol_roster_add_finish() should be called to get the result.

since: 3.0.0

Purple.ProtocolRoster.add_finish

Gets the result of a previous call to purple_protocol_roster_add_async().

since: 3.0.0

Purple.ProtocolRoster.remove_async

Requests that roster removes contact from the server side roster. When callback is called, purple_protocol_roster_remove_finish() should be called to get the result.

since: 3.0.0

Purple.ProtocolRoster.remove_finish

Gets the result of a previous call to purple_protocol_roster_remove_async().

since: 3.0.0

Purple.ProtocolRoster.update_async

Requests that roster updates contact on the server side roster. When callback is called, purple_protocol_roster_update_finish() should be called to get the result.

since: 3.0.0

Purple.ProtocolRoster.update_finish

Gets the result of a previous call to purple_protocol_roster_update_async().

since: 3.0.0