Browse Source

More docs

wip-ping-timeouts
Chris Smith 5 years ago
parent
commit
eb2e588a4a
1 changed files with 34 additions and 6 deletions
  1. 34
    6
      docs/index.adoc

+ 34
- 6
docs/index.adoc View File

1103
 even if the CTCP is sent to a channel. The `target` parameter
1103
 even if the CTCP is sent to a channel. The `target` parameter
1104
 should therefore be the local user in most cases.
1104
 should therefore be the local user in most cases.
1105
 
1105
 
1106
+==== ModeChanged
1107
+
1108
+TODO
1109
+
1106
 === User events
1110
 === User events
1107
 
1111
 
1108
 TODO
1112
 TODO
1121
 If the user is away but we don't know the reason for it, the `message`
1125
 If the user is away but we don't know the reason for it, the `message`
1122
 property will be empty.
1126
 property will be empty.
1123
 
1127
 
1124
-==== ModeChanged
1125
-
1126
-TODO
1128
+For each channel the user is on, a <<ChannelAway>> event will be generated.
1127
 
1129
 
1128
 ==== UserQuit
1130
 ==== UserQuit
1129
 
1131
 
1130
 TODO
1132
 TODO
1131
 
1133
 
1132
 ==== UserNickChanged
1134
 ==== UserNickChanged
1135
+* Type: IrcEvent, SourcedEvent
1136
+* Properties:
1137
+** `user`: `User` - the user who has changed their nickname
1138
+** `newNick`: `String` - the new nickname of the user
1133
 
1139
 
1134
-TODO
1140
+Raised when we are informed that a user has changed nicknames.
1141
+For each channel the user is on, a <<ChannelNickChanged>> event will be
1142
+generated
1143
+
1144
+TIP: The user property will contain the user's old details, but you will
1145
+not be able to access additional information from the <<UserState>> using
1146
+these details as KtIrc will have internally renamed the user to use the
1147
+new nickname.
1135
 
1148
 
1136
 ==== UserHostChanged
1149
 ==== UserHostChanged
1150
+* Type: IrcEvent, SourcedEvent
1151
+* Properties:
1152
+** `user`: `User` - the user who has changed their ident/hostname
1153
+** `newIdent`: `String` - the new ident of the user
1154
+** `newHost`: `String` - the new hostname of the user
1137
 
1155
 
1138
-TODO
1156
+Raised when we are informed that a user has changed their ident and/or
1157
+hostname. This is only supported by servers with the `chghost` capability.
1139
 
1158
 
1140
 ==== UserAccountChanged
1159
 ==== UserAccountChanged
1160
+* Type: IrcEvent, SourcedEvent
1161
+* Properties:
1162
+** `user`: `User` - the user who has changed their account
1163
+** `newAccount`: `String?` - the new account of the user
1141
 
1164
 
1142
-TODO
1165
+Raised when we are informed that a user has changed their account name.
1166
+This is only supported by servers with the `account-notify` capability,
1167
+and may occur when the user logs in or out of their account.
1168
+
1169
+If the user is no longer logged in to an account, `newAccount` will be
1170
+`null`.
1143
 
1171
 
1144
 === Other events
1172
 === Other events
1145
 
1173
 

Loading…
Cancel
Save