diff doc/xfer-signals.dox @ 13219:d0f7f698b6de

[gaim-migrate @ 15583] SF Patch #1428591 from Sadrul "This is a new signal, emitted when request for a file-transfer comes in. I have written a trivial plugin (which I plan on adding under plugin_pack in a couple of days) that uses this signal to auto-accept file-transfers. I have tested the plugin to auto-accept or auto-reject file-transfer requests." I also noticed that the file transfer signals weren't using a subtype for GaimXfer pointers, so I added one. committer: Tailor Script <tailor@pidgin.im>
author Richard Laager <rlaager@wiktel.com>
date Sat, 11 Feb 2006 05:24:30 +0000
parents 920a37a4c1be
children 8cf53d7a0887
line wrap: on
line diff
--- a/doc/xfer-signals.dox	Sat Feb 11 05:18:48 2006 +0000
+++ b/doc/xfer-signals.dox	Sat Feb 11 05:24:30 2006 +0000
@@ -5,6 +5,7 @@
   @signal file-recv-start
   @signal file-recv-cancel
   @signal file-recv-complete
+  @signal file-recv-request
   @signal file-send-accept
   @signal file-send-start
   @signal file-send-cancel
@@ -53,6 +54,20 @@
   @param data User data
  @endsignaldef
 
+ @signaldef file-recv-request
+  @signalproto
+void (*file_recv_request)(GaimXfer *xfer, gpointer data);
+  @endsignalproto
+  @signaldesc
+   Emitted before the user is prompted for an incoming file-transfer.
+   Plugins can intercept the signal to auto-accept/auto-reject the
+   requests. To auto-accept the file transfer, use
+   gaim_xfer_request_accepted(). To auto-reject, set the status of the
+   xfer to GAIM_XFER_STATUS_CANCEL_LOCAL.
+  @param xfer The file transfer
+  @param data User data
+ @endsignaldef
+
  @signaldef file-send-accept
   @signalproto
 void (*file_send_accept)(GaimXfer *xfer, gpointer data);