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