Merged silc_1_1_branch to trunk.
[silc.git] / lib / doc / notifyargs.html
index 5cf9d87bef5956d5d69ac321ad2fe55de9baf7d3..c9c904d5aafee1d04012a9420b29979c9f1cd282 100644 (file)
@@ -85,7 +85,7 @@ The 'message' argument may be NULL.
 Sent to the client if the user is invited on a channel. The 'channel
 argument may be NULL but the `channel_name' is always provided.
 </td>
-<td width="50%"><small>SilcClientChannel channel, char *channel_name,
+<td width="50%"><small>SilcChannelEntry channel, char *channel_name,
 SilcClientEntry inviter
 </td>
 </tr>
@@ -93,7 +93,8 @@ SilcClientEntry inviter
 <tr>
 <td><small>SILC_NOTIFY_TYPE_JOIN</td>
 <td><small>
-Sent when someone joins to a channel.
+Sent when someone joins to a channel.  This is also sent whenever you join
+a channel, in addition of receiving SILC_COMMAND_JOIN command reply.
 </td>
 <td width="50%"><small>SilcClientEntry joining_client, SilcChannelEntry channel
 </td>
@@ -112,11 +113,11 @@ Sent when someone leaves (parts) the channel.
 <td><small>SILC_NOTIFY_TYPE_SIGNOFF</td>
 <td><small>
 Sent when someone signoff the SILC network.  The 'signoff_message' may be
-NULL.  The 'leaving_client' SilcClientEntry may be incomplete and contain
-NULL pointers, application must check it's pointers before attempting to
-display for example nickname information.
+NULL.  The `signoff_client' is the client signing off.  The `channel' is
+the channel where the client was joined.  The `channel' may be NULL.
 </td>
-<td width="50%"><small>SilcClientEntry signoff_client, char *signoff_message
+<td width="50%"><small>SilcClientEntry signoff_client, char
+*signoff_message, SilcChannelEntry channel
 </td>
 </tr>
 
@@ -208,9 +209,11 @@ safely ignore it when received.
 <td><small>
 Sent when a server quits the network.  The 'clients' is a list of
 SilcClientEntry pointers.  Each client in the entry is one client signing
-off from the SILC network.  The library will free the list.
+off from the SILC network.  The library will free the list.  The `server'
+is the quitting server, and it is NULL if the server isn't cached in the
+client library.
 </td>
-<td width="50%"><small>NULL, SilcClientEntry *clients, SilcUInt32 clients_count
+<td width="50%"><small>SilcServerEntry server, SilcDList clients
 </td>
 </tr>
 
@@ -261,7 +264,9 @@ client just changed nickname the 'new_nickname' includes the new nickname.
 Otherwise this pointer is NULL.  The 'user_mode' is the client's mode in
 the SILC network.  The 'notification' contains the notify type that
 happened for the 'watched_client' (for example
-SILC_NOTIFY_TYPE_NICK_CHANGE if the client changed their nickname).
+SILC_NOTIFY_TYPE_NICK_CHANGE if the client changed their nickname).  If
+the `new_nickname' is NULL and `notification' is SILC_NOTIFY_TYPE_NONE the
+`watched_client' has just joined the network.
 </td>
 <td width="50%"><small>SilcClientEntry watched_client, char *new_nickname,
 SilcUInt32 user_mode, SilcNotifyType notification, SilcPublicKey