From 48f0d7288a82a1f0560819b42eaf8009eb37f1e9 Mon Sep 17 00:00:00 2001 From: Simon McVittie Date: Wed, 7 Jan 2009 13:55:04 +0000 Subject: Update to spec 0.17.17 --- qt4/spec/Account_Manager.xml | 29 +++++++++++---- qt4/spec/Channel.xml | 6 ++++ qt4/spec/Channel_Interface_Group.xml | 59 +++++++++++++++++++++++++++++-- qt4/spec/Channel_Interface_Messages.xml | 6 ++-- qt4/spec/Connection.xml | 59 +++++++++++++++++++++---------- qt4/spec/Connection_Interface_Avatars.xml | 4 +-- qt4/spec/Connection_Manager.xml | 4 +-- qt4/spec/Media_Stream_Handler.xml | 56 +++++++++++++++++------------ qt4/spec/all.xml | 2 +- 9 files changed, 169 insertions(+), 56 deletions(-) (limited to 'qt4/spec') diff --git a/qt4/spec/Account_Manager.xml b/qt4/spec/Account_Manager.xml index 39e08b5b1..98fe00d9c 100644 --- a/qt4/spec/Account_Manager.xml +++ b/qt4/spec/Account_Manager.xml @@ -1,8 +1,8 @@ - Copyright (C) 2008 Collabora Ltd. - Copyright (C) 2008 Nokia Corporation + Copyright (C) 2008-2009 Collabora Ltd. + Copyright (C) 2008-2009 Nokia Corporation

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public @@ -89,7 +89,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. This is effectively change notification for the valid and invalid - accounts lists. + accounts lists. On emission of this signal, the Account indicated + will no longer be present in either of the lists. @@ -148,9 +149,25 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. The initial value of the new account's DisplayName - property. The account manager MAY modify this to make it unique, - for instance by appending a number or the 'account' - parameter. + property. The account manager SHOULD modify this to make it unique if + an Account already exists with the same display name, for instance by + appending a number or the 'account' parameter. Account manager + implementations SHOULD accept an empty string but account editing user + interfaces should avoid passing an empty string for this parameter. + + +

The account creation UI may ask the user for a name for the new + account. If the author of the UI chooses not to do this, the + account creation UI is better able to suggest a default display + name because it has protocol-specific knowledge which the account + manager does not.

+ +

The account manager always knows the complete list of accounts so + it can easily tell whether it should append something to the + display name to avoid presenting two identically-named accounts to + the user.

+ + diff --git a/qt4/spec/Channel.xml b/qt4/spec/Channel.xml index 0026e04c4..5a40f2f5b 100644 --- a/qt4/spec/Channel.xml +++ b/qt4/spec/Channel.xml @@ -339,6 +339,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + +

It does not make sense for this property to be in channel + requests—it will always be true for channels returned by + CreateChannel, and callers of EnsureChannel cannot control whether an + existing channel was originally requested locally—so it MUST NOT + be accepted.

diff --git a/qt4/spec/Channel_Interface_Group.xml b/qt4/spec/Channel_Interface_Group.xml index 7aeb6cccd..ffa01154b 100644 --- a/qt4/spec/Channel_Interface_Group.xml +++ b/qt4/spec/Channel_Interface_Group.xml @@ -1,7 +1,7 @@ - Copyright (C) 2005, 2006 Collabora Limited - Copyright (C) 2005, 2006 Nokia Corporation + Copyright (C) 2005-2009 Collabora Limited + Copyright (C) 2005-2009 Nokia Corporation Copyright (C) 2006 INdT

This library is free software; you can redistribute it and/or @@ -226,7 +226,16 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.MembersChangedDetailed will be emitted for changes to this group's members in addition to MembersChanged. - Clients can then connect to the former and ignore emission of the latter. + Clients can then connect to the former and ignore emission of the + latter. This flag's state MUST NOT change over the lifetime of a + channel. + + + If it were allowed to change, client bindings would have to always + connect to MembersChanged just in case the flag ever went away (and + generally be unnecessarily complicated), which would mostly negate + the point of having this flag in the first place. + @@ -698,6 +707,26 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + + + A map from handles to the corresponding normalized string identifier. + + + + + + A nonzero handle + + + + + The same string that would be returned by InspectHandles + for this handle. + + + + @@ -733,6 +762,30 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.change-reason (u — Channel_Group_Change_Reason)

A reason for the change.
+
contact-ids (a{us} — Handle_Identifier_Map)
+
+

