Codebase list telepathy-glib / c984fac
Update Conn.Interface.Addressing from tp-spec. Andre Moreira Magalhaes (andrunko) 12 years ago
1 changed file(s) with 40 addition(s) and 53 deletion(s). Raw diff Collapse all Expand all
+40
-53
spec/Connection_Interface_Addressing.xml less more
7575 </tp:docstring>
7676 </arg>
7777
78 <arg direction="out" type="a{ua{sv}}" name="Requested_Contacts"
78 <arg direction="out" type="a{su}" name="Requested"
79 tp:type="Addressing_Normalization_Map">
80 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
81 <p>A mapping from requested vCard addresses to the corresponding
82 contact handles.</p>
83
84 <p>Requested addresses that are not valid or understood for this protocol
85 MUST be omitted from the mapping.</p>
86 </tp:docstring>
87 </arg>
88
89 <arg direction="out" type="a{ua{sv}}" name="Attributes"
7990 tp:type="Contact_Attributes_Map">
8091 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
8192 <p>A dictionary mapping the contact handles to contact attributes.
8596 the attribute should either be omitted from the result or
8697 replaced with a default value.</p>
8798
88 <p>Requested addresses that cannot be satisfied MUST be ommitted
89 from the mapping.</p>
99 <p>Requested addresses that are not valid or understood for this protocol
100 MUST be omitted from the mapping.</p>
90101
91102 <p>Each contact's attributes will always include at least the
92103 identifier that would be obtained by inspecting the handle
93 (<code>org.freedesktop.Telepathy.Connection/contact-id</code>),
94 and the vCard field used for requesting the contact in
95 <code>org.freedesktop.Telepathy.Connection.Interface.ContactInfo/info</code>.
104 (<code>org.freedesktop.Telepathy.Connection/contact-id</code>).
96105 </p>
97106 </tp:docstring>
98107 </arg>
142151 </tp:docstring>
143152 </arg>
144153
145 <arg direction="out" type="a{ua{sv}}" name="Requested_Contacts"
154 <arg direction="out" type="a{su}" name="Requested"
155 tp:type="Addressing_Normalization_Map">
156 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
157 <p>A mapping of requested URIs to the corresponding contact handles.</p>
158
159 <p>Requested URIs that are not valid or understood for this protocol
160 MUST be omitted from the mapping.</p>
161 </tp:docstring>
162 </arg>
163
164 <arg direction="out" type="a{ua{sv}}" name="Attributes"
146165 tp:type="Contact_Attributes_Map">
147166 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
148167 <p>A dictionary mapping the contact handles to contact attributes.
152171 the attribute should either be omitted from the result or
153172 replaced with a default value.</p>
154173
155 <p>Requested URIs that cannot be satisfied MUST be ommitted
156 from the mapping.</p>
174 <p>Requested URIs that are not valid or understood for this protocol
175 MUST be omitted from the mapping.</p>
157176
158177 <p>Each contact's attributes will always include at least the
159178 identifier that would be obtained by inspecting the handle
200219 </tp:docstring>
201220 </tp:contact-attribute>
202221
203 <tp:contact-attribute name="requested-address" type="(ss)"
204 tp:type="Requested_Address">
205 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
206 <p>The contact's address, as it was requested
207 through <tp:member-ref>GetContactsByVCardField</tp:member-ref>. This
208 attribute MUST be ommitted if the contact was not retrieved
209 through <tp:member-ref>GetContactsByVCardField</tp:member-ref>.</p>
210 <tp:rationale>
211 <p>When retrieving more than one contact
212 through <tp:member-ref>GetContactsByVCardField</tp:member-ref>,
213 there needs to be a way to map the given contact back o the
214 original request.</p>
215 </tp:rationale>
216 </tp:docstring>
217 </tp:contact-attribute>
218
219 <tp:contact-attribute name="requested-uri" type="s">
220 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
221 <p>The contact's URI, as it was requested through
222 <tp:member-ref>GetContactsByURI</tp:member-ref>. This
223 attribute MUST be ommitted if the contact was not retrieved
224 through <tp:member-ref>GetContactsByURI</tp:member-ref>.</p>
225 <tp:rationale>
226 <p>When retrieving more than one contact
227 through <tp:member-ref>GetContactsByURI</tp:member-ref>,
228 there needs to be a way to map the given contact back o the
229 original request.</p>
230 </tp:rationale>
231 </tp:docstring>
232 </tp:contact-attribute>
233
234 <tp:struct name="Requested_Address" array-name="">
222 <tp:mapping name="Addressing_Normalization_Map">
235223 <tp:docstring>
236 The address that has been requested by
224 A map from URIs/vCard addresses to the corresponding handle.
225 </tp:docstring>
226 <tp:added version="0.25.UNRELEASED"/>
227
228 <tp:member type="s" name="Requested_String">
229 <tp:docstring>
230 The URI or vCard address that has been requested by
237231 <tp:member-ref>GetContactsByVCardField</tp:member-ref> or
238232 <tp:member-ref>GetContactsByURI</tp:member-ref>.
239 </tp:docstring>
240
241 <tp:member name="Field" type="s">
242 <tp:docstring>
243 The vCard field used in <tp:member-ref>GetContactsByVCardField</tp:member-ref>.
244233 </tp:docstring>
245234 </tp:member>
246
247 <tp:member name="Address" type="s">
248 <tp:docstring>
249 The address that was requested.
235 <tp:member type="u" name="Handle" tp:type="Contact_Handle">
236 <tp:docstring>
237 A nonzero handle.
250238 </tp:docstring>
251239 </tp:member>
252
253 </tp:struct>
240 </tp:mapping>
254241
255242 </interface>
256243 </node>