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

Revision 2509, 14.4 kB (checked in by machina, 4 years ago)

Fixed the bug where a user would click on a URL like irc://us.undernet.org/#colloquy and the user would be connected but not the room.
- Also went ahead and removed all the conenct typos in the project

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>BuildContextualMenuForItem</key>
8                 <dict>
9                         <key>Arguments</key>
10                         <dict>
11                                 <key>view</key>
12                                 <dict>
13                                         <key>Description</key>
14                                         <string>The chat room or direct chat this context menu is assocated with, if any.</string>
15                                         <key>Name</key>
16                                         <string>in</string>
17                                 </dict>
18                         </dict>
19                         <key>Description</key>
20                         <string>Called for every object that the user can access a contextual/action menu. This handler is called when the selection changes in a table or right before the menu is shown, allowing you to provide a list of titles to show.</string>
21                         <key>Name</key>
22                         <string>build contextual menu for item</string>
23                         <key>UnnamedArgument</key>
24                         <dict>
25                                 <key>Description</key>
26                                 <string>Object that the user has requested a contextual menu for. Can be a member, chat room, direct chat, transcript, chat connection, etc.</string>
27                         </dict>
28                 </dict>
29                 <key>Connected</key>
30                 <dict>
31                         <key>Description</key>
32                         <string>Called when we have just finished connecting to a chat server.</string>
33                         <key>Name</key>
34                         <string>connected</string>
35                         <key>UnnamedArgument</key>
36                         <dict>
37                                 <key>Description</key>
38                                 <string>The chat connection.</string>
39                         </dict>
40                 </dict>
41                 <key>Disconnecting</key>
42                 <dict>
43                         <key>Description</key>
44                         <string>Called when we are in the process of disconnecting from a chat server. Commands and messages can still be sent to the server.</string>
45                         <key>Name</key>
46                         <string>disconnecting</string>
47                         <key>UnnamedArgument</key>
48                         <dict>
49                                 <key>Description</key>
50                                 <string>The chat connection.</string>
51                         </dict>
52                 </dict>
53                 <key>HandleClickedContextualMenuItem</key>
54                 <dict>
55                         <key>Arguments</key>
56                         <dict>
57                                 <key>object</key>
58                                 <dict>
59                                         <key>Description</key>
60                                         <string>Item the menu item was built for, can be a member, chat room, direct chat, transcript, chat connection, etc.</string>
61                                         <key>Name</key>
62                                         <string>for</string>
63                                 </dict>
64                                 <key>submenu</key>
65                                 <dict>
66                                         <key>Description</key>
67                                         <string>A list of parent menu item titles the clicked menu item was when displayed. You only need to reference this when you use multiple items with the same name in different sub-menus.</string>
68                                         <key>Name</key>
69                                         <string>within</string>
70                                 </dict>
71                         </dict>
72                         <key>Description</key>
73                         <string>Called when the user clicks on one of the supplied menu item titles you returned from the "build contextual menu for item"</string>
74                         <key>Name</key>
75                         <string>handle clicked contextual menu item</string>
76                         <key>UnnamedArgument</key>
77                         <dict>
78                                 <key>Description</key>
79                                 <string>Menu item title you returned from the "build contextual menu for item"</string>
80                         </dict>
81                 </dict>
82                 <key>HandleClickedLink</key>
83                 <dict>
84                         <key>Arguments</key>
85                         <dict>
86                                 <key>view</key>
87                                 <dict>
88                                         <key>Description</key>
89                                         <string>The chat room, direct chat or chat transcript this link was clicked in.</string>
90                                         <key>Name</key>
91                                         <string>in</string>
92                                 </dict>
93                         </dict>
94                         <key>Description</key>
95                         <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>
96                         <key>Name</key>
97                         <string>handle clicked link</string>
98                         <key>UnnamedArgument</key>
99                         <dict>
100                                 <key>Description</key>
101                                 <string>The URL of the clicked link.</string>
102                         </dict>
103                 </dict>
104                 <key>Idle</key>
105                 <dict>
106                         <key>Description</key>
107                         <string>Automatically starts firing as soon as the script initializes, it will continue to fire periodically until the user quits the application. The default interval is 5 seconds, return a new interval to change the wait period for the next call.</string>
108                         <key>Name</key>
109                         <string>idle</string>
110                 </dict>
111                 <key>JoinedChatRoom</key>
112                 <dict>
113                         <key>Description</key>
114                         <string>Called when we join a room.</string>
115                         <key>Name</key>
116                         <string>joined chat room</string>
117                         <key>UnnamedArgument</key>
118                         <dict>
119                                 <key>Description</key>
120                                 <string>The chat room.</string>
121                         </dict>
122                 </dict>
123                 <key>KickedFromRoom</key>
124                 <dict>
125                         <key>Arguments</key>
126                         <dict>
127                                 <key>by</key>
128                                 <dict>
129                                         <key>Description</key>
130                                         <string>The member who kicked us out.</string>
131                                         <key>Name</key>
132                                         <string>by</string>
133                                 </dict>
134                                 <key>reason</key>
135                                 <dict>
136                                         <key>Description</key>
137                                         <string>The reason given for kicking us out.</string>
138                                         <key>Name</key>
139                                         <string>for</string>
140                                 </dict>
141                         </dict>
142                         <key>Description</key>
143                         <string>Called when we are kicked out of a room by another member.</string>
144                         <key>Name</key>
145                         <string>kicked from room</string>
146                         <key>UnnamedArgument</key>
147                         <dict>
148                                 <key>Description</key>
149                                 <string>The chat room.</string>
150                         </dict>
151                 </dict>
152                 <key>Load</key>
153                 <dict>
154                         <key>Arguments</key>
155                         <dict>
156                                 <key>path</key>
157                                 <dict>
158                                         <key>Description</key>
159                                         <string>The path the script was loaded from.</string>
160                                         <key>Name</key>
161                                         <string>from</string>
162                                 </dict>
163                         </dict>
164                         <key>Description</key>
165                         <string>Called when the script is loaded into the host application.</string>
166                         <key>Name</key>
167                         <string>load</string>
168                 </dict>
169                 <key>MemberJoined</key>
170                 <dict>
171                         <key>Arguments</key>
172                         <dict>
173                                 <key>room</key>
174                                 <dict>
175                                         <key>Description</key>
176                                         <string>The chat room.</string>
177                                         <key>Name</key>
178                                         <string>in</string>
179                                 </dict>
180                         </dict>
181                         <key>Description</key>
182                         <string>Called when a member joins a room we are also a member of.</string>
183                         <key>Name</key>
184                         <string>member joined</string>
185                         <key>UnnamedArgument</key>
186                         <dict>
187                                 <key>Description</key>
188                                 <string>The member.</string>
189                         </dict>
190                 </dict>
191                 <key>MemberKicked</key>
192                 <dict>
193                         <key>Arguments</key>
194                         <dict>
195                                 <key>by</key>
196                                 <dict>
197                                         <key>Description</key>
198                                         <string>The member who kicked the other member out.</string>
199                                         <key>Name</key>
200                                         <string>by</string>
201                                 </dict>
202                                 <key>reason</key>
203                                 <dict>
204                                         <key>Description</key>
205                                         <string>The reason the member was kicked.</string>
206                                         <key>Name</key>
207                                         <string>for</string>
208                                 </dict>
209                                 <key>room</key>
210                                 <dict>
211                                         <key>Description</key>
212                                         <string>The chat room.</string>
213                                         <key>Name</key>
214                                         <string>from</string>
215                                 </dict>
216                         </dict>
217                         <key>Description</key>
218                         <string>Called when a member is kicked out of a room we are also a member of.</string>
219                         <key>Name</key>
220                         <string>member kicked</string>
221                         <key>UnnamedArgument</key>
222                         <dict>
223                                 <key>Description</key>
224                                 <string>The member.</string>
225                         </dict>
226                 </dict>
227                 <key>MemberParted</key>
228                 <dict>
229                         <key>Arguments</key>
230                         <dict>
231                                 <key>reason</key>
232                                 <dict>
233                                         <key>Description</key>
234                                         <string>The reason the member left.</string>
235                                         <key>Name</key>
236                                         <string>for</string>
237                                 </dict>
238                                 <key>room</key>
239                                 <dict>
240                                         <key>Description</key>
241                                         <string>The chat room.</string>
242                                         <key>Name</key>
243                                         <string>from</string>
244                                 </dict>
245                         </dict>
246                         <key>Description</key>
247                         <string>Called when a member leaves a room we are also a member of.</string>
248                         <key>Name</key>
249                         <string>member parted</string>
250                         <key>UnnamedArgument</key>
251                         <dict>
252                                 <key>Description</key>
253                                 <string>The member.</string>
254                         </dict>
255                 </dict>
256                 <key>PartingChatRoom</key>
257                 <dict>
258                         <key>Description</key>
259                         <string>Called when we are in the process of laveing a room. Messages can still be sent.</string>
260                         <key>Name</key>
261                         <string>parting chat room</string>
262                         <key>UnnamedArgument</key>
263                         <dict>
264                                 <key>Description</key>
265                                 <string>The chat room.</string>
266                         </dict>
267                 </dict>
268                 <key>PerformNotification</key>
269                 <dict>
270                         <key>Arguments</key>
271                         <dict>
272                                 <key>context</key>
273                                 <dict>
274                                         <key>Description</key>
275                                         <string>Notification specific context information. Usually contains a human-readable message to display.</string>
276                                         <key>Name</key>
277                                         <string>with</string>
278                                 </dict>
279                                 <key>preferences</key>
280                                 <dict>
281                                         <key>Description</key>
282                                         <string>Preferences for the notification. From the Notification preferences panel.</string>
283                                         <key>Name</key>
284                                         <string>and</string>
285                                 </dict>
286                         </dict>
287                         <key>Description</key>
288                         <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>
289                         <key>Name</key>
290                         <string>perform notification</string>
291                         <key>UnnamedArgument</key>
292                         <dict>
293                                 <key>Description</key>
294                                 <string>Identifier of the notification to perform.</string>
295                         </dict>
296                 </dict>
297                 <key>ProcessIncomingChatMessage</key>
298                 <dict>
299                         <key>Arguments</key>
300                         <dict>
301                                 <key>action</key>
302                                 <dict>
303                                         <key>Description</key>
304                                         <string>Is this message an action?</string>
305                                         <key>Name</key>
306                                         <string>as</string>
307                                 </dict>
308                                 <key>user</key>
309                                 <dict>
310                                         <key>Description</key>
311                                         <string>The user this message came from.</string>
312                                         <key>Name</key>
313                                         <string>from</string>
314                                 </dict>
315                                 <key>view</key>
316                                 <dict>
317                                         <key>Description</key>
318                                         <string>The chat room or direct chat this message is in.</string>
319                                         <key>Name</key>
320                                         <string>in</string>
321                                 </dict>
322                         </dict>
323                         <key>Description</key>
324                         <string>Called when an incoming message is sent to us or a room we are in. (Any messages echoed to the screen that are sent from the local user will also be passed through this handler.)</string>
325                         <key>Name</key>
326                         <string>process incoming chat message</string>
327                         <key>UnnamedArgument</key>
328                         <dict>
329                                 <key>Description</key>
330                                 <string>The incoming message. Message and properties are modifiable.</string>
331                         </dict>
332                 </dict>
333                 <key>ProcessOutgoingChatMessage</key>
334                 <dict>
335                         <key>Arguments</key>
336                         <dict>
337                                 <key>action</key>
338                                 <dict>
339                                         <key>Description</key>
340                                         <string>Is this message an action?</string>
341                                         <key>Name</key>
342                                         <string>as</string>
343                                 </dict>
344                                 <key>view</key>
345                                 <dict>
346                                         <key>Description</key>
347                                         <string>The chat room or direct chat this message is in.</string>
348                                         <key>Name</key>
349                                         <string>in</string>
350                                 </dict>
351                         </dict>
352                         <key>Description</key>
353                         <string>Called when a message is sent from us to a user or room we are in.</string>
354                         <key>Name</key>
355                         <string>process outgoing chat message</string>
356                         <key>UnnamedArgument</key>
357                         <dict>
358                                 <key>Description</key>
359                                 <string>The outgoing message. Message and properties are modifiable.</string>
360                         </dict>
361                 </dict>
362                 <key>ProcessSubcodeReply</key>
363                 <dict>
364                         <key>Arguments</key>
365                         <dict>
366                                 <key>arguments</key>
367                                 <dict>
368                                         <key>Description</key>
369                                         <string>Any arguments given with the reply.</string>
370                                         <key>Name</key>
371                                         <string>with</string>
372                                 </dict>
373                                 <key>connection</key>
374                                 <dict>
375                                         <key>Description</key>
376                                         <string>The connection this reply came on.</string>
377                                         <key>Name</key>
378                                         <string>on</string>
379                                 </dict>
380                                 <key>user</key>
381                                 <dict>
382                                         <key>Description</key>
383                                         <string>The user this reply came from.</string>
384                                         <key>Name</key>
385                                         <string>from</string>
386                                 </dict>
387                         </dict>
388                         <key>Description</key>
389                         <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>
390                         <key>Name</key>
391                         <string>process subcode reply</string>
392                         <key>UnnamedArgument</key>
393                         <dict>
394                                 <key>Description</key>
395                                 <string>CTCP request to process.</string>
396                         </dict>
397                 </dict>
398                 <key>ProcessSubcodeRequest</key>
399                 <dict>
400                         <key>Arguments</key>
401                         <dict>
402                                 <key>arguments</key>
403                                 <dict>
404                                         <key>Description</key>
405                                         <string>Any arguments given with the request.</string>
406                                         <key>Name</key>
407                                         <string>with</string>
408                                 </dict>
409                                 <key>connection</key>
410                                 <dict>
411                                         <key>Description</key>
412                                         <string>The connection this request came on.</string>
413                                         <key>Name</key>
414                                         <string>on</string>
415                                 </dict>
416                                 <key>user</key>
417                                 <dict>
418                                         <key>Description</key>
419                                         <string>The user this request came from.</string>
420                                         <key>Name</key>
421                                         <string>from</string>
422                                 </dict>
423                         </dict>
424                         <key>Description</key>
425                         <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>
426                         <key>Name</key>
427                         <string>process subcode request</string>
428                         <key>UnnamedArgument</key>
429                         <dict>
430                                 <key>Description</key>
431                                 <string>CTCP request to process.</string>
432                         </dict>
433                 </dict>
434                 <key>ProcessUserCommand</key>
435                 <dict>
436                         <key>Arguments</key>
437                         <dict>
438                                 <key>arguments</key>
439                                 <dict>
440                                         <key>Description</key>
441                                         <string>Any arguments given with the command.</string>
442                                         <key>Name</key>
443                                         <string>with</string>
444                                 </dict>
445                                 <key>view</key>
446                                 <dict>
447                                         <key>Description</key>
448                                         <string>The view the command was entered in.</string>
449                                         <key>Name</key>
450                                         <string>for</string>
451                                 </dict>
452                         </dict>
453                         <key>Description</key>
454                         <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"</string>
455                         <key>Name</key>
456                         <string>process user command</string>
457                         <key>UnnamedArgument</key>
458                         <dict>
459                                 <key>Description</key>
460                                 <string>Command to process.</string>
461                         </dict>
462                 </dict>
463                 <key>TopicChanged</key>
464                 <dict>
465                         <key>Arguments</key>
466                         <dict>
467                                 <key>by</key>
468                                 <dict>
469                                         <key>Description</key>
470                                         <string>The member who changed the topic.</string>
471                                         <key>Name</key>
472                                         <string>by</string>
473                                 </dict>
474                                 <key>room</key>
475                                 <dict>
476                                         <key>Description</key>
477                                         <string>The chat room.</string>
478                                         <key>Name</key>
479                                         <string>in</string>
480                                 </dict>
481                                 <key>topic</key>
482                                 <dict>
483                                         <key>Description</key>
484                                         <string>The new room topic.</string>
485                                         <key>Name</key>
486                                         <string>to</string>
487                                 </dict>
488                         </dict>
489                         <key>Description</key>
490                         <string>Called when a member changes the room topic.</string>
491                         <key>Name</key>
492                         <string>topic changed</string>
493                 </dict>
494                 <key>Unload</key>
495                 <dict>
496                         <key>Description</key>
497                         <string>Called right before the script is unloaded from the host application. The script might be loaded again if a reload is being performed.</string>
498                         <key>Name</key>
499                         <string>unload</string>
500                 </dict>
501         </dict>
502         <key>Description</key>
503         <string>Commands to be implemented by plug-ins.</string>
504         <key>Name</key>
505         <string>Chat Plug-In Suite</string>
506 </dict>
507 </plist>
Note: See TracBrowser for help on using the browser.