annotate doc/notify-signals.dox @ 32533:e091c8ea292e

Pluck all MSNP18 changes. This is pretty much to fix sending OIMs. *** Plucked rev b8b574c4d6f6c05105b372191ca5259b4ae0ad41 ([e-mail]): Add a function for parsing a network:username for MSNP18. *** Plucked rev 86bb401efa33f02ca5d28fea216a39a3cf29b5b4 ([e-mail]): Fix UBX on MSNP18. *** Plucked rev ba2513694e6abcbdfddc66820f1df20540a36847 ([e-mail]): Fix NLN on MSNP18. *** Plucked rev 83a617670da618f4dbdeeebbdb5e2813a4ad2c0c ([e-mail]): Switch to ABFindContactsPaged instead of ABFindAll. *** Plucked rev b6bd214d29db885c6d28628c163fa144bdf4a76d ([e-mail]): Send circle authentication on the notification server on MSNP18. *** Plucked rev 2ca50146aa67469313579cea414e4a2b660939aa ([e-mail]): Make a small name change. *** Plucked rev 2c13bf358104060d6713317e18e03b434862cb38 ([e-mail]): Add a missing function. *** Plucked rev a8deb3f73726f4148e8f36f317a88fedcb051c34 ([e-mail]): Update UUM to allow sending to users on any network. *** Plucked rev dddff988e830a7a2fa0e40aad200f0e908b9231e ([e-mail]): Switch to MSNP18. *** Plucked rev 9fe45819000c530c509c07b7feb29ce9d4ea13b0 ([e-mail]): Send offline messages using UUM. *** Plucked rev c1584182b85f99fa3507ea3f76b07865ee7e43f7 ([e-mail]): Drop support for protocols below 18. *** Plucked rev f0388e54998489dbe4b6133796f77459f20fe884 ([e-mail]): Fix indices for client capabilities and display pics.

/** @page notify-signals Notification Signals

 @signals
  @signal displaying-userinfo
  @signal displaying-email-notification
  @signal displaying-emails-notification
 @endsignals

 @see notify.h

 @signaldef displaying-userinfo
  @signalproto
void (*displaying_userinfo)(PurpleAccount *account, const char *who, PurpleNotifyUserInfo *user_info);
  @endsignalproto
  @signaldesc
   Emitted before userinfo is handed to the UI to display.
   @a user_info can be manipulated via the PurpleNotifyUserInfo API in notify.c.
  @note
    If adding a PurpleNotifyUserInfoEntry, be sure not to free it -- PurpleNotifyUserInfo assumes responsibility for its objects.
  @param account   The account on which the info was obtained.
  @param who       The name of the buddy whose info is to be displayed.
  @param user_info The information to be displayed, as PurpleNotifyUserInfoEntry objects
 @endsignaldef

 @signaldef displaying-email-notification
  @signalproto
void (*displaying_email_notification)(const char *subject,
                                      const char *from,
                                      const char *to,
                                      const char *url);
  @endsignalproto
  @signaldesc
   Emitted before notification of a single email is handed to the UI to display.
  @param subject   Subject of email being notified of.
  @param from      Who the email is from.
  @param to        Who the email is to.
  @param url       A url to view the email.
  @since 2.1.0
 @endsignaldef

 @signaldef displaying-emails-notification
  @signalproto
void (*displaying_emails_notification)(const char **subjects,
                                       const char **froms,
                                       const char **tos,
                                       const char **urls,
                                       guint count);
  @endsignalproto
  @signaldesc
   Emitted before notification of multiple emails is handed to the UI to display.
  @param subjects   Subjects of emails being notified of.
  @param froms      Who the emails are from.
  @param tos        Who the emails are to.
  @param urls       The urls to view the emails.
  @param count      Number of emails being notified of.
  @since 2.1.0
 @endsignaldef

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