view doc/sound-signals.dox @ 19251:78558930d9f3

Replace msim_parse_body(), which returns a GHashTable * and takes a gchar *, to msim_msg_get_dictionary(), which returns an MsimMessage * and operates on an MsimMessage *. msim_msg_get_dictionary() fixes many problems with msim_parse_body(), detailed earlier. The most pressing is that the older function didn't support multiple key/value pairs with the same key name, which is actually quite common in the protocol. Webchallenge and "list all contacts", at least.

/** @page sound-signals Sound Signals

 @signals
  @signal playing-sound-event
 @endsignals

 <hr>

 @signaldef playing-sound-event
  @signalproto
gboolean (*playing_sound_event)(PurpleSoundEventID event, PurpleAccount *account);
  @endsignalproto
  @signaldesc
   Emitted when libpurple is going to play a sound event. This can be used to cancel playing sound by returning TRUE.
  @param event   The event this sound represents.
  @param account The account the sound is being played for.
  @return @c TRUE if the sound should not be played, or @c FALSE otherwise.
 @endsignaldef

 */
// vim: syntax=c tw=75 et