diff options
author | Will Thompson <will.thompson@collabora.co.uk> | 2011-04-20 18:25:18 +0100 |
---|---|---|
committer | Will Thompson <will.thompson@collabora.co.uk> | 2011-04-20 19:10:39 +0100 |
commit | 9dc915cb9f1b0acb7666e9a563f8f0bd9d5c6ac6 (patch) | |
tree | 1cacee0cf3444ef1ace0702ad2adeea13166b9b4 /spec | |
parent | 98646464068863f114a5c3d28e02743a10a5b40d (diff) | |
download | telepathy-glib-9dc915cb9f1b0acb7666e9a563f8f0bd9d5c6ac6.tar.gz |
Fully update spec to 0.22.2
Diffstat (limited to 'spec')
-rw-r--r-- | spec/Channel_Interface_SMS.xml | 30 | ||||
-rw-r--r-- | spec/Connection_Interface_Balance.xml | 20 | ||||
-rw-r--r-- | spec/Connection_Interface_Simple_Presence.xml | 66 | ||||
-rw-r--r-- | spec/Protocol_Interface_Avatars.xml | 16 | ||||
-rw-r--r-- | spec/all.xml | 2 | ||||
-rw-r--r-- | spec/errors.xml | 6 |
6 files changed, 105 insertions, 35 deletions
diff --git a/spec/Channel_Interface_SMS.xml b/spec/Channel_Interface_SMS.xml index 4cfe3f2f8..235046c36 100644 --- a/spec/Channel_Interface_SMS.xml +++ b/spec/Channel_Interface_SMS.xml @@ -59,6 +59,36 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. namespace='ofdT.Client.Handler'>BypassApproval</tp:dbus-ref> property to <code>True</code>, so that it is invoked immediately for new channels.</p> + + <h4>Contact Capabilities</h4> + + <p>Contacts to whom SMSes can be sent SHOULD indicate this via a + requestable channel class with + <tp:member-ref>SMSChannel</tp:member-ref> = True as a fixed + property.</p> + + <p>For instance, a contact that can accept both text and SMS channels:</p> + + <blockquote><code> +[<br/> + ({ ...<tp:dbus-ref namespace='ofdT.Channel'>ChannelType</tp:dbus-ref>: + ...<tp:dbus-ref namespace='ofdT.Channel.Type'>Text</tp:dbus-ref>,<br/> + ...<tp:dbus-ref namespace='ofdT.Channel'>TargetHandleType</tp:dbus-ref>: + <tp:type>Handle_Type</tp:type>_Contact,<br/> + },<br/> + [ ...<tp:dbus-ref namespace='ofdT.Channel'>TargetHandle</tp:dbus-ref>, + ...<tp:dbus-ref namespace='ofdT.Channel'>TargetID</tp:dbus-ref> ]),<br/> +<br/> + ({ ...<tp:dbus-ref namespace='ofdT.Channel'>ChannelType</tp:dbus-ref>: + ...<tp:dbus-ref namespace='ofdT.Channel.Type'>Text</tp:dbus-ref>,<br/> + ...<tp:dbus-ref namespace='ofdT.Channel'>TargetHandleType</tp:dbus-ref>: + <tp:type>Handle_Type</tp:type>_Contact,<br/> + ...<tp:member-ref>SMSChannel</tp:member-ref>: True,<br/> + },<br/> + [ ...<tp:dbus-ref namespace='ofdT.Channel'>TargetHandle</tp:dbus-ref>, + ...<tp:dbus-ref namespace='ofdT.Channel'>TargetID</tp:dbus-ref> ]),<br/> +] + </code></blockquote> </tp:docstring> <property name="Flash" tp:name-for-bindings="Flash" diff --git a/spec/Connection_Interface_Balance.xml b/spec/Connection_Interface_Balance.xml index 76f9040e9..974c651fd 100644 --- a/spec/Connection_Interface_Balance.xml +++ b/spec/Connection_Interface_Balance.xml @@ -93,6 +93,26 @@ </tp:docstring> </property> + <property name="ManageCreditURI" + tp:name-for-bindings="Manage_Credit_URI" + access="read" type="s"> + <tp:added version="0.22.2"/> + <tp:docstring> + A URI the user may visit via the web browser to manage and top-up their + account balance. This property is not guaranteed to be well-defined + until the connection becomes Connected; there is no change + notification. + + <tp:rationale> + Different protocols and even servers or gateways (e.g. SIP and XMPP + PSTN gateways) will have a different website used to manage a user's + account balance. This property enables the client to provide that + to the user. A Connection Manager MAY set this itself (because it is + static or discoverable), or expose it as a connection parameter. + </tp:rationale> + </tp:docstring> + </property> + <signal name="BalanceChanged" tp:name-for-bindings="Balance_Changed"> <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Emitted when the user's balance has changed.</p> diff --git a/spec/Connection_Interface_Simple_Presence.xml b/spec/Connection_Interface_Simple_Presence.xml index c399c4843..0860f5fea 100644 --- a/spec/Connection_Interface_Simple_Presence.xml +++ b/spec/Connection_Interface_Simple_Presence.xml @@ -279,7 +279,7 @@ <property name="MaximumStatusMessageLength" tp:name-for-bindings="Maximum_Status_Message_Length" access="read" type="u"> - <tp:added version="0.22.UNRELEASED"/> + <tp:added version="0.22.2"/> <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>The maximum length in characters for any individual status message, or 0 if there is no limit.</p> @@ -590,57 +590,75 @@ <table> <tr> - <th>status identifier</th> - <th>Connection_Presence_Type</th> - <th>comments</th> + <th>Status identifier</th> + <th><tp:type>Connection_Presence_Type</tp:type></th> + <th>Remarks</th> </tr> <tr> - <td>available</td> - <td>Connection_Presence_Type_Available</td> + <td><code>"available"</code></td> + <td>Available</td> <td></td> </tr> <tr> - <td>away</td> - <td>Connection_Presence_Type_Away</td> + <td><code>"chat"</code></td> + <td>Available</td> + <td>Actively interested in chatting, as opposed to merely + available.</td> + </tr> + <tr> + <td><code>"pstn"</code></td> + <td>Available</td> + <td>This contact is actually a phone number, not an IM account. As + such, the contact is conceptually always available, but not in the + same way that a contact can set their IM status to “available”. + It does not make sense to allow the user to set this status on + herself; hence, on protocols where this status is supported, its + entry in <tp:member-ref>Statuses</tp:member-ref> SHOULD have + <var>May_Set_On_Self</var> set to <code>False</code>.</td> + </tr> + <tr> + <td><code>"away"</code></td> + <td>Away</td> <td></td> </tr> <tr> - <td>brb</td> - <td>Connection_Presence_Type_Away</td> + <td><code>"brb"</code></td> + <td>Away</td> <td>Be Right Back (a more specific form of Away)</td> </tr> <tr> - <td>busy</td> - <td>Connection_Presence_Type_Busy</td> + <td><code>"busy"</code></td> + <td>Busy</td> <td></td> </tr> - <tr><td>dnd</td> - <td>Connection_Presence_Type_Busy</td> + <tr> + <td><code>"dnd"</code></td> + <td>Busy</td> <td>Do Not Disturb (a more specific form of Busy)</td> </tr> <tr> - <td>xa</td> - <td>Connection_Presence_Type_Extended_Away</td> + <td><code>"xa"</code></td> + <td>Extended_Away</td> <td>Extended Away</td> </tr> <tr> - <td>hidden</td> - <td>Connection_Presence_Type_Hidden</td> + <td><code>"hidden"</code></td> + <td>Hidden</td> <td>Also known as "Invisible" or "Appear Offline"</td> </tr> <tr> - <td>offline</td> - <td>Connection_Presence_Type_Offline</td> + <td><code>"offline"</code></td> + <td>Offline</td> <td></td> </tr> <tr> - <td>unknown</td> - <td>Connection_Presence_Type_Unknown</td> + <td><code>"unknown"</code></td> + <td>Unknown</td> <td>special, see below</td> </tr> <tr> - <td>error</td> - <td>Connection_Presence_Type_Error</td> + <td><code>"error"</code></td> + <td>Error</td> <td>special, see below</td> </tr> </table> diff --git a/spec/Protocol_Interface_Avatars.xml b/spec/Protocol_Interface_Avatars.xml index cd913510d..1bf0515ef 100644 --- a/spec/Protocol_Interface_Avatars.xml +++ b/spec/Protocol_Interface_Avatars.xml @@ -68,7 +68,7 @@ MaximumAvatarBytes=8192 <property name="SupportedAvatarMIMETypes" tp:name-for-bindings="Supported_Avatar_MIME_Types" - type="as" access="read"> + type="as" access="read" tp:immutable="yes"> <tp:docstring> The expected value of the <tp:dbus-ref namespace="org.freedesktop.Telepathy" @@ -79,7 +79,7 @@ MaximumAvatarBytes=8192 <property name="MinimumAvatarHeight" tp:name-for-bindings="Minimum_Avatar_Height" - type="u" access="read"> + type="u" access="read" tp:immutable="yes"> <tp:docstring> The expected value of the <tp:dbus-ref namespace="org.freedesktop.Telepathy" @@ -90,7 +90,7 @@ MaximumAvatarBytes=8192 <property name="MinimumAvatarWidth" tp:name-for-bindings="Minimum_Avatar_Width" - type="u" access="read"> + type="u" access="read" tp:immutable="yes"> <tp:docstring> The expected value of the <tp:dbus-ref namespace="org.freedesktop.Telepathy" @@ -101,7 +101,7 @@ MaximumAvatarBytes=8192 <property name="RecommendedAvatarHeight" tp:name-for-bindings="Recommended_Avatar_Height" - type="u" access="read"> + type="u" access="read" tp:immutable="yes"> <tp:docstring> The expected value of the <tp:dbus-ref namespace="org.freedesktop.Telepathy" @@ -112,7 +112,7 @@ MaximumAvatarBytes=8192 <property name="RecommendedAvatarWidth" tp:name-for-bindings="Recommended_Avatar_Width" - type="u" access="read"> + type="u" access="read" tp:immutable="yes"> <tp:docstring> The expected value of the <tp:dbus-ref namespace="org.freedesktop.Telepathy" @@ -123,7 +123,7 @@ MaximumAvatarBytes=8192 <property name="MaximumAvatarHeight" tp:name-for-bindings="Maximum_Avatar_Height" - type="u" access="read"> + type="u" access="read" tp:immutable="yes"> <tp:docstring> The expected value of the <tp:dbus-ref namespace="org.freedesktop.Telepathy" @@ -134,7 +134,7 @@ MaximumAvatarBytes=8192 <property name="MaximumAvatarWidth" tp:name-for-bindings="Maximum_Avatar_Width" - type="u" access="read"> + type="u" access="read" tp:immutable="yes"> <tp:docstring> The expected value of the <tp:dbus-ref namespace="org.freedesktop.Telepathy" @@ -145,7 +145,7 @@ MaximumAvatarBytes=8192 <property name="MaximumAvatarBytes" tp:name-for-bindings="Maximum_Avatar_Bytes" - type="u" access="read"> + type="u" access="read" tp:immutable="yes"> <tp:docstring> The expected value of the <tp:dbus-ref namespace="org.freedesktop.Telepathy" diff --git a/spec/all.xml b/spec/all.xml index bf15a903e..d1493eb53 100644 --- a/spec/all.xml +++ b/spec/all.xml @@ -3,7 +3,7 @@ xmlns:xi="http://www.w3.org/2001/XInclude"> <tp:title>Telepathy D-Bus Interface Specification</tp:title> -<tp:version>0.22.1</tp:version> +<tp:version>0.22.2</tp:version> <tp:copyright>Copyright © 2005-2011 Collabora Limited</tp:copyright> <tp:copyright>Copyright © 2005-2011 Nokia Corporation</tp:copyright> diff --git a/spec/errors.xml b/spec/errors.xml index 6753301f8..a5271b5b6 100644 --- a/spec/errors.xml +++ b/spec/errors.xml @@ -586,13 +586,15 @@ <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Raised if the user has insufficient <tp:dbus-ref namespace="ofdT.Connection.Interface">Balance</tp:dbus-ref> - to place a call.</p> + to place a call or send a message.</p> <p>The key 'balance-required' MAY be included in <tp:dbus-ref namespace="ofdT.Channel.Type.Call.DRAFT">CallStateDetails</tp:dbus-ref> + or a delivery report's <tp:type>Message_Part</tp:type> (with the same units and scale as <tp:dbus-ref namespace="ofdT.Connection.Interface.Balance">AccountBalance</tp:dbus-ref>) - to indicate how much credit is required to make this call.</p> + to indicate how much credit is required to make this call or send + this message.</p> </tp:docstring> </tp:error> |