diff options
Diffstat (limited to 'spec/Client_Handler.xml')
| -rw-r--r-- | spec/Client_Handler.xml | 69 |
1 files changed, 25 insertions, 44 deletions
diff --git a/spec/Client_Handler.xml b/spec/Client_Handler.xml index 3a922e8c..f1ff37d3 100644 --- a/spec/Client_Handler.xml +++ b/spec/Client_Handler.xml @@ -20,10 +20,10 @@ 02110-1301, USA.</p> </tp:license> - <interface name="org.freedesktop.Telepathy.Client.Handler"> + <interface name="im.telepathy1.Client.Handler"> <tp:added version="0.17.26">(as a stable interface)</tp:added> - <tp:requires interface="org.freedesktop.Telepathy.Client"/> + <tp:requires interface="im.telepathy1.Client"/> <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Handlers are the user interface for a channel. They turn an abstract @@ -36,19 +36,17 @@ <p>Because each channel is only handled by one Handler, handlers may perform actions that only make sense to do once, such as acknowledging - <tp:dbus-ref namespace="org.freedesktop.Telepathy.Channel.Type">Text</tp:dbus-ref> + <tp:dbus-ref namespace="im.telepathy1.Channel.Type">Text</tp:dbus-ref> messages, doing the actual streaming for <tp:dbus-ref - namespace="org.freedesktop.Telepathy.Channel.Type">StreamedMedia</tp:dbus-ref> - channels with the <tp:dbus-ref - namespace="org.freedesktop.Telepathy.Channel.Interface">MediaSignalling</tp:dbus-ref> - interface, or transferring the file in <tp:dbus-ref - namespace="org.freedesktop.Telepathy.Channel.Type">FileTransfer</tp:dbus-ref> + namespace="im.telepathy1.Channel.Type">Call1</tp:dbus-ref> + channels, or transferring the file in <tp:dbus-ref + namespace="im.telepathy1.Channel.Type">FileTransfer1</tp:dbus-ref> channels.</p> <p>When a new incoming channel (one with - <tp:dbus-ref namespace="org.freedesktop.Telepathy.Channel">Requested</tp:dbus-ref> + <tp:dbus-ref namespace="im.telepathy1.Channel">Requested</tp:dbus-ref> = FALSE) is offered to - <tp:dbus-ref namespace="org.freedesktop.Telepathy.Client">Approver</tp:dbus-ref>s + <tp:dbus-ref namespace="im.telepathy1.Client">Approver</tp:dbus-ref>s by the channel dispatcher, it also offers the Approvers a list of all the running or activatable handlers whose <tp:member-ref>HandlerChannelFilter</tp:member-ref> property @@ -57,7 +55,7 @@ those channel handlers to handle the channel.</p> <p>When a new outgoing channel (one with - <tp:dbus-ref namespace="org.freedesktop.Telepathy.Channel">Requested</tp:dbus-ref> + <tp:dbus-ref namespace="im.telepathy1.Channel">Requested</tp:dbus-ref> = TRUE) appears, the channel dispatcher passes it to an appropriate channel handler automatically. </p> @@ -69,12 +67,10 @@ type="aa{sv}" access="read" tp:type="Channel_Class[]"> <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>A specification of the channels that this channel handler can - deal with. It will be offered to approvers as a potential - channel handler for bundles that contain only suitable channels, - or for suitable channels that must be handled separately.</p> + deal with.</p> <p>This property works in exactly the same way as the - <tp:dbus-ref namespace="org.freedesktop.Telepathy">Client.Observer.ObserverChannelFilter</tp:dbus-ref> + <tp:dbus-ref namespace="im.telepathy1">Client.Observer.ObserverChannelFilter</tp:dbus-ref> property. In particular, it cannot change while the handler process continues to own the corresponding Client bus name.</p> @@ -91,26 +87,11 @@ <p>If true, channels destined for this handler are automatically handled, without invoking approvers.</p> - <tp:rationale> - <p>The intended usage is to allow a client handling one channel to - pick up closely related channels. Suppose a client capable of - handling both Text and StreamedMedia, - <code>org.freedesktop.Telepathy.Client.Empathy</code>, is - handling a StreamedMedia channel. That client can take a second - well-known bus name, say - <code>org.freedesktop.Telepathy.Client.Empathy._1._42.Bundle1</code>, - and configure an object at - <code>/org/freedesktop/Telepathy/Client/Empathy/_1/_42/Bundle1</code> - with BypassApproval = TRUE, - whose <tp:member-ref>HandlerChannelFilter</tp:member-ref> - matches closely related Text channels by their Bundle property.</p> - </tp:rationale> - <p>For service-activatable handlers, this property should be specified in the handler's <tt>.client</tt> file as follows:</p> <pre> -[org.freedesktop.Telepathy.Client.Handler] +[im.telepathy1.Client.Handler] BypassApproval=true </pre> </tp:docstring> @@ -133,7 +114,7 @@ BypassApproval=true </tp:rationale> <p>So far, all client capabilities are defined by the <tp:dbus-ref - namespace="org.freedesktop.Telepathy.Channel.Interface">MediaSignalling</tp:dbus-ref> + namespace="im.telepathy1.Channel.Type">Call1</tp:dbus-ref> interface.</p> </tp:docstring> </tp:simple-type> @@ -148,7 +129,7 @@ BypassApproval=true <p>For handlers that have a <code>.client</code> file, the channel dispatcher may discover this property from the - <code>org.freedesktop.Telepathy.Client.Handler.Capabilities</code> + <code>im.telepathy1.Client.Handler.Capabilities</code> group; for each capability, that group contains a key whose name is the capability, with value <code>true</code>. Keys with other values SHOULD NOT appear in this group.</p> @@ -158,11 +139,11 @@ BypassApproval=true and Theora and H264 video might contain this group:</p> <pre> -[org.freedesktop.Telepathy.Client.Handler.Capabilities] -org.freedesktop.Telepathy.Channel.Interface.MediaSignalling/ice-udp=true -org.freedesktop.Telepathy.Channel.Interface.MediaSignalling/audio/speex=true -org.freedesktop.Telepathy.Channel.Interface.MediaSignalling/video/theora=true -org.freedesktop.Telepathy.Channel.Interface.MediaSignalling/video/h264=true +[im.telepathy1.Client.Handler.Capabilities] +im.telepathy1.Channel.Interface.MediaSignalling/ice-udp=true +im.telepathy1.Channel.Interface.MediaSignalling/audio/speex=true +im.telepathy1.Channel.Interface.MediaSignalling/video/theora=true +im.telepathy1.Channel.Interface.MediaSignalling/video/h264=true </pre> <p>Like the <tp:member-ref>HandlerChannelFilter</tp:member-ref> @@ -203,10 +184,10 @@ org.freedesktop.Telepathy.Channel.Interface.MediaSignalling/video/h264=true <p>If closing the channels, it is RECOMMENDED that the channel dispatcher attempts to close the channels using <tp:dbus-ref - namespace="org.freedesktop.Telepathy">Channel.Close</tp:dbus-ref>, + namespace="im.telepathy1">Channel.Close</tp:dbus-ref>, but resorts to calling <tp:dbus-ref - namespace="org.freedesktop.Telepathy">Channel.Interface.Destroyable.Destroy</tp:dbus-ref> + namespace="im.telepathy1">Channel.Interface.Destroyable1.Destroy</tp:dbus-ref> (if available) or ignoring the channel (if not) if the same handler repeatedly fails to handle channels.</p> @@ -225,10 +206,10 @@ org.freedesktop.Telepathy.Channel.Interface.MediaSignalling/video/h264=true <arg name="Account" type="o" direction="in"> <tp:docstring> The - <tp:dbus-ref namespace="org.freedesktop.Telepathy">Account</tp:dbus-ref> + <tp:dbus-ref namespace="im.telepathy1">Account</tp:dbus-ref> with which the channels are associated. The well-known bus name to use is that of the - <tp:dbus-ref namespace="org.freedesktop.Telepathy">AccountManager</tp:dbus-ref>. + <tp:dbus-ref namespace="im.telepathy1">AccountManager</tp:dbus-ref>. </tp:docstring> </arg> @@ -256,7 +237,7 @@ org.freedesktop.Telepathy.Channel.Interface.MediaSignalling/video/h264=true <tp:rationale> <p>If the handler implements Requests, this tells it that these channels match previous <tp:dbus-ref - namespace="org.freedesktop.Telepathy.Client.Interface.Requests">AddRequest</tp:dbus-ref> + namespace="im.telepathy1.Client.Interface.Requests">AddRequest</tp:dbus-ref> calls that it may have received.</p> <p>There can be more than one, if they were EnsureChannel @@ -284,7 +265,7 @@ org.freedesktop.Telepathy.Channel.Interface.MediaSignalling/video/h264=true <dl> <dt><code>request-properties</code> - a{oa{sv}}</dt> <dd>A map from <tp:dbus-ref - namespace="org.freedesktop.Telepathy">ChannelRequest</tp:dbus-ref> + namespace="im.telepathy1">ChannelRequest</tp:dbus-ref> paths listed in <var>Requests_Satisfied</var> to <tp:type>Qualified_Property_Value_Map</tp:type>s containing namespaced immutable properties of each request.</dd> |