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