The string identifiers for handles mentioned in this signal, to + give clients the minimal information necessary to react to the + event without waiting for round-trips. Connection managers + SHOULD include the identifiers for members added to the group and + for the actor (if any); they MAY omit the identifiers for handles + which have been removed from the group.

+ + +

On IRC, an event such as a netsplit could cause the vast + majority of a channel to leave. Given that clients should + already know the identifiers of a channel's members, including + potentially hundreds of strings in the netsplit signal is + unnecessary.

+ + +

Clients MUST NOT assume that the presence or absence of a + handle in this mapping is meaningful. This mapping is merely + an optimization for round-trip reduction, and connection + managers MAY add additional handles, omit some handles, or + omit the mapping completely.

+
+
message (s)
A string message from the server regarding the change
diff --git a/qt4/spec/Channel_Interface_Messages.xml b/qt4/spec/Channel_Interface_Messages.xml index 0604b3a1f..107850429 100644 --- a/qt4/spec/Channel_Interface_Messages.xml +++ b/qt4/spec/Channel_Interface_Messages.xml @@ -1,8 +1,8 @@ - Copyright (C) 2008 Collabora Ltd. - Copyright (C) 2008 Nokia Corporation + Copyright (C) 2008-2009 Collabora Ltd. + Copyright (C) 2008-2009 Nokia Corporation

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public @@ -707,12 +707,14 @@ USA.

+ The index of a message part within a message. + A mapping from message part indexes to their content, as returned by GetPendingMessageContent. diff --git a/qt4/spec/Connection.xml b/qt4/spec/Connection.xml index f543a16ad..951619683 100644 --- a/qt4/spec/Connection.xml +++ b/qt4/spec/Connection.xml @@ -2,8 +2,8 @@ - Copyright (C) 2005, 2006, 2007 Collabora Limited - Copyright (C) 2005, 2006 Nokia Corporation + Copyright (C) 2005-2009 Collabora Limited + Copyright (C) 2005-2009 Nokia Corporation Copyright (C) 2006 INdT

This library is free software; you can redistribute it and/or @@ -47,8 +47,8 @@ USA.

Request that the connection be established. This will be done - asynchronously and errors will be returned by emitting StatusChanged - signals. + asynchronously and errors will be returned by emitting + StatusChanged signals. @@ -124,7 +124,8 @@ USA.

- Emitted whenever the SelfHandle property changes. If the connection + Emitted whenever the SelfHandle property + changes. If the connection is not yet in the CONNECTED state, this signal is not guaranteed to be emitted. @@ -144,19 +145,21 @@ USA.

The handle which represents the user on this connection, which will remain valid for the lifetime of this connection, or until a change - in the user's identifier is signalled by the SelfHandleChanged signal. + in the user's identifier is signalled by the + SelfHandleChanged signal. If the connection is not yet in the CONNECTED state, the value of this property MAY be zero. For compatibility with older - versions, clients should fall back to calling the GetSelfHandle + versions, clients should fall back to calling the + GetSelfHandle method. - The value of the SelfHandle property + The value of the SelfHandle property @@ -181,7 +184,8 @@ USA.

 - Get the current status as defined in the StatusChanged signal. + Get the current status as defined in the + StatusChanged signal. @@ -201,11 +205,13 @@ USA.

Notify the connection manger that your client is holding a copy of handles which may not be in use in any existing channel or - list, and were not obtained by using the RequestHandles method. For + list, and were not obtained by using the + RequestHandles method. For example, a handle observed in an emitted signal, or displayed somewhere in the UI that is not associated with a channel. The connection manager must not deallocate a handle where any clients - have used this method to indicate it is in use until the ReleaseHandle + have used this method to indicate it is in use until the + ReleaseHandles method is called, or the clients disappear from the bus.

Note that HoldHandles is idempotent - calling it multiple times @@ -309,7 +315,8 @@ USA.

If true, the channel was requested by a client that intends to present it to the user itself (i.e. it passed suppress_handler=TRUE - to the RequestChannel method), so no other handler should be + to the RequestChannel method), so no + other handler should be launched. Clients MAY assume that channels where this is true were created by a user request.

@@ -445,7 +452,12 @@ USA.

If a channel to a contact, room etc. is requested, on success, the returned channel may either be a new or existing channel to - the requested entity (i.e. its GetHandle() returns the + the requested entity (i.e. its + TargetHandleType + and TargetHandle + properties are the requested handle type and handle), or a newly created "anonymous" channel associated with the requested handle in some implementation-specific way.

@@ -561,7 +573,8 @@ USA.

number of contacts, rooms or server-stored lists on the service. The connection manager should record that these handles are in use by the client who invokes this method, and must not deallocate the handles - until the client disconnects from the bus or calls the ReleaseHandle + until the client disconnects from the bus or calls the + ReleaseHandles method. Where the name refers to an entity that already has a handle in this connection manager, this handle should be returned instead. The handle number 0 must not be returned by the connection manager. @@ -579,6 +592,13 @@ USA.

The given name is not a valid entity of the given type + + + The given handle type is valid, but not implemented on this + connection. For instance, a CM for a protocol that doesn't have + chat rooms would not implement room handles. + + @@ -763,10 +783,13 @@ USA.

ambiguous. Connection manager implementations should reference count these handles to determine if they are in use either by any active clients or any open channels, and may deallocate them when this ceases to be true. Clients - may request handles of a given type and name with the RequestHandles - method, inspect the entity name of handles with the InspectHandles method, - keep handles from being released with HoldHandles, and notify that they are - no longer storing handles with ReleaseHandles.

+ may request handles of a given type and name with the + RequestHandles method, inspect the entity + name of handles with the InspectHandles + method, keep handles from being released with + HoldHandles, and notify that they are no + longer storing handles with + ReleaseHandles.

 Previously, the account part of diff --git a/qt4/spec/Connection_Interface_Avatars.xml b/qt4/spec/Connection_Interface_Avatars.xml index 6bd0f36ef..27c77b91d 100644 --- a/qt4/spec/Connection_Interface_Avatars.xml +++ b/qt4/spec/Connection_Interface_Avatars.xml @@ -1,7 +1,7 @@ - Copyright (C) 2005-2007 Collabora Limited - Copyright (C) 2005, 2006 Nokia Corporation + Copyright (C) 2005-2008 Collabora Limited + Copyright (C) 2005-2008 Nokia Corporation Copyright (C) 2006 INdT

This library is free software; you can redistribute it and/or diff --git a/qt4/spec/Connection_Manager.xml b/qt4/spec/Connection_Manager.xml index 9bbe1b7a0..eafa6df6e 100644 --- a/qt4/spec/Connection_Manager.xml +++ b/qt4/spec/Connection_Manager.xml @@ -1,7 +1,7 @@ - Copyright (C) 2005, 2006 Collabora Limited - Copyright (C) 2005, 2006 Nokia Corporation + Copyright (C) 2005-2008 Collabora Limited + Copyright (C) 2005-2008 Nokia Corporation Copyright (C) 2006 INdT

This library is free software; you can redistribute it and/or diff --git a/qt4/spec/Media_Stream_Handler.xml b/qt4/spec/Media_Stream_Handler.xml index e47647971..35866a65e 100644 --- a/qt4/spec/Media_Stream_Handler.xml +++ b/qt4/spec/Media_Stream_Handler.xml @@ -1,7 +1,7 @@ - Copyright (C) 2005, 2006 Collabora Limited - Copyright (C) 2005, 2006 Nokia Corporation + Copyright (C) 2005-2008 Collabora Limited + Copyright (C) 2005-2008 Nokia Corporation Copyright (C) 2006 INdT

This library is free software; you can redistribute it and/or @@ -44,12 +44,30 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - - - - - - + + Information about a codec supported by a client or a peer's client. + + + + + The codec's payload identifier, as per RFC 3551 (static or dynamic) + + + + The codec's name + + + Type of stream this codec supports + + + Sampling frequency in Hertz + + + Number of supported channels + + + Codec-specific optional parameters + - As for SupportedCodecs. + Locally-supported codecs. @@ -200,9 +218,9 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - Codecs in the same format as for - SupportedCodecs, which have the same semantics as the - local codecs passed to Ready + + Locally-supported codecs + Used to provide codecs after Ready(), so the media client can go @@ -250,7 +268,9 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - As for SupportedCodecs + + Codecs supported by the remote peer. + Signal emitted when the connection manager wishes to inform the @@ -301,15 +321,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - List of codec info structures, each containing: -

    -
  • ID of codec
    • -
  • Codec name
    • -
  • Media type
    • -
  • Clock rate of codec
    • -
  • Number of supported channels
    • -
  • String key-value pairs for supported optional parameters
    • -
+ Locally supported codecs. diff --git a/qt4/spec/all.xml b/qt4/spec/all.xml index def46f45d..a1fd74530 100644 --- a/qt4/spec/all.xml +++ b/qt4/spec/all.xml @@ -3,7 +3,7 @@ xmlns:xi="http://www.w3.org/2001/XInclude"> Telepathy D-Bus Interface Specification -0.17.16 +0.17.17 Copyright (C) 2005-2008 Collabora Limited Copyright (C) 2005-2008 Nokia Corporation -- cgit v1.2.3