Interface

PurpleProtocolIM

Description [src]

interface Purple.ProtocolIM : Purple.Protocol

PurpleProtocolIM describes the API that protocols need to implement for handling one on one conversations.

Available since:3.0.0

Prerequisite

In order to implement ProtocolIM, your type must inherit from PurpleProtocol.

Instance methods

purple_protocol_im_send

Sends msg out over connection.

purple_protocol_im_send_typing

If this protocol requires the #PURPLE_IM_TYPING message to be sent repeatedly to signify that the user is still typing, then the protocol should return the number of seconds to wait before sending a subsequent notification. Otherwise the protocol should return 0.

Interface structure

struct PurpleProtocolIMInterface {
  gint (* send) (
    PurpleProtocolIM* im,
    PurpleConnection* connection,
    PurpleMessage* msg
  );
  guint (* send_typing) (
    PurpleProtocolIM* im,
    PurpleConnection* connection,
    const gchar* name,
    PurpleIMTypingState state
  );
  
}
Interface members
send
gint (* send) (
    PurpleProtocolIM* im,
    PurpleConnection* connection,
    PurpleMessage* msg
  )
 No description available.
send_typing
guint (* send_typing) (
    PurpleProtocolIM* im,
    PurpleConnection* connection,
    const gchar* name,
    PurpleIMTypingState state
  )
 No description available.

Virtual methods

Purple.ProtocolIM.send

Sends msg out over connection.

Purple.ProtocolIM.send_typing

If this protocol requires the #PURPLE_IM_TYPING message to be sent repeatedly to signify that the user is still typing, then the protocol should return the number of seconds to wait before sending a subsequent notification. Otherwise the protocol should return 0.