diff options
Diffstat (limited to 'spec/Protocol_Interface_Addressing.xml')
-rw-r--r-- | spec/Protocol_Interface_Addressing.xml | 57 |
1 files changed, 48 insertions, 9 deletions
diff --git a/spec/Protocol_Interface_Addressing.xml b/spec/Protocol_Interface_Addressing.xml index 3722c3b8..ad406c8d 100644 --- a/spec/Protocol_Interface_Addressing.xml +++ b/spec/Protocol_Interface_Addressing.xml @@ -24,6 +24,7 @@ name="org.freedesktop.Telepathy.Protocol.Interface.Addressing.DRAFT" tp:causes-havoc="experimental"> <tp:added version="0.19.12">(as draft)</tp:added> + <tp:changed version="0.25.UNRELEASED">(renamed NormalizeURI)</tp:changed> <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>An interface for protocols that support multiple forms of addressing contacts, for example through vCard addresses and URIs.</p> @@ -217,7 +218,8 @@ AddressableURISchemes=tel;sip; <arg direction="in" name="VCard_Address" type="s"> <tp:docstring> - The address to normalize. + The address to normalize, which is assumed to belong to a + contact (and not, for instance, a chatroom or server). </tp:docstring> </arg> @@ -243,8 +245,9 @@ AddressableURISchemes=tel;sip; </tp:possible-errors> </method> - <method name="NormalizeURI" - tp:name-for-bindings="Normalize_URI"> + <method name="NormalizeContactURI" + tp:name-for-bindings="Normalize_Contact_URI"> + <tp:added version="0.25.UNRELEASED">(renamed from NormalizeURI)</tp:added> <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Attempt to normalize the given contact URI. Where possible, this SHOULD return an address that would appear in the @@ -258,8 +261,28 @@ AddressableURISchemes=tel;sip; namespace="org.freedesktop.Telepathy">Connection</tp:dbus-ref>, this method SHOULD perform a best-effort normalization.</p> - <p>Example: <code>xmpp:eitan@EXAMPLE.COM</code> would be normalized to - <code>xmpp:eitan@example.com</code>.</p> + <p>If the URI has extra information beyond what's necessary to + identify a particular contact, such as an XMPP resource or an + action to carry out, this extra information SHOULD be removed. + If all URIs in a scheme contain a verb or action + (like <code>aim</code>, <code>ymsgr</code> and + <code>msnim</code> URIs), then the verb SHOULD be replaced + with the one specified in + <tp:member-ref>AddressableURISchemes</tp:member-ref>.</p> + + <tp:rationale> + <p>This method is intended to normalize URIs stored in address + books, for instance. In protocols like XMPP, if you + vary the resource or action (query string), the URI still + refers to the same high-level contact.</p> + </tp:rationale> + + <p>For instance, + <code>xmpp:romeo@Example.Com/Empathy?message;body=Hello</code> + would be normalized to <code>xmpp:romeo@example.com</code>, + and <code>aim:goim?screenname=Romeo%20M&message=Hello</code> + would be normalized to + <code>aim:addbuddy?screenname=romeom</code>.</p> <p>This method MAY simply raise NotImplemented on some protocols, if it has no use.</p> @@ -267,9 +290,18 @@ AddressableURISchemes=tel;sip; <arg direction="in" name="URI" type="s"> <tp:docstring> - The URI to normalize. The URI's scheme (i.e. the part before - the first colon) MUST appear in - <tp:member-ref>AddressableURISchemes</tp:member-ref>. + <p>The URI to normalize, which is assumed to refer to a contact + (as opposed to, for instance, a chatroom or a server).</p> + + <tp:rationale> + <p>In some protocols, like XMPP, there is no way to tell whether + a given URI refers to a contact or a chatroom by looking at + its syntax.</p> + </tp:rationale> + + <p>The URI's scheme (i.e. the part before + the first colon) MUST appear in + <tp:member-ref>AddressableURISchemes</tp:member-ref>.</p> </tp:docstring> </arg> @@ -289,7 +321,14 @@ AddressableURISchemes=tel;sip; <tp:error name="org.freedesktop.Telepathy.Error.InvalidArgument"> <tp:docstring> - The URI is syntactically incorrect. + <p>The URI is syntactically incorrect or cannot be interpreted + as a reference to a contact.</p> + + <tp:rationale> + <p>For instance, <code>aim:!?</code> is not a valid AIM URI, + while <code>aim:goaway?message=Absent</code> is a + valid AIM URI, but not a contact.</p> + </tp:rationale> </tp:docstring> </tp:error> </tp:possible-errors> |