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