Now, groups can retrieve a list of the contacts in that group. I probably should...
[adiumx.git] / Resources / Adium.sdef
blob1b86d4e87ddc4443d419193da5bde91f21bd8b36
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE dictionary SYSTEM "file://localhost/System/Library/DTDs/sdef.dtd">
3 <dictionary title="Adium Terminology">
4 <suite name="Adium Suite" code="Adum" description="AppleScript support for Adium">
5 <value-type name="TIFF picture" code="TIFF">
6 <cocoa class="NSData"/>
7 </value-type>
8 <class name="application" code="capp" description="Adium's application class">
9 <cocoa class="AIApplication" />
10 <property name="name" code="pnam" type="text" access="r" description="The name of the application."/>
11 <property name="frontmost" code="pisf" type="boolean" access="r" description="Is this the frontmost (active) application?">
12 <cocoa key="isActive"/>
13 </property>
14 <property name="version" code="vers" type="text" access="r" description="The version of the application."/>
15 <property name="active chat" code="Pcht" type="chat" access="r" description="The frontmost chat."/>
17 <property name="global status" code="Pgst" type="status" access="rw" description="The global status. This is the status that the most online accounts are currently using; it will only be an offline status if no accounts are online. Setting it changes the status for all accounts.">
18 <cocoa key="globalStatus"/>
19 </property>
21 <element type="account" />
22 <element type="contact" />
23 <element type="contact group" />
24 <element type="service" />
25 <element type="window">
26 <cocoa key="orderedWindows" />
27 </element>
28 <element type="chat window" />
29 <element type="chat" />
30 <element type="status" />
32 <responds-to name="go online">
33 <cocoa method="scriptingGoOnline:"/>
34 </responds-to>
35 <responds-to name="go available">
36 <cocoa method="scriptingGoAvailable:"/>
37 </responds-to>
38 <responds-to name="go offline">
39 <cocoa method="scriptingGoOffline:"/>
40 </responds-to>
41 <responds-to name="go away">
42 <cocoa method="scriptingGoAway:"/>
43 </responds-to>
44 <responds-to name="go invisible">
45 <cocoa method="scriptingGoInvisible:"/>
46 </responds-to>
47 </class>
48 <class name="service" code="Csrv" description="An Adium service (a.k.a. chat protocol)">
49 <cocoa class="AIService" />
50 <property name="name" code="pnam" type="text" access="r" description="The name of the service.">
51 <cocoa key="serviceID" />
52 </property>
53 <property name="image" code="Pimg" type="TIFF picture" access="r" description="The image associated with this service." />
54 <element type="account" />
55 </class>
56 <class name="window" code="cwin" description="A window in Adium">
57 <cocoa class="NSWindow" />
58 <property name="name" code="pnam" type="text" access="r" description="The title of this window">
59 <cocoa key="scriptingTitle" />
60 </property>
61 <property name="id" code="ID " type="integer" access="r" description="The unique identifier of the window.">
62 <cocoa key="uniqueID"/>
63 </property>
64 <property name="index" code="pidx" type="integer" description="The index of the window, ordered front to back.">
65 <cocoa key="orderedIndex"/>
66 </property>
67 <property name="bounds" code="pbnd" type="rectangle" description="The bounding rectangle of the window.">
68 <cocoa key="boundsAsQDRect"/>
69 </property>
70 <property name="closeable" code="hclb" type="boolean" access="r" description="Whether the window has a close box.">
71 <cocoa key="hasCloseBox"/>
72 </property>
73 <property name="minimizable" code="ismn" type="boolean" access="r" description="Whether the window can be minimized.">
74 <cocoa key="isMiniaturizable"/>
75 </property>
76 <property name="minimized" code="pmnd" type="boolean" description="Whether the window is currently minimized.">
77 <cocoa key="isMiniaturized"/>
78 </property>
79 <property name="resizable" code="prsz" type="boolean" access="r" description="Whether the window can be resized.">
80 <cocoa key="isResizable"/>
81 </property>
82 <property name="visible" code="pvis" type="boolean" description="Whether the window is currently visible.">
83 <cocoa key="isVisible"/>
84 </property>
85 <property name="zoomable" code="iszm" type="boolean" access="r" description="Whether the window can be zoomed.">
86 <cocoa key="isZoomable"/>
87 </property>
88 <property name="zoomed" code="pzum" type="boolean" description="Whether the window is currently zoomed.">
89 <cocoa key="isZoomed"/>
90 </property>
91 </class>
92 <class name="chat window" code="Ctwn" description="A window that contains chats" inherits="window">
93 <cocoa class="AIMessageWindow" />
94 <element type="chat" />
95 <responds-to name="close">
96 <cocoa method="handleCloseScriptCommand:"/>
97 </responds-to>
98 </class>
99 <class name="chat" code="Chat" description="A chat in Adium">
100 <cocoa class="AIChat" />
101 <property name="name" code="pnam" type="text" access="r" description="The name of the chat" />
102 <property name="ID" code="ID " type="text" access="r" description="The unique identifier of the chat.">
103 <cocoa key="uniqueChatID"/>
104 </property>
105 <property name="account" code="Cact" type="account" access="r" description="The account associated with this chat">
106 <cocoa key="scriptingAccount" />
107 </property>
108 <property name="date opened" code="CDop" type="date" access="r" description="The date and time at which this chat was opened">
109 <cocoa key="dateOpened" />
110 </property>
112 <property name="index" code="pidx" type="integer" access="r" description="The index of this tab in the chat window" />
113 <property name="window" code="cwin" type="window" access="r" description="The window this chat is in" />
114 <element type="contact">
115 <cocoa key="containedObjects" />
116 </element>
118 <responds-to name="close">
119 <cocoa method="handleCloseScriptCommand:"/>
120 </responds-to>
121 <responds-to name="send">
122 <cocoa method="sendScriptCommand:"/>
123 </responds-to>
124 </class>
125 <enumeration name="status types" code="Esta">
126 <enumerator name="offline" code="Soff" description="Account is offline."/>
127 <enumerator name="available" code="Sonl" description="Account is online."/>
128 <enumerator name="away" code="Sawy" description="Account is away."/>
129 <enumerator name="invisible" code="Sinv" description="Account is invisible."/>
130 </enumeration>
131 <class name="account" code="Cact" description="An account in Adium">
132 <cocoa class="AIAccount" />
133 <property name="id" code="ID " type="integer" access="r" description="The unique ID associated with this account">
134 <cocoa key="scriptingInternalObjectID" />
135 </property>
136 <property name="name" code="pnam" type="text" access="r" description="The name of this account">
137 <cocoa key="scriptingUID" />
138 </property>
139 <property name="display name" code="Pdnm" type="text" access="rw" description="The display name of this account"/>
140 <property name="service" code="Csrv" type="service" access="r" description="The service this account is registered under" />
141 <property name="enabled" code="Penb" type="boolean" access="r" description="Whether or not this account is enabled" />
142 <property name="host" code="Phst" type="text" access="r" description="The host this account is connected to" />
143 <property name="port" code="Pprt" type="integer" access="r" description="The port this account is connected to" />
144 <property name="status" code="Csts" type="status" access="rw" description="The current status on the account.">
145 <cocoa key="statusState" />
146 </property>
147 <property name="status type" code="Psts" type="status types" access="rw" description="The type of the current status. Setting this creates a temporary status.">
148 <cocoa key="scriptingStatusType" />
149 </property>
150 <property name="status message" code="Pasm" type="rich text" access="rw" description="The message associated with the current status. Setting this creates a temporary status.">
151 <cocoa key="scriptingStatusMessage" />
152 </property>
153 <property name="image" code="Pimg" type="TIFF picture" access="rw" description="The image associated with this account.">
154 <cocoa key="userIconData" />
155 </property>
156 <element type="contact" />
158 <responds-to name="go online">
159 <cocoa method="scriptingGoOnline:"/>
160 </responds-to>
161 <responds-to name="go available">
162 <cocoa method="scriptingGoAvailable:"/>
163 </responds-to>
164 <responds-to name="go offline">
165 <cocoa method="scriptingGoOffline:"/>
166 </responds-to>
167 <responds-to name="go away">
168 <cocoa method="scriptingGoAway:"/>
169 </responds-to>
170 <responds-to name="go invisible">
171 <cocoa method="scriptingGoInvisible:"/>
172 </responds-to>
173 </class>
174 <class name="contact group" code="Cgrp" description="A contact group">
175 <cocoa class="AIListGroup" />
176 <property name="name" code="pnam" type="text" access="rw" description="The name of this contact group.">
177 <cocoa key="UID" />
178 </property>
179 <property name="visible" code="pvis" type="boolean" access="r" description="The visibility of this group.">
180 <cocoa key="visible" />
181 </property>
182 <element type="contact" />
183 </class>
184 <class name="contact" code="Ccnt" description="A contact">
185 <cocoa class="AIListContact" />
186 <property name="account" code="Pacc" type="account" access="r" description="The account associated with this contact" />
187 <property name="group" code="Pgrp" type="contact group" access="r" description="The group associated with this contact">
188 <cocoa key="parentGroup" />
189 </property>
190 <property name="name" code="pnam" type="text" access="r" description="The name of this contact">
191 <cocoa key="UID" />
192 </property>
193 <property name="display name" code="Pdnm" type="text" access="rw" description="The display name or alias associated with this contact." />
194 <property name="notes" code="Pnts" type="text" access="rw" description="The user-defined notes for this contact."/>
195 <property name="idle time" code="Pidl" type="integer" access="r" description="The time this contact has been idle." />
196 <property name="status type" code="Psts" type="status types" access="r" description="The current status of this contact">
197 <cocoa key="scriptingStatusType" />
198 </property>
199 <property name="status message" code="Pstm" type="rich text" access="r" description="The custom status message for this contact.">
200 <cocoa key="scriptingStatusMessage" />
201 </property>
202 <property name="image" code="Pimg" type="TIFF picture" access="rw" description="The image associated with this contact.">
203 <cocoa key="userIconData" />
204 </property>
205 </class>
206 <class name="status" plural="statuses" code="Csts" description="A saved status in Adium">
207 <cocoa class="AIStatus" />
208 <property name="title" code="Pttl" type="text" access="r" description="The title of the status.">
209 <cocoa key="scriptingTitle" />
210 </property>
211 <property name="status type" code="Psts" type="status types" access="r" description="The type of this status.">
212 <cocoa key="statusTypeApplescript"/>
213 </property>
214 <property name="message" code="Pstm" type="rich text" access="r" description="The custom status message.">
215 <cocoa key="scriptingMessage"/>
216 </property>
217 <property name="autoreply" code="Paut" type="rich text" access="r" description="The message to auto reply">
218 <cocoa key="scriptingAutoreply"/>
219 </property>
220 <property name="id" code="ID " type="integer" access="r" description="The unique ID of the status">
221 <cocoa key="uniqueStatusID"/>
222 </property>
223 </class>
224 <command name="close" code="coreclos" description="Close a document.">
225 <cocoa class="NSCloseCommand"/>
226 <direct-parameter type="specifier" description="the document(s) or window(s) to close."/>
227 </command>
229 <command name="go online" code="Adumgoon" description="Changes the status of an account.">
230 <cocoa class="NSScriptCommand" />
231 <direct-parameter description="The account that should connect" type="account" />
232 <parameter name="with message" code="Pmsg" description="The custom status message." type="rich text" optional="yes">
233 <cocoa key="WithMessage"/>
234 </parameter>
235 </command>
236 <command name="go available" code="Adumgoav" description="Changes the status of an account.">
237 <cocoa class="NSScriptCommand" />
238 <direct-parameter description="The account that should become available" type="account" />
239 <parameter name="with message" code="Pmsg" description="The custom status message." type="rich text" optional="yes">
240 <cocoa key="WithMessage"/>
241 </parameter>
242 </command>
243 <command name="go offline" code="Adumgoof" description="Changes the status of an account.">
244 <cocoa class="NSScriptCommand" />
245 <direct-parameter description="The account that should disconnect" type="account" />
246 <parameter name="with message" code="Pmsg" description="The custom status message." type="rich text" optional="yes">
247 <cocoa key="WithMessage"/>
248 </parameter>
249 </command>
250 <command name="go away" code="Adumgoaw" description="Changes the status of an account.">
251 <cocoa class="NSScriptCommand" />
252 <direct-parameter description="The account that should go away" type="account" />
253 <parameter name="with message" code="Pmsg" description="The custom status message." type="rich text" optional="yes">
254 <cocoa key="WithMessage"/>
255 </parameter>
256 </command>
257 <command name="go invisible" code="Adumgoin" description="Changes the status of an account.">
258 <cocoa class="NSScriptCommand" />
259 <direct-parameter description="The account that should become invisible" type="account" />
260 <parameter name="with message" code="Pmsg" description="The custom status message." type="rich text" optional="yes">
261 <cocoa key="WithMessage"/>
262 </parameter>
263 </command>
264 <command name="count" code="corecnte" description="Return the number elements of a particular class within an object.">
265 <cocoa class="NSCountCommand"/>
266 <direct-parameter description="the object whose elements are to be counted" type="specifier"/>
267 <parameter name="each" code="kocl" description="The class of objects to be counted." type="type" optional="yes">
268 <cocoa key="ObjectClass"/>
269 </parameter>
270 <result description="the number of elements" type="integer"/>
271 </command>
272 <command name="delete" code="coredelo" description="Delete an object.">
273 <cocoa class="NSDeleteCommand"/>
274 <direct-parameter description="the object to delete" type="specifier"/>
275 </command>
276 <command name="exists" code="coredoex" description="Verify if an object exists.">
277 <cocoa class="NSExistsCommand"/>
278 <direct-parameter description="the object in question" type="specifier"/>
279 <result description="true if it exists, false if not" type="boolean"/>
280 </command>
281 <command name="make" code="corecrel" description="Make a new object.">
282 <cocoa class="AICreateCommand"/>
283 <parameter name="new" code="kocl" description="The class of the new object." type="type">
284 <cocoa key="ObjectClass"/>
285 </parameter>
286 <parameter name="at" code="insh" description="The location at which to insert the object." type="location specifier" optional="yes">
287 <cocoa key="Location"/>
288 </parameter>
289 <parameter name="with data" code="data" description="The initial data for the object." type="any" optional="yes">
290 <cocoa key="ObjectData"/>
291 </parameter>
292 <parameter name="with properties" code="prdt" description="The initial values for properties of the object." type="record" optional="yes">
293 <cocoa key="KeyDictionary"/>
294 </parameter>
295 <parameter name="with contacts" code="Pwct" description="The contacts needed for creating a chat or group." type="list of contact" optional="yes">
296 <cocoa key="withContacts"/>
297 </parameter>
298 <parameter name="new chat window" code="Pncw" description="If this is true, then a new chat window will be created when creating a chat." type="boolean" optional="yes">
299 <cocoa key="newChatWindow"/>
300 </parameter>
301 <result description="to the new object" type="specifier"/>
302 </command>
304 <command name="move" code="coremove" description="Move object(s) to a new location.">
305 <cocoa class="AIMoveCommand"/>
306 <direct-parameter type="specifier" description="the object(s) to move"/>
307 <parameter name="to" code="insh" type="location specifier" description="The new location for the object(s).">
308 <cocoa key="ToLocation"/>
309 </parameter>
310 <result type="specifier" description="the moved object(s)"/>
311 </command>
313 <command name="send" code="Adumsend" description="Send text or a file to some contact.">
314 <cocoa class="NSScriptCommand"/>
315 <direct-parameter type="chat" description="The chat that mimics the entry... yada yada"/>
316 <parameter name="message" code="Smsg" description="The message to send" type="text" optional="yes">
317 <cocoa key="message"/>
318 </parameter>
319 <parameter name="with file" code="Sfil" description="A file to attach" type="file" optional="yes">
320 <cocoa key="withFile"/>
321 </parameter>
322 </command>
323 </suite>
325 <suite name="Text Suite" code="TEXT" description="A set of basic classes for text processing.">
326 <cocoa name="NSTextSuite"/>
328 <value-type name="color" code="cRGB">
329 <cocoa class="NSColor"/>
330 </value-type>
332 <class name="rich text" plural="rich text" code="ricT" description="Rich (styled) text">
333 <cocoa class="NSTextStorage"/>
334 <!-- this "type" element and the ones that follow, while they
335 contradict the DTD, are NOT errors. Cocoa Scripting in 10.4 uses them to accomplish certain type conversions. -->
336 <type type="text"/>
337 <property name="color" code="colr" type="color" description="The color of the first character.">
338 <cocoa key="foregroundColor"/>
339 </property>
340 <property name="font" code="font" type="text" description="The name of the font of the first character.">
341 <cocoa key="fontName"/>
342 </property>
343 <property name="size" code="ptsz" type="integer" description="The size in points of the first character.">
344 <cocoa key="fontSize"/>
345 </property>
346 <element type="character"/>
347 <element type="paragraph"/>
348 <element type="word"/>
349 <element type="attribute run"/>
350 <element type="attachment"/>
351 </class>
353 <class name="character" code="cha " description="This subdivides the text into characters.">
354 <cocoa class="NSTextStorage"/>
355 <type type="text"/>
356 <property name="color" code="colr" type="color" description="The color of the first character.">
357 <cocoa key="foregroundColor"/>
358 </property>
359 <property name="font" code="font" type="text" description="The name of the font of the first character.">
360 <cocoa key="fontName"/>
361 </property>
362 <property name="size" code="ptsz" type="integer" description="The size in points of the first character.">
363 <cocoa key="fontSize"/>
364 </property>
365 <element type="character"/>
366 <element type="paragraph"/>
367 <element type="word"/>
368 <element type="attribute run"/>
369 <element type="attachment"/>
370 </class>
372 <class name="paragraph" code="cpar" description="This subdivides the text into paragraphs.">
373 <cocoa class="NSTextStorage"/>
374 <type type="text"/>
375 <property name="color" code="colr" type="color" description="The color of the first character.">
376 <cocoa key="foregroundColor"/>
377 </property>
378 <property name="font" code="font" type="text" description="The name of the font of the first character.">
379 <cocoa key="fontName"/>
380 </property>
381 <property name="size" code="ptsz" type="integer" description="The size in points of the first character.">
382 <cocoa key="fontSize"/>
383 </property>
384 <element type="character"/>
385 <element type="paragraph"/>
386 <element type="word"/>
387 <element type="attribute run"/>
388 <element type="attachment"/>
389 </class>
391 <class name="word" code="cwor" description="This subdivides the text into words.">
392 <cocoa class="NSTextStorage"/>
393 <type type="text"/>
394 <property name="color" code="colr" type="color" description="The color of the first character.">
395 <cocoa key="foregroundColor"/>
396 </property>
397 <property name="font" code="font" type="text" description="The name of the font of the first character.">
398 <cocoa key="fontName"/>
399 </property>
400 <property name="size" code="ptsz" type="integer" description="The size in points of the first character.">
401 <cocoa key="fontSize"/>
402 </property>
403 <element type="character"/>
404 <element type="paragraph"/>
405 <element type="word"/>
406 <element type="attribute run"/>
407 <element type="attachment"/>
408 </class>
410 <class name="attribute run" code="catr" description="This subdivides the text into chunks that all have the same attributes.">
411 <cocoa class="NSTextStorage"/>
412 <type type="text"/>
413 <property name="color" code="colr" type="color" description="The color of the first character.">
414 <cocoa key="foregroundColor"/>
415 </property>
416 <property name="font" code="font" type="text" description="The name of the font of the first character.">
417 <cocoa key="fontName"/>
418 </property>
419 <property name="size" code="ptsz" type="integer" description="The size in points of the first character.">
420 <cocoa key="fontSize"/>
421 </property>
422 <element type="character"/>
423 <element type="paragraph"/>
424 <element type="word"/>
425 <element type="attribute run"/>
426 <element type="attachment"/>
427 </class>
429 <class name="attachment" code="atts" inherits="rich text" description="Represents an inline text attachment. This class is used mainly for make commands.">
430 <cocoa class="NSAttachmentTextStorage"/>
431 <property name="file name" code="atfn" type="text" description="The path to the file for the attachment">
432 <cocoa key="filename"/>
433 </property>
434 </class>
436 </suite>
438 </dictionary>