Interface

PurpleProtocolRoster

unstable since: 3.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

[−]

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.

unstable since: 3.0

purple_protocol_roster_add_finish

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

unstable since: 3.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.

unstable since: 3.0

purple_protocol_roster_remove_finish

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

unstable since: 3.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.

unstable since: 3.0

purple_protocol_roster_update_finish

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

unstable since: 3.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
  );
  
}

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.

[−]

Interface

PurpleProtocolRoster

Description [src]

Prerequisite

Instance methods

purple_protocol_roster_add_async

purple_protocol_roster_add_finish

purple_protocol_roster_remove_async

purple_protocol_roster_remove_finish

purple_protocol_roster_update_async

purple_protocol_roster_update_finish

Interface structure

Interface members

Virtual methods

Purple.ProtocolRoster.add_async

Purple.ProtocolRoster.add_finish

Purple.ProtocolRoster.remove_async

Purple.ProtocolRoster.remove_finish

Purple.ProtocolRoster.update_async

Purple.ProtocolRoster.update_finish