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

Revision 2509, 21.0 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>Classes</key>
6         <dict>
7                 <key>MVChatConnection</key>
8                 <dict>
9                         <key>Attributes</key>
10                         <dict>
11                                 <key>localUser</key>
12                                 <dict>
13                                         <key>Description</key>
14                                         <string>Current local user when connected.</string>
15                                         <key>Name</key>
16                                         <string>local user</string>
17                                 </dict>
18                                 <key>nickname</key>
19                                 <dict>
20                                         <key>Description</key>
21                                         <string>Current nickname on the server.</string>
22                                         <key>Name</key>
23                                         <string>nickname</string>
24                                 </dict>
25                                 <key>nicknamePassword</key>
26                                 <dict>
27                                         <key>Description</key>
28                                         <string>The nickname'</string>
29                                         <key>Name</key>
30                                         <string>nickname password</string>
31                                 </dict>
32                                 <key>password</key>
33                                 <dict>
34                                         <key>Description</key>
35                                         <string>Password to connect to the server.</string>
36                                         <key>Name</key>
37                                         <string>password</string>
38                                 </dict>
39                                 <key>proxy</key>
40                                 <dict>
41                                         <key>Description</key>
42                                         <string>What system proxy server to use.</string>
43                                         <key>Name</key>
44                                         <string>proxy</string>
45                                 </dict>
46                                 <key>scriptTypedAwayMessage</key>
47                                 <dict>
48                                         <key>Description</key>
49                                         <string>Away message for other users to see that your not there.</string>
50                                         <key>Name</key>
51                                         <string>away message</string>
52                                 </dict>
53                                 <key>scriptTypedEncoding</key>
54                                 <dict>
55                                         <key>Description</key>
56                                         <string>The default connection encoding that is used when sending raw messages or chat messages without a specific encoding.</string>
57                                         <key>Name</key>
58                                         <string>encoding</string>
59                                 </dict>
60                                 <key>server</key>
61                                 <dict>
62                                         <key>Description</key>
63                                         <string>Server IP address or domain name.</string>
64                                         <key>Name</key>
65                                         <string>server address</string>
66                                 </dict>
67                                 <key>serverPort</key>
68                                 <dict>
69                                         <key>Description</key>
70                                         <string>Port to connect on.</string>
71                                         <key>Name</key>
72                                         <string>port number</string>
73                                 </dict>
74                                 <key>status</key>
75                                 <dict>
76                                         <key>Description</key>
77                                         <string>Current connection status.</string>
78                                         <key>Name</key>
79                                         <string>status</string>
80                                 </dict>
81                                 <key>uniqueIdentifier</key>
82                                 <dict>
83                                         <key>Description</key>
84                                         <string>The unique identifier of the connection.</string>
85                                         <key>Name</key>
86                                         <string>id</string>
87                                 </dict>
88                                 <key>urlString</key>
89                                 <dict>
90                                         <key>Description</key>
91                                         <string>Chat URL containing nickname, server and port.</string>
92                                         <key>Name</key>
93                                         <string>URL</string>
94                                 </dict>
95                         </dict>
96                         <key>Description</key>
97                         <string>Manages all chat communication with a chat server.</string>
98                         <key>Name</key>
99                         <string>connection</string>
100                         <key>PluralName</key>
101                         <string>connections</string>
102                 </dict>
103                 <key>MVChatRoom</key>
104                 <dict>
105                         <key>Attributes</key>
106                         <dict>
107                                 <key>attributes</key>
108                                 <dict>
109                                         <key>Description</key>
110                                         <string>Room attributes containing various itmes.</string>
111                                         <key>Name</key>
112                                         <string>attributes</string>
113                                 </dict>
114                                 <key>bannedUsersArray</key>
115                                 <dict>
116                                         <key>Description</key>
117                                         <string>Current chat room members.</string>
118                                         <key>Name</key>
119                                         <string>banned users</string>
120                                 </dict>
121                                 <key>dateJoined</key>
122                                 <dict>
123                                         <key>Description</key>
124                                         <string>Date we joined the room. Missing value if we haven'</string>
125                                         <key>Name</key>
126                                         <string>date joined</string>
127                                 </dict>
128                                 <key>dateParted</key>
129                                 <dict>
130                                         <key>Description</key>
131                                         <string>Date we parted the room. Missing value if we haven'</string>
132                                         <key>Name</key>
133                                         <string>date parted</string>
134                                 </dict>
135                                 <key>displayName</key>
136                                 <dict>
137                                         <key>Description</key>
138                                         <string>Full room name without any prefixes.</string>
139                                         <key>Name</key>
140                                         <string>display name</string>
141                                 </dict>
142                                 <key>isJoined</key>
143                                 <dict>
144                                         <key>Description</key>
145                                         <string>Are we currently in the room?</string>
146                                         <key>Name</key>
147                                         <string>joined</string>
148                                 </dict>
149                                 <key>name</key>
150                                 <dict>
151                                         <key>Description</key>
152                                         <string>Full room name.</string>
153                                         <key>Name</key>
154                                         <string>name</string>
155                                 </dict>
156                                 <key>scriptTypedEncoding</key>
157                                 <dict>
158                                         <key>Description</key>
159                                         <string>Default encoding for outgoing messages.</string>
160                                         <key>Name</key>
161                                         <string>encoding</string>
162                                 </dict>
163                                 <key>scriptUniqueIdentifier</key>
164                                 <dict>
165                                         <key>Description</key>
166                                         <string>The unique identifier of the room.</string>
167                                         <key>Name</key>
168                                         <string>id</string>
169                                 </dict>
170                                 <key>urlString</key>
171                                 <dict>
172                                         <key>Description</key>
173                                         <string>The full room URL containing the server and room name.</string>
174                                         <key>Name</key>
175                                         <string>URL</string>
176                                 </dict>
177                         </dict>
178                         <key>Description</key>
179                         <string>Represents a join chat room.</string>
180                         <key>Name</key>
181                         <string>chat room</string>
182                         <key>PluralName</key>
183                         <string>chat rooms</string>
184                 </dict>
185                 <key>MVChatUser</key>
186                 <dict>
187                         <key>Attributes</key>
188                         <dict>
189                                 <key>address</key>
190                                 <dict>
191                                         <key>Description</key>
192                                         <string>The address the user connected to the server from. Somtimes this is a fake (masked) address.</string>
193                                         <key>Name</key>
194                                         <string>address</string>
195                                 </dict>
196                                 <key>attributes</key>
197                                 <dict>
198                                         <key>Description</key>
199                                         <string>User attributes containing various itmes.</string>
200                                         <key>Name</key>
201                                         <string>attributes</string>
202                                 </dict>
203                                 <key>dateConnected</key>
204                                 <dict>
205                                         <key>Description</key>
206                                         <string>The date the user connected to the server.</string>
207                                         <key>Name</key>
208                                         <string>date connected</string>
209                                 </dict>
210                                 <key>dateDisconnected</key>
211                                 <dict>
212                                         <key>Description</key>
213                                         <string>The date the user disconnected from the server. This will not be available for all users.</string>
214                                         <key>Name</key>
215                                         <string>date disconnected</string>
216                                 </dict>
217                                 <key>dateUpdated</key>
218                                 <dict>
219                                         <key>Description</key>
220                                         <string>The last time the refresh information command finished.</string>
221                                         <key>Name</key>
222                                         <string>date updated</string>
223                                 </dict>
224                                 <key>displayName</key>
225                                 <dict>
226                                         <key>Description</key>
227                                         <string>Display name, almost always the nickname.</string>
228                                         <key>Name</key>
229                                         <string>display name</string>
230                                 </dict>
231                                 <key>idleTime</key>
232                                 <dict>
233                                         <key>Description</key>
234                                         <string>The number of seconds the user has been idle on the server.</string>
235                                         <key>Name</key>
236                                         <string>idle time</string>
237                                 </dict>
238                                 <key>nickname</key>
239                                 <dict>
240                                         <key>Description</key>
241                                         <string>The current nickname.</string>
242                                         <key>Name</key>
243                                         <string>name</string>
244                                 </dict>
245                                 <key>realName</key>
246                                 <dict>
247                                         <key>Description</key>
248                                         <string>The real name supplied by the user, not always a person'</string>
249                                         <key>Name</key>
250                                         <string>real name</string>
251                                 </dict>
252                                 <key>scriptTypedAwayMessage</key>
253                                 <dict>
254                                         <key>Description</key>
255                                         <string>The user'</string>
256                                         <key>Name</key>
257                                         <string>away message</string>
258                                 </dict>
259                                 <key>scriptUniqueIdentifier</key>
260                                 <dict>
261                                         <key>Description</key>
262                                         <string>The unique identifier of the user on the server.</string>
263                                         <key>Name</key>
264                                         <string>id</string>
265                                 </dict>
266                                 <key>serverAddress</key>
267                                 <dict>
268                                         <key>Description</key>
269                                         <string>The server address the user is connected to. This might be a different address than you are connected to, since servers are sometimes clustered.</string>
270                                         <key>Name</key>
271                                         <string>server address</string>
272                                 </dict>
273                                 <key>status</key>
274                                 <dict>
275                                         <key>Description</key>
276                                         <string>The current status of the user.</string>
277                                         <key>Name</key>
278                                         <string>user status</string>
279                                 </dict>
280                                 <key>username</key>
281                                 <dict>
282                                         <key>Description</key>
283                                         <string>The user name supplied by the user.</string>
284                                         <key>Name</key>
285                                         <string>user name</string>
286                                 </dict>
287                         </dict>
288                         <key>Description</key>
289                         <string>Represents a user on a chat server. Many properties of this class require the refresh information command to be called first on the instance.</string>
290                         <key>Name</key>
291                         <string>chat user</string>
292                         <key>PluralName</key>
293                         <string>chat users</string>
294                 </dict>
295                 <key>MVFileTransfer</key>
296                 <dict>
297                         <key>Attributes</key>
298                         <dict>
299                                 <key>finalSize</key>
300                                 <dict>
301                                         <key>Description</key>
302                                         <string>The final expected size (in bytes) of the file.</string>
303                                         <key>Name</key>
304                                         <string>final size</string>
305                                 </dict>
306                                 <key>hostString</key>
307                                 <dict>
308                                         <key>Description</key>
309                                         <string>The address of the other user engaged in the transfer.</string>
310                                         <key>Name</key>
311                                         <string>host address</string>
312                                 </dict>
313                                 <key>isPassive</key>
314                                 <dict>
315                                         <key>Description</key>
316                                         <string>Is the transfer using passive mode?</string>
317                                         <key>Name</key>
318                                         <string>passive</string>
319                                 </dict>
320                                 <key>port</key>
321                                 <dict>
322                                         <key>Description</key>
323                                         <string>The port this the transfer is using.</string>
324                                         <key>Name</key>
325                                         <string>port</string>
326                                 </dict>
327                                 <key>scriptFilePath</key>
328                                 <dict>
329                                         <key>Description</key>
330                                         <string>The file this transfer is associated with.</string>
331                                         <key>Name</key>
332                                         <string>file</string>
333                                 </dict>
334                                 <key>scriptType</key>
335                                 <dict>
336                                         <key>Description</key>
337                                         <string>The type of this transfer.</string>
338                                         <key>Name</key>
339                                         <string>type</string>
340                                 </dict>
341                                 <key>startDate</key>
342                                 <dict>
343                                         <key>Description</key>
344                                         <string>The date and time this file transfer started.</string>
345                                         <key>Name</key>
346                                         <string>start date</string>
347                                 </dict>
348                                 <key>startOffset</key>
349                                 <dict>
350                                         <key>Description</key>
351                                         <string>The location (offset) in the file where transfer was resumed.</string>
352                                         <key>Name</key>
353                                         <string>start offset</string>
354                                 </dict>
355                                 <key>status</key>
356                                 <dict>
357                                         <key>Description</key>
358                                         <string>The current status of the transfer.</string>
359                                         <key>Name</key>
360                                         <string>status</string>
361                                 </dict>
362                                 <key>transfered</key>
363                                 <dict>
364                                         <key>Description</key>
365                                         <string>The current size (in bytes) this file has transfered.</string>
366                                         <key>Name</key>
367                                         <string>transfered size</string>
368                                 </dict>
369                                 <key>uniqueIdentifier</key>
370                                 <dict>
371                                         <key>Description</key>
372                                         <string>The unique identifier of the file transfer.</string>
373                                         <key>Name</key>
374                                         <string>id</string>
375                                 </dict>
376                                 <key>user</key>
377                                 <dict>
378                                         <key>Description</key>
379                                         <string>The chat user this transfer is with.</string>
380                                         <key>Name</key>
381                                         <string>chat user</string>
382                                 </dict>
383                         </dict>
384                         <key>Description</key>
385                         <string>Represents a file transfer with another chat user.</string>
386                         <key>Name</key>
387                         <string>file transfer</string>
388                         <key>PluralName</key>
389                         <string>file transfers</string>
390                 </dict>
391         </dict>
392         <key>Commands</key>
393         <dict>
394                 <key>Connect</key>
395                 <dict>
396                         <key>Description</key>
397                         <string>Connect to the server.</string>
398                         <key>Name</key>
399                         <string>connect</string>
400                         <key>UnnamedArgument</key>
401                         <dict>
402                                 <key>Description</key>
403                                 <string>The connection to connect.</string>
404                         </dict>
405                 </dict>
406                 <key>Disconnect</key>
407                 <dict>
408                         <key>Description</key>
409                         <string>Disconnect from the server.</string>
410                         <key>Name</key>
411                         <string>disconnect</string>
412                         <key>UnnamedArgument</key>
413                         <dict>
414                                 <key>Description</key>
415                                 <string>The connection to disconnect.</string>
416                         </dict>
417                 </dict>
418                 <key>JoinChatRoom</key>
419                 <dict>
420                         <key>Arguments</key>
421                         <dict>
422                                 <key>connection</key>
423                                 <dict>
424                                         <key>Description</key>
425                                         <string>The connection to join on. Optional if the nearest enclosing tell block accepts this command.</string>
426                                         <key>Name</key>
427                                         <string>on</string>
428                                 </dict>
429                         </dict>
430                         <key>Description</key>
431                         <string>Join a chat room.</string>
432                         <key>Name</key>
433                         <string>join chat room</string>
434                         <key>UnnamedArgument</key>
435                         <dict>
436                                 <key>Description</key>
437                                 <string>Room to join. (Can also be a list of rooms.)</string>
438                         </dict>
439                 </dict>
440                 <key>RefreshInformation</key>
441                 <dict>
442                         <key>Description</key>
443                         <string>Refresh various properties of a chat user.</string>
444                         <key>Name</key>
445                         <string>refresh information</string>
446                         <key>UnnamedArgument</key>
447                         <dict>
448                                 <key>Description</key>
449                                 <string>The chat user.</string>
450                         </dict>
451                 </dict>
452                 <key>ReloadPlugins</key>
453                 <dict>
454                         <key>Description</key>
455                         <string>Reloads all plugins that are in the search paths. Plugins that have been deleted or moved will be unloaded.</string>
456                         <key>Name</key>
457                         <string>reload plugins</string>
458                 </dict>
459                 <key>SendMessage</key>
460                 <dict>
461                         <key>Arguments</key>
462                         <dict>
463                                 <key>action</key>
464                                 <dict>
465                                         <key>Description</key>
466                                         <string>Send as an action?</string>
467                                         <key>Name</key>
468                                         <string>action tense</string>
469                                 </dict>
470                                 <key>echo</key>
471                                 <dict>
472                                         <key>Description</key>
473                                         <string>Show the message locally on screen? (Defaults on.)</string>
474                                         <key>Name</key>
475                                         <string>local echo</string>
476                                 </dict>
477                                 <key>encoding</key>
478                                 <dict>
479                                         <key>Description</key>
480                                         <string>The encoding to send the message as (will default to the room or connection encoding if omitted).</string>
481                                         <key>Name</key>
482                                         <string>encoded as</string>
483                                 </dict>
484                                 <key>target</key>
485                                 <dict>
486                                         <key>Description</key>
487                                         <string>The chat user or chat room to send to. Optional if the nearest enclosing tell block accepts this command.</string>
488                                         <key>Name</key>
489                                         <string>to</string>
490                                 </dict>
491                         </dict>
492                         <key>Description</key>
493                         <string>Send a message to a room or user.</string>
494                         <key>Name</key>
495                         <string>send message</string>
496                         <key>UnnamedArgument</key>
497                         <dict>
498                                 <key>Description</key>
499                                 <string>The message to send. (Plain text with HTML formatting. Must entity encode HTML special characters.)</string>
500                         </dict>
501                 </dict>
502                 <key>SendRawCommand</key>
503                 <dict>
504                         <key>Arguments</key>
505                         <dict>
506                                 <key>connection</key>
507                                 <dict>
508                                         <key>Description</key>
509                                         <string>The connection to send to. Optional if the nearest enclosing tell block accepts this command.</string>
510                                         <key>Name</key>
511                                         <string>to</string>
512                                 </dict>
513                                 <key>priority</key>
514                                 <dict>
515                                         <key>Description</key>
516                                         <string>Send this command now? (This will bypass any queued commands.)</string>
517                                         <key>Name</key>
518                                         <string>priority</string>
519                                 </dict>
520                         </dict>
521                         <key>Description</key>
522                         <string>Send raw server command (message) to server.</string>
523                         <key>Name</key>
524                         <string>send raw command</string>
525                         <key>UnnamedArgument</key>
526                         <dict>
527                                 <key>Description</key>
528                                 <string>The raw server command (message) to send. (This is protocol specific.)</string>
529                         </dict>
530                 </dict>
531         </dict>
532         <key>Description</key>
533         <string>Classes and commands for Chat Core scripting. Chat Core is the lowest level of Colloquy and has user visible representation.</string>
534         <key>Enumerations</key>
535         <dict>
536                 <key>ConnectionStatus</key>
537                 <dict>
538                         <key>Connected</key>
539                         <dict>
540                                 <key>Description</key>
541                                 <string>Connected status.</string>
542                                 <key>Name</key>
543                                 <string>connected</string>
544                         </dict>
545                         <key>Connecting</key>
546                         <dict>
547                                 <key>Description</key>
548                                 <string>Connecting status.</string>
549                                 <key>Name</key>
550                                 <string>connecting</string>
551                         </dict>
552                         <key>Disconnected</key>
553                         <dict>
554                                 <key>Description</key>
555                                 <string>Disconnected status.</string>
556                                 <key>Name</key>
557                                 <string>disconnected</string>
558                         </dict>
559                         <key>Suspended</key>
560                         <dict>
561                                 <key>Description</key>
562                                 <string>Suspended status.</string>
563                                 <key>Name</key>
564                                 <string>suspended</string>
565                         </dict>
566                 </dict>
567                 <key>Encoding</key>
568                 <dict>
569                         <key>ASCII</key>
570                         <dict>
571                                 <key>Name</key>
572                                 <string>ASCII</string>
573                         </dict>
574                         <key>Big5</key>
575                         <dict>
576                                 <key>Name</key>
577                                 <string>Big 5</string>
578                         </dict>
579                         <key>Big5HKSCS</key>
580                         <dict>
581                                 <key>Name</key>
582                                 <string>Big 5 HKSCS</string>
583                         </dict>
584                         <key>GB18030</key>
585                         <dict>
586                                 <key>Name</key>
587                                 <string>GB 18030</string>
588                         </dict>
589                         <key>GBK</key>
590                         <dict>
591                                 <key>Name</key>
592                                 <string>GBK</string>
593                         </dict>
594                         <key>ISOLatin1</key>
595                         <dict>
596                                 <key>Name</key>
597                                 <string>ISO Latin 1</string>
598                         </dict>
599                         <key>ISOLatin2</key>
600                         <dict>
601                                 <key>Name</key>
602                                 <string>ISO Latin 2</string>
603                         </dict>
604                         <key>ISOLatin3</key>
605                         <dict>
606                                 <key>Name</key>
607                                 <string>ISO Latin 3</string>
608                         </dict>
609                         <key>ISOLatin4</key>
610                         <dict>
611                                 <key>Name</key>
612                                 <string>ISO Latin 4</string>
613                         </dict>
614                         <key>ISOLatin5</key>
615                         <dict>
616                                 <key>Name</key>