root/tags/2C10/Resources/ChatPlugIn.scriptTerminology

Revision 1819, 13.5 kB (checked in by timothy, 4 years ago)

Changed the wording so you know you don't need to return a message for the process message handlers.

Line 
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
3 <plist version="1.0">
4 <dict>
5         <key>Commands</key>
6         <dict>
7                 <key>performNotification</key>
8                 <dict>
9                         <key>UnnamedArgument</key>
10                         <dict>
11                                 <key>Description</key>
12                                 <string>Identifier of the notification to perform.</string>
13                         </dict>
14                         <key>Arguments</key>
15                         <dict>
16                                 <key>context</key>
17                                 <dict>
18                                         <key>Description</key>
19                                         <string>Notification specific context information. Usually contains a human-readable message to display.</string>
20                                         <key>Name</key>
21                                         <string>with</string>
22                                 </dict>
23                                 <key>preferences</key>
24                                 <dict>
25                                         <key>Description</key>
26                                         <string>Preferences for the notification. From the Notification preferences panel.</string>
27                                         <key>Name</key>
28                                         <string>and</string>
29                                 </dict>
30                         </dict>
31                         <key>Description</key>
32                         <string>Called for every notification event like Buddy Offline, Name Mentioned, Message Ignored, etc. If you want to trigger on select events you should use a more specific handler; this handler is intended for limited context, high-level notifications only.</string>
33                         <key>Name</key>
34                         <string>perform notification</string>
35                 </dict>
36                 <key>processUserCommand</key>
37                 <dict>
38                         <key>UnnamedArgument</key>
39                         <dict>
40                                 <key>Description</key>
41                                 <string>Command to process.</string>
42                         </dict>
43                         <key>Arguments</key>
44                         <dict>
45                                 <key>arguments</key>
46                                 <dict>
47                                         <key>Description</key>
48                                         <string>Any arguments given with the command.</string>
49                                         <key>Name</key>
50                                         <string>with</string>
51                                 </dict>
52                                 <key>view</key>
53                                 <dict>
54                                         <key>Description</key>
55                                         <string>The view the command was entered in.</string>
56                                         <key>Name</key>
57                                         <string>for</string>
58                                 </dict>
59                         </dict>
60                         <key>Description</key>
61                         <string>Called when the user types an unhandled "/command". Return true to prevent other plugins from processing this command. If no plugins return true, the command is sent "raw" to the server.</string>
62                         <key>Name</key>
63                         <string>process user command</string>
64                 </dict>
65                 <key>processSubcodeRequest</key>
66                 <dict>
67                         <key>UnnamedArgument</key>
68                         <dict>
69                                 <key>Description</key>
70                                 <string>CTCP request to process.</string>
71                         </dict>
72                         <key>Arguments</key>
73                         <dict>
74                                 <key>arguments</key>
75                                 <dict>
76                                         <key>Description</key>
77                                         <string>Any arguments given with the request.</string>
78                                         <key>Name</key>
79                                         <string>with</string>
80                                 </dict>
81                                 <key>user</key>
82                                 <dict>
83                                         <key>Description</key>
84                                         <string>The user this request came from.</string>
85                                         <key>Name</key>
86                                         <string>from</string>
87                                 </dict>
88                                 <key>connection</key>
89                                 <dict>
90                                         <key>Description</key>
91                                         <string>The conenction this request came on.</string>
92                                         <key>Name</key>
93                                         <string>on</string>
94                                 </dict>
95                         </dict>
96                         <key>Description</key>
97                         <string>Called when an unhandled CTCP request gets sent to us from another user. Return true to prevent other plugins from processing this request.</string>
98                         <key>Name</key>
99                         <string>process subcode request</string>
100                 </dict>
101                 <key>processSubcodeReply</key>
102                 <dict>
103                         <key>UnnamedArgument</key>
104                         <dict>
105                                 <key>Description</key>
106                                 <string>CTCP reply to process.</string>
107                         </dict>
108                         <key>Arguments</key>
109                         <dict>
110                                 <key>arguments</key>
111                                 <dict>
112                                         <key>Description</key>
113                                         <string>Any arguments given with the reply.</string>
114                                         <key>Name</key>
115                                         <string>with</string>
116                                 </dict>
117                                 <key>user</key>
118                                 <dict>
119                                         <key>Description</key>
120                                         <string>The user this reply came from.</string>
121                                         <key>Name</key>
122                                         <string>from</string>
123                                 </dict>
124                                 <key>connection</key>
125                                 <dict>
126                                         <key>Description</key>
127                                         <string>The conenction this reply came on.</string>
128                                         <key>Name</key>
129                                         <string>on</string>
130                                 </dict>
131                         </dict>
132                         <key>Description</key>
133                         <string>Called when an unhandled CTCP reply gets sent to us from another user. Return true to prevent other plugins from processing this reply.</string>
134                         <key>Name</key>
135                         <string>process subcode reply</string>
136                 </dict>
137                 <key>processIncomingChatMessage</key>
138                 <dict>
139                         <key>UnnamedArgument</key>
140                         <dict>
141                                 <key>Description</key>
142                                 <string>The incoming message. Message and properties are modifiable.</string>
143                         </dict>
144                         <key>Arguments</key>
145                         <dict>
146                                 <key>action</key>
147                                 <dict>
148                                         <key>Description</key>
149                                         <string>Is this message an action?</string>
150                                         <key>Name</key>
151                                         <string>as</string>
152                                 </dict>
153                                 <key>user</key>
154                                 <dict>
155                                         <key>Description</key>
156                                         <string>The user this message came from.</string>
157                                         <key>Name</key>
158                                         <string>from</string>
159                                 </dict>
160                                 <key>view</key>
161                                 <dict>
162                                         <key>Description</key>
163                                         <string>The chat room or direct chat this message is in.</string>
164                                         <key>Name</key>
165                                         <string>in</string>
166                                 </dict>
167                         </dict>
168                         <key>Description</key>
169                         <string>Called when an incoming message is sent to us or a room we are in.</string>
170                         <key>Name</key>
171                         <string>process incoming chat message</string>
172                 </dict>
173                 <key>processOutgoingChatMessage</key>
174                 <dict>
175                         <key>UnnamedArgument</key>
176                         <dict>
177                                 <key>Description</key>
178                                 <string>The outgoing message. Message and properties are modifiable.</string>
179                         </dict>
180                         <key>Arguments</key>
181                         <dict>
182                                 <key>action</key>
183                                 <dict>
184                                         <key>Description</key>
185                                         <string>Is this message an action?</string>
186                                         <key>Name</key>
187                                         <string>as</string>
188                                 </dict>
189                                 <key>view</key>
190                                 <dict>
191                                         <key>Description</key>
192                                         <string>The chat room or direct chat this message is in.</string>
193                                         <key>Name</key>
194                                         <string>in</string>
195                                 </dict>
196                         </dict>
197                         <key>Description</key>
198                         <string>Called when a message is sent from us to a user or room we are in.</string>
199                         <key>Name</key>
200                         <string>process outgoing chat message</string>
201                 </dict>
202                 <key>handleClickedLink</key>
203                 <dict>
204                         <key>UnnamedArgument</key>
205                         <dict>
206                                 <key>Description</key>
207                                 <string>The URL of the clicked link.</string>
208                         </dict>
209                         <key>Arguments</key>
210                         <dict>
211                                 <key>view</key>
212                                 <dict>
213                                         <key>Description</key>
214                                         <string>The chat room, direct chat or chat transcript this link was clicked in.</string>
215                                         <key>Name</key>
216                                         <string>in</string>
217                                 </dict>
218                         </dict>
219                         <key>Description</key>
220                         <string>Called when a (currently unhandled) link is clicked in a conversation. Return true to prevent Colloquy and other plugins from handling this clicked link.</string>
221                         <key>Name</key>
222                         <string>handle clicked link</string>
223                 </dict>
224                 <key>joinedRoom</key>
225                 <dict>
226                         <key>UnnamedArgument</key>
227                         <dict>
228                                 <key>Description</key>
229                                 <string>The chat room.</string>
230                         </dict>
231                         <key>Description</key>
232                         <string>Called when we join a room.</string>
233                         <key>Name</key>
234                         <string>joined chat room</string>
235                 </dict>
236                 <key>partingRoom</key>
237                 <dict>
238                         <key>UnnamedArgument</key>
239                         <dict>
240                                 <key>Description</key>
241                                 <string>The chat room.</string>
242                         </dict>
243                         <key>Description</key>
244                         <string>Called when we are in the process of laveing a room. Messages can still be sent.</string>
245                         <key>Name</key>
246                         <string>parting chat room</string>
247                 </dict>
248                 <key>connected</key>
249                 <dict>
250                         <key>UnnamedArgument</key>
251                         <dict>
252                                 <key>Description</key>
253                                 <string>The chat conenction.</string>
254                         </dict>
255                         <key>Description</key>
256                         <string>Called when we have just finished connecting to a chat server.</string>
257                         <key>Name</key>
258                         <string>connected</string>
259                 </dict>
260                 <key>disconnecting</key>
261                 <dict>
262                         <key>UnnamedArgument</key>
263                         <dict>
264                                 <key>Description</key>
265                                 <string>The chat conenction.</string>
266                         </dict>
267                         <key>Description</key>
268                         <string>Called when we are in the process of disconnecting from a chat server. Messages can still be sent.</string>
269                         <key>Name</key>
270                         <string>disconnecting</string>
271                 </dict>
272                 <key>kickedFromRoom</key>
273                 <dict>
274                         <key>UnnamedArgument</key>
275                         <dict>
276                                 <key>Description</key>
277                                 <string>The chat room.</string>
278                         </dict>
279                         <key>Arguments</key>
280                         <dict>
281                                 <key>by</key>
282                                 <dict>
283                                         <key>Description</key>
284                                         <string>The member who kicked us out.</string>
285                                         <key>Name</key>
286                                         <string>by</string>
287                                 </dict>
288                                 <key>reason</key>
289                                 <dict>
290                                         <key>Description</key>
291                                         <string>The reason given for kicking us out.</string>
292                                         <key>Name</key>
293                                         <string>for</string>
294                                 </dict>
295                         </dict>
296                         <key>Description</key>
297                         <string>Called when we are kicked out of a room by another member.</string>
298                         <key>Name</key>
299                         <string>kicked from room</string>
300                 </dict>
301                 <key>memberJoinedRoom</key>
302                 <dict>
303                         <key>UnnamedArgument</key>
304                         <dict>
305                                 <key>Description</key>
306                                 <string>The member.</string>
307                         </dict>
308                         <key>Arguments</key>
309                         <dict>
310                                 <key>room</key>
311                                 <dict>
312                                         <key>Description</key>
313                                         <string>The chat room.</string>
314                                         <key>Name</key>
315                                         <string>in</string>
316                                 </dict>
317                         </dict>
318                         <key>Description</key>
319                         <string>Called when a member joins a room we are also members of.</string>
320                         <key>Name</key>
321                         <string>member joined</string>
322                 </dict>
323                 <key>memberPartedRoom</key>
324                 <dict>
325                         <key>UnnamedArgument</key>
326                         <dict>
327                                 <key>Description</key>
328                                 <string>The member.</string>
329                         </dict>
330                         <key>Arguments</key>
331                         <dict>
332                                 <key>room</key>
333                                 <dict>
334                                         <key>Description</key>
335                                         <string>The chat room.</string>
336                                         <key>Name</key>
337                                         <string>from</string>
338                                 </dict>
339                                 <key>reason</key>
340                                 <dict>
341                                         <key>Description</key>
342                                         <string>The reason the member left.</string>
343                                         <key>Name</key>
344                                         <string>for</string>
345                                 </dict>
346                         </dict>
347                         <key>Description</key>
348                         <string>Called when a member leaves a room we are also members of.</string>
349                         <key>Name</key>
350                         <string>member parted</string>
351                 </dict>
352                 <key>memberKickedFromRoom</key>
353                 <dict>
354                         <key>UnnamedArgument</key>
355                         <dict>
356                                 <key>Description</key>
357                                 <string>The member.</string>
358                         </dict>
359                         <key>Arguments</key>
360                         <dict>
361                                 <key>room</key>
362                                 <dict>
363                                         <key>Description</key>
364                                         <string>The chat room.</string>
365                                         <key>Name</key>
366                                         <string>from</string>
367                                 </dict>
368                                 <key>by</key>
369                                 <dict>
370                                         <key>Description</key>
371                                         <string>The member who kicked the other member out.</string>
372                                         <key>Name</key>
373                                         <string>by</string>
374                                 </dict>
375                                 <key>reason</key>
376                                 <dict>
377                                         <key>Description</key>
378                                         <string>The reason the member was kicked.</string>
379                                         <key>Name</key>
380                                         <string>for</string>
381                                 </dict>
382                         </dict>
383                         <key>Description</key>
384                         <string>Called when a member is kicked out of a room we are also members of.</string>
385                         <key>Name</key>
386                         <string>member kicked</string>
387                 </dict>
388                 <key>memberStatusChanged</key>
389                 <dict>
390                         <key>UnnamedArgument</key>
391                         <dict>
392                                 <key>Description</key>
393                                 <string>The member.</string>
394                         </dict>
395                         <key>Arguments</key>
396                         <dict>
397                                 <key>status</key>
398                                 <dict>
399                                         <key>Description</key>
400                                         <string>The new distinction this member has.</string>
401                                         <key>Name</key>
402                                         <string>to</string>
403                                 </dict>
404                                 <key>by</key>
405                                 <dict>
406                                         <key>Description</key>
407                                         <string>The member who gave this distinction.</string>
408                                         <key>Name</key>
409                                         <string>thanks to</string>
410                                 </dict>
411                                 <key>room</key>
412                                 <dict>
413                                         <key>Description</key>
414                                         <string>The chat room.</string>
415                                         <key>Name</key>
416                                         <string>in</string>
417                                 </dict>
418                         </dict>
419                         <key>Description</key>
420                         <string>Called when a member is granted voice or jurisdiction of the room; or when those powers are revoked.</string>
421                         <key>Name</key>
422                         <string>member distinction changed</string>
423                 </dict>
424                 <key>topicChanged</key>
425                 <dict>
426                         <key>Arguments</key>
427                         <dict>
428                                 <key>topic</key>
429                                 <dict>
430                                         <key>Description</key>
431                                         <string>The new room topic.</string>
432                                         <key>Name</key>
433                                         <string>to</string>
434                                 </dict>
435                                 <key>by</key>
436                                 <dict>
437                                         <key>Description</key>
438                                         <string>The member who changed the topic.</string>
439                                         <key>Name</key>
440                                         <string>by</string>
441                                 </dict>
442                                 <key>room</key>
443                                 <dict>
444                                         <key>Description</key>
445                                         <string>The chat room.</string>
446                                         <key>Name</key>
447                                         <string>in</string>
448                                 </dict>
449                         </dict>
450                         <key>Description</key>
451                         <string>Called when a member changes the room topic.</string>
452                         <key>Name</key>
453                         <string>topic changed</string>
454                 </dict>
455                 <key>userNicknameChanged</key>
456                 <dict>
457                         <key>UnnamedArgument</key>
458                         <dict>
459                                 <key>Description</key>
460                                 <string>The user's old nickname.</string>
461                         </dict>
462                         <key>Arguments</key>
463                         <dict>
464                                 <key>now</key>
465                                 <dict>
466                                         <key>Description</key>
467                                         <string>The new nickname for the user.</string>
468                                         <key>Name</key>
469                                         <string>is now known as</string>
470                                 </dict>
471                                 <key>view</key>
472                                 <dict>
473                                         <key>Description</key>
474                                         <string>The chat room or direct chat the change happened.</string>
475                                         <key>Name</key>
476                                         <string>in</string>
477                                 </dict>
478                         </dict>
479                         <key>Description</key>
480                         <string>Called when a user changes their nickname. This is called for all chat views you are in with the user (from one to many times). You can't get notifications for users you don't see in a chat room or direct chat.</string>
481                         <key>Name</key>
482                         <string>user named</string>
483                 </dict>
484         </dict>
485         <key>Enumerations</key>
486         <dict>
487                 <key>MemberStatus</key>
488                 <dict>
489                         <key>Normal</key>
490                         <dict>
491                                 <key>Name</key>
492                                 <string>normal</string>
493                         </dict>
494                         <key>Voice</key>
495                         <dict>
496                                 <key>Name</key>
497                                 <string>voice</string>
498                         </dict>
499                         <key>Operator</key>
500                         <dict>
501                                 <key>Name</key>
502                                 <string>operator</string>
503                         </dict>
504                 </dict>
505         </dict>
506         <key>Description</key>
507         <string>commands to be implemented by plug-ins.</string>
508         <key>Name</key>
509         <string>Chat Plug-In Suite</string>
510 </dict>
511 </plist>
Note: See TracBrowser for help on using the browser.