Skip to content

GitLab

T
telepathy-spec
Commit 4f3bd603 authored by Simon McVittie's avatar Simon McVittie
Browse files
Options

Revert "Flatten Requests interface into Connection" 

This reverts commit 28c6e0d0.

I decided against it:

> This might actually not be such a great idea. EnsureChannel and
> CreateChannel should clearly be core, and RequestableChannelClasses
> (aka TP_CONNECTION_FEATURE_CAPABILITIES) can reasonably be core
> while connected, but Channels (and its change-notification,
> NewChannel(s) and ChannelClosed) are sufficiently special-purpose
> that I think only the AM and regression tests should be using it.
> Having the Channels and their immutable properties in the GetAll
> result seems non-optimal.
Reviewed-by: Guillaume Desmottes's avatarGuillaume Desmottes <guillaume.desmottes@collabora.co.uk>
parent 9c9d773e
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 671 additions and 610 deletions
doc/templates/interface.html
View file @ 4f3bd603
......@@ -348,7 +348,7 @@
#if $interface.is_channel_related:
change once the channel has been created. Immutable properties SHOULD
appear in the channel detail list
of <a href="Connection.html#im.telepathy.v1.Connection.NewChannel">NewChannel</a>
of <a href="Connection_Interface_Requests.html#im.telepathy.v1.Connection.Interface.Requests.NewChannel">NewChannel</a>
signals.
#else
change.
......@@ -360,7 +360,7 @@
#if $interface.is_channel_related:
change once the channel has been created. Immutable properties SHOULD
appear in the channel detail list
of <a href="Connection.html#im.telepathy.v1.Connection.NewChannel">NewChannel</a>
of <a href="Connection_Interface_Requests.html#im.telepathy.v1.Connection.Interface.Requests.NewChannel">NewChannel</a>
signals.
#else
change.
......@@ -372,29 +372,29 @@
<div class="annotation requestable">Depending on the protocol, this
property may be <strong>requestable</strong>, which means that it may be
allowed in the properties hash of a channel request such as in the
<a href="Connection.html#im.telepathy.v1.Connection.CreateChannel">CreateChannel</a>
<a href="Connection_Interface_Requests.html#im.telepathy.v1.Connection.Interface.Requests.CreateChannel">CreateChannel</a>
and
<a href="Connection.html#im.telepathy.v1.Connection.EnsureChannel">EnsureChannel</a>
<a href="Connection_Interface_Requests.html#im.telepathy.v1.Connection.Interface.Requests.EnsureChannel">EnsureChannel</a>
methods
on <a href="Connection.html">Connection</a>
on <a href="Connection_Interface_Requests.html">Requests</a>
and <a href="Channel_Dispatcher.html">ChannelDispatcher</a>.
If supported on this protocol, the property should appear in either the
Fixed_Properties or Allowed_Properties of
a <a href="Connection.html#im.telepathy.v1.Connection.RequestableChannelClasses">RequestableChannelClass</a>
a <a href="Connection_Interface_Requests.html#im.telepathy.v1.Connection.Interface.Requests.RequestableChannelClasses">RequestableChannelClass</a>
advertised by the CM.</div>
#elif $property.requestable:
<div class="annotation requestable">This property
is <strong>requestable</strong>, which means that it is allowed
in the properties hash of a channel request such as in the
<a href="Connection.html#im.telepathy.v1.Connection.CreateChannel">CreateChannel</a>
<a href="Connection_Interface_Requests.html#im.telepathy.v1.Connection.Interface.Requests.CreateChannel">CreateChannel</a>
and
<a href="Connection.html#im.telepathy.v1.Connection.EnsureChannel">EnsureChannel</a>
<a href="Connection_Interface_Requests.html#im.telepathy.v1.Connection.Interface.Requests.EnsureChannel">EnsureChannel</a>
methods
on <a href="Connection.html">Connection</a>
on <a href="Connection_Interface_Requests.html">Requests</a>
and <a href="Channel_Dispatcher.html">ChannelDispatcher</a>.
The property should also appear in either the Fixed_Properties
or Allowed_Properties of
a <a href="Connection.html#im.telepathy.v1.Connection.RequestableChannelClasses">RequestableChannelClass</a>
a <a href="Connection_Interface_Requests.html#im.telepathy.v1.Connection.Interface.Requests.RequestableChannelClasses">RequestableChannelClass</a>
advertised by the CM.</div>
#end if
......
spec/Channel.xml
View file @ 4f3bd603
......@@ -189,7 +189,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>True if this channel was created in response to a local request,
such as a call to
<tp:dbus-ref namespace="im.telepathy.v1">Connection.CreateChannel</tp:dbus-ref>.</p>
<tp:dbus-ref namespace="im.telepathy.v1">Connection.Interface.Requests.CreateChannel</tp:dbus-ref>.</p>
<tp:rationale>
<p>The idea of this property is to distinguish between "incoming"
......@@ -323,7 +323,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<p>Each channel has a number of immutable properties (which cannot vary
after the channel has been announced with <tp:dbus-ref
namespace='imt1.Connection'>NewChannel</tp:dbus-ref>),
namespace='imt1.Connection.Interface.Requests'>NewChannel</tp:dbus-ref>),
provided to clients in the
<tp:dbus-ref namespace='imt1.Client.Observer'>ObserveChannel</tp:dbus-ref>,
<tp:dbus-ref namespace='imt1.Client.Approver'>AddDispatchOperation</tp:dbus-ref> and
......
spec/Channel_Dispatch_Operation.xml
View file @ 4f3bd603
......@@ -36,7 +36,7 @@
from outgoing requests for channels.</p>
<p>More specifically, whenever the <tp:dbus-ref
namespace="im.telepathy.v1">Connection.NewChannel</tp:dbus-ref>
namespace="im.telepathy.v1">Connection.Interface.Requests.NewChannel</tp:dbus-ref>
signal contains a channel whose <tp:dbus-ref
namespace="im.telepathy.v1.Channel">Requested</tp:dbus-ref>
property is false, a ChannelDispatchOperation
......
spec/Channel_Dispatcher.xml
View file @ 4f3bd603
......@@ -153,7 +153,7 @@
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>A dictionary containing desirable properties. This has the same
semantics as the corresponding parameter to
<tp:dbus-ref namespace="im.telepathy.v1">Connection.CreateChannel</tp:dbus-ref>.
<tp:dbus-ref namespace="im.telepathy.v1">Connection.Interface.Requests.CreateChannel</tp:dbus-ref>.
</p>
<p>Certain properties will not necessarily make sense in this
......@@ -318,7 +318,7 @@
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>A dictionary containing desirable properties. This has the same
semantics as the corresponding parameter to
<tp:dbus-ref namespace="im.telepathy.v1">Connection.EnsureChannel</tp:dbus-ref>.
<tp:dbus-ref namespace="im.telepathy.v1">Connection.Interface.Requests.EnsureChannel</tp:dbus-ref>.
</p>
<p>Certain properties will not necessarily make sense in this
......@@ -361,7 +361,7 @@
so it can try to dispatch subsequent channels in the same bundle
to the same handler. If the requested channel already exists (that
is, <tp:dbus-ref
namespace="im.telepathy.v1">Connection.EnsureChannel</tp:dbus-ref>
namespace="im.telepathy.v1">Connection.Interface.Requests.EnsureChannel</tp:dbus-ref>
returns <code>Yours=False</code>) then the channel dispatcher
SHOULD re-dispatch the channel to its existing handler, and MUST
NOT dispatch it to this client (unless it is the existing handler);
......
spec/Channel_Dispatcher_Interface_Messages1.xml
View file @ 4f3bd603
......@@ -126,7 +126,7 @@
<p>This method may raise any error that would be raised by the
<tp:dbus-ref
namespace="imt1.Connection">EnsureChannel</tp:dbus-ref>
namespace="imt1.Connection.Interface">Requests.EnsureChannel</tp:dbus-ref>
or <tp:dbus-ref
namespace="imt1.Channel.Type">Text.SendMessage</tp:dbus-ref>
methods, or signalled by the <tp:dbus-ref
......
spec/Channel_Interface_Addressing1.xml
View file @ 4f3bd603
......@@ -55,7 +55,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<tp:rationale>
<p>While this seems redundant, since the scheme is included in
<tp:member-ref>TargetURI</tp:member-ref>, it exists for constructing
<tp:dbus-ref namespace="im.telepathy.v1.Connection">RequestableChannelClasses</tp:dbus-ref>
<tp:dbus-ref namespace="im.telepathy.v1.Connection.Interface.Requests">RequestableChannelClasses</tp:dbus-ref>
that support a limited set of URI schemes.</p>
</tp:rationale>
......
spec/Channel_Interface_Conference1.xml
View file @ 4f3bd603
......@@ -50,7 +50,7 @@
If <tp:member-ref>InitialInviteeHandles</tp:member-ref> and
<tp:member-ref>InitialInviteeIDs</tp:member-ref> are
<var>Allowed_Properties</var> in <tp:dbus-ref
namespace="im.telepathy.v1.Connection">RequestableChannelClasses</tp:dbus-ref>,
namespace="im.telepathy.v1.Connection.Interface.Requests">RequestableChannelClasses</tp:dbus-ref>,
ad-hoc conferences to a set of contacts may be created by requesting a
channel, specifying
<tp:member-ref>InitialInviteeHandles</tp:member-ref> and/or
......@@ -114,7 +114,7 @@
into a single conference call by calling:</p>
<blockquote>
<code><tp:dbus-ref namespace="im.telepathy.v1.Connection">CreateChannel</tp:dbus-ref>({
<code><tp:dbus-ref namespace="im.telepathy.v1.Connection.Interface.Requests">CreateChannel</tp:dbus-ref>({
...<tp:dbus-ref namespace="im.telepathy.v1.Channel">ChannelType</tp:dbus-ref>: ...Call,
...<tp:member-ref>InitialChannels</tp:member-ref>: [C1, C2]
})</code>
......@@ -153,7 +153,7 @@
the room), call:</p>
<blockquote>
<code><tp:dbus-ref namespace="im.telepathy.v1.Connection">EnsureChannel</tp:dbus-ref>({
<code><tp:dbus-ref namespace="im.telepathy.v1.Connection.Interface.Requests">EnsureChannel</tp:dbus-ref>({
...ChannelType: ...Text,
...<tp:dbus-ref namespace="im.telepathy.v1.Channel">TargetHandleType</tp:dbus-ref>: ...Room,
...<tp:dbus-ref namespace="im.telepathy.v1.Channel">TargetID</tp:dbus-ref>: 'telepathy@conf.example.com',
......@@ -204,7 +204,7 @@
TargetHandle of C1 into Cn), then immediately inviting the
TargetHandle of C2, the TargetHandle of C3, etc. into Cn as well.</p>
<h4>Sample <tp:dbus-ref namespace='imt1.Connection'
<h4>Sample <tp:dbus-ref namespace='imt1.Connection.Interface.Requests'
>RequestableChannelClasses</tp:dbus-ref></h4>
<p>A GSM connection might advertise the following channel class for
......@@ -366,7 +366,7 @@
<tp:member-ref>InitialInviteeHandles</tp:member-ref> and
<tp:member-ref>InitialInviteeIDs</tp:member-ref> are
<var>Allowed_Properties</var> in <tp:dbus-ref
namespace='imt1.Connection'
namespace='imt1.Connection.Interface.Requests'
>RequestableChannelClasses</tp:dbus-ref>, then requests with zero
or one channel paths SHOULD also succeed; otherwise, clients SHOULD
NOT make requests with zero or one paths for this property.</p>
......@@ -428,7 +428,7 @@
(as opposed to merging several channels into one new conference
channel), this property SHOULD be requestable, and appear in the allowed
properties in <tp:dbus-ref
namespace="im.telepathy.v1.Connection"
namespace="im.telepathy.v1.Connection.Interface.Requests"
>RequestableChannelClasses</tp:dbus-ref>. Otherwise, this property
SHOULD NOT be requestable, and its value SHOULD always be the empty
list.</p>
......@@ -521,7 +521,7 @@
<p>This property SHOULD be requestable, and appear in the allowed
properties in <tp:dbus-ref
namespace="im.telepathy.v1.Connection"
namespace="im.telepathy.v1.Connection.Interface.Requests"
>RequestableChannelClasses</tp:dbus-ref>, in protocols where
invitations can have an accompanying text message.</p>
......
spec/Channel_Interface_SMS1.xml
View file @ 4f3bd603
......@@ -102,7 +102,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
<p>This property is immutable (cannot change), and therefore SHOULD
appear wherever immutable properties are reported, e.g. <tp:dbus-ref
namespace="imt1.Connection"
namespace="imt1.Connection.Interface.Requests"
>NewChannel</tp:dbus-ref> signals.</p>
<tp:rationale>
......
spec/Channel_Interface_Tube1.xml
View file @ 4f3bd603
......@@ -70,7 +70,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
<p>When requesting a tube with
<tp:dbus-ref
namespace="im.telepathy.v1.Connection">CreateChannel</tp:dbus-ref>,
namespace="im.telepathy.v1.Connection.Interface.Requests">CreateChannel</tp:dbus-ref>,
this property MUST NOT be included in the request; instead, it is set
when <tp:dbus-ref
namespace="im.telepathy.v1.Channel.Type">StreamTube1.Offer</tp:dbus-ref>
......@@ -81,7 +81,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
<p>When receiving an incoming tube, this property is immutable and so advertised in the
<tp:dbus-ref
namespace="im.telepathy.v1.Connection">NewChannel</tp:dbus-ref>
namespace="im.telepathy.v1.Connection.Interface.Requests">NewChannel</tp:dbus-ref>
signal.</p>
</tp:docstring>
</property>
......@@ -93,7 +93,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
<p>When requesting a tube with
<tp:dbus-ref
namespace="im.telepathy.v1.Connection">CreateChannel</tp:dbus-ref>,
namespace="im.telepathy.v1.Connection.Interface.Requests">CreateChannel</tp:dbus-ref>,
this property MUST NOT be included in the request.</p>
</tp:docstring>
</property>
......
spec/Channel_Request.xml
View file @ 4f3bd603
......@@ -154,7 +154,7 @@
<p>If the connection manager has already been asked to create a
channel but has not produced one yet (e.g. if <tp:dbus-ref
namespace="im.telepathy.v1">Connection.CreateChannel</tp:dbus-ref>
namespace="im.telepathy.v1">Connection.Interface.Requests.CreateChannel</tp:dbus-ref>
has been called, but has not yet returned), then the
ChannelDispatcher will remember that the request has been cancelled.
When the channel appears, it will be closed (if it was newly
......@@ -191,7 +191,7 @@
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>The name of a D-Bus error. This can come from various sources,
including the error raised by <tp:dbus-ref
namespace="im.telepathy.v1.Connection">CreateChannel</tp:dbus-ref>,
namespace="im.telepathy.v1.Connection.Interface.Requests">CreateChannel</tp:dbus-ref>,
or an error generated
to represent failure to establish the <tp:dbus-ref
namespace="im.telepathy.v1">Connection</tp:dbus-ref>.</p>
......@@ -322,7 +322,7 @@
tp:type="Qualified_Property_Value_Map">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>The same immutable properties of the Channel that would appear
in a <tp:dbus-ref namespace="imt1.Connection"
in a <tp:dbus-ref namespace="imt1.Connection.Interface.Requests"
>NewChannel</tp:dbus-ref> signal.</p>
</tp:docstring>
</arg>
......
spec/Channel_Type_Call1.xml
View file @ 4f3bd603
......@@ -75,7 +75,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
<blockquote>
<pre>
<tp:dbus-ref namespace="imt1.Connection">CreateChannel</tp:dbus-ref>({
<tp:dbus-ref namespace="imt1.Connection.Interface.Requests">CreateChannel</tp:dbus-ref>({
...<tp:dbus-ref namespace="imt1.Channel">ChannelType</tp:dbus-ref>: ...<tp:dbus-ref
namespace="imt1.Channel.Type">Call1</tp:dbus-ref>,
...<tp:dbus-ref namespace="imt1.Channel">TargetHandleType</tp:dbus-ref>: Contact,
......@@ -155,12 +155,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
<p>When an incoming call occurs, something like the following
<tp:dbus-ref
namespace="imt1.Connection">NewChannel</tp:dbus-ref>
namespace="imt1.Connection.Interface.Requests">NewChannel</tp:dbus-ref>
signal will occur:</p>
<blockquote>
<pre>
<tp:dbus-ref namespace="imt1.Connection">NewChannel</tp:dbus-ref>(
<tp:dbus-ref namespace="imt1.Connection.Interface.Requests">NewChannel</tp:dbus-ref>(
/im/telepathy/v1/Connection/foo/bar/foo_40bar_2ecom/CallChannel,
{
...<tp:dbus-ref namespace="imt1.Channel">ChannelType</tp:dbus-ref>: ...<tp:dbus-ref
......@@ -267,7 +267,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
<h4>Requestable channel classes</h4>
<p>The <tp:dbus-ref
namespace="imt1.Connection">RequestableChannelClasses</tp:dbus-ref>
namespace="imt1.Connection.Interface.Requests">RequestableChannelClasses</tp:dbus-ref>
for <tp:dbus-ref
namespace="imt1.Channel.Type">Call1</tp:dbus-ref> channels
can be:</p>
......
spec/Channel_Type_Contact_Search1.xml
View file @ 4f3bd603
......@@ -37,7 +37,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
found.</p>
<p>Connections that support contact search channels SHOULD have an entry
in <tp:dbus-ref namespace='imt1.Connection'
in <tp:dbus-ref namespace='imt1.Connection.Interface.Requests'
>RequestableChannelClasses</tp:dbus-ref> with the <tp:dbus-ref
namespace='imt1.Channel'>ChannelType</tp:dbus-ref> fixed to this
interface,
......@@ -56,7 +56,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<p>Requests for channels of this type need only
optionally specify the <tp:member-ref>Server</tp:member-ref> property
(if it is an allowed property in the connection's <tp:dbus-ref
namespace='imt1.Connection'>RequestableChannelClasses</tp:dbus-ref>).</p>
namespace='imt1.Connection.Interface.Requests'>RequestableChannelClasses</tp:dbus-ref>).</p>
<p>Before searching, the
<tp:member-ref>AvailableSearchKeys</tp:member-ref> property should be
......@@ -81,7 +81,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<tp:member-ref>Limit</tp:member-ref> results. If allowed by the
connection manager, clients may specify the "page size" by specifying
<tp:member-ref>Limit</tp:member-ref> when calling
<tp:dbus-ref namespace="im.telepathy.v1.Connection">CreateChannel</tp:dbus-ref>.
<tp:dbus-ref namespace="im.telepathy.v1.Connection.Interface.Requests">CreateChannel</tp:dbus-ref>.
</p>
<p>The client should call the channel's <tp:dbus-ref
......@@ -94,10 +94,10 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
to the same server, if applicable).</p>
<p>It does not make sense to request this channel type using <tp:dbus-ref
namespace="im.telepathy.v1.Connection">EnsureChannel</tp:dbus-ref>;
namespace="im.telepathy.v1.Connection.Interface.Requests">EnsureChannel</tp:dbus-ref>;
clients SHOULD request channels of this type using
<tp:dbus-ref
namespace="im.telepathy.v1.Connection">CreateChannel</tp:dbus-ref>
namespace="im.telepathy.v1.Connection.Interface.Requests">CreateChannel</tp:dbus-ref>
instead.</p>
<tp:rationale>
......@@ -296,7 +296,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<tp:rationale>
It can be in the <tp:dbus-ref
namespace="im.telepathy.v1.Connection">NewChannel</tp:dbus-ref>
namespace="im.telepathy.v1.Connection.Interface.Requests">NewChannel</tp:dbus-ref>
signal for round-trip reduction.
</tp:rationale>
</tp:docstring>
......
spec/Channel_Type_DBus_Tube1.xml
View file @ 4f3bd603
......@@ -138,7 +138,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
other end.</p>
<p>When requesting a channel with
<tp:dbus-ref
namespace="im.telepathy.v1.Connection">CreateChannel</tp:dbus-ref>,
namespace="im.telepathy.v1.Connection.Interface.Requests">CreateChannel</tp:dbus-ref>,
this property MUST be included in the request.</p>
</tp:docstring>
</property>
......@@ -190,7 +190,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
</tp:rationale>
<p>When requesting a channel with
<tp:dbus-ref namespace="im.telepathy.v1">Connection.CreateChannel</tp:dbus-ref>,
<tp:dbus-ref namespace="im.telepathy.v1">Connection.Interface.Requests.CreateChannel</tp:dbus-ref>,
this property MUST NOT be included in the request.</p>
</tp:docstring>
......
spec/Channel_Type_File_Transfer1.xml
View file @ 4f3bd603
......@@ -102,7 +102,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
been created.</p>
<p>This property is mandatory when requesting the channel with the
<tp:dbus-ref namespace="im.telepathy.v1">Connection.CreateChannel</tp:dbus-ref>
<tp:dbus-ref namespace="im.telepathy.v1">Connection.Interface.Requests.CreateChannel</tp:dbus-ref>
method. Protocols which do not have a content-type property with file
transfers should set this value to application/octet-stream.</p>
</tp:docstring>
......@@ -120,7 +120,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
be set to monkey.pdf.</p>
<p>This property is mandatory when requesting the channel with the
<tp:dbus-ref namespace="im.telepathy.v1">Connection.CreateChannel</tp:dbus-ref>
<tp:dbus-ref namespace="im.telepathy.v1">Connection.Interface.Requests.CreateChannel</tp:dbus-ref>
method. This property cannot be empty and MUST be set to a sensible value.</p>
</tp:docstring>
</property>
......@@ -138,7 +138,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
to the byte.</p>
<p>This property is mandatory when requesting the channel with the
<tp:dbus-ref namespace="im.telepathy.v1">Connection.CreateChannel</tp:dbus-ref>
<tp:dbus-ref namespace="im.telepathy.v1">Connection.Interface.Requests.CreateChannel</tp:dbus-ref>
method. If this information isn't provided in the protocol, connection managers MUST set it
to UINT64_MAX.</p>
</tp:docstring>
......@@ -151,15 +151,15 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<p>The type of the <tp:member-ref>ContentHash</tp:member-ref> property.</p>
<p>This property is optional when requesting the channel with the
<tp:dbus-ref namespace="im.telepathy.v1">Connection.CreateChannel</tp:dbus-ref>
<tp:dbus-ref namespace="im.telepathy.v1">Connection.Interface.Requests.CreateChannel</tp:dbus-ref>
method. However, if you wish to include the <tp:member-ref>ContentHash</tp:member-ref>
property you MUST also include this property. If you omit this property from a
<tp:dbus-ref namespace="im.telepathy.v1">Connection.CreateChannel</tp:dbus-ref>
<tp:dbus-ref namespace="im.telepathy.v1">Connection.Interface.Requests.CreateChannel</tp:dbus-ref>
method call then its value will be assumed to be File_Hash_Type_None.</p>
<p>For each supported hash type, implementations SHOULD include an entry
in <tp:dbus-ref
namespace="im.telepathy.v1.Connection">RequestableChannelClasses</tp:dbus-ref>
namespace="im.telepathy.v1.Connection.Interface.Requests">RequestableChannelClasses</tp:dbus-ref>
with this property fixed to that hash type. If the protocol supports
offering a file without a content hash, implementations SHOULD list
this property in Allowed in a requestable channel class, mapping hash
......@@ -177,7 +177,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
property.</p>
<p>This property is optional when requesting the channel with the
<tp:dbus-ref namespace="im.telepathy.v1">Connection.CreateChannel</tp:dbus-ref>
<tp:dbus-ref namespace="im.telepathy.v1">Connection.Interface.Requests.CreateChannel</tp:dbus-ref>
method. Its value MUST correspond to the appropriate type of the
<tp:member-ref>ContentHashType</tp:member-ref> property. If the
ContentHashType property is not set, or set to File_Hash_Type_None,
......@@ -192,7 +192,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
channel has been created.</p>
<p>This property is optional when requesting the channel with the
<tp:dbus-ref namespace="im.telepathy.v1">Connection.CreateChannel</tp:dbus-ref>
<tp:dbus-ref namespace="im.telepathy.v1">Connection.Interface.Requests.CreateChannel</tp:dbus-ref>
method. If this property was not provided by the remote party, connection managers MUST set it to
the empty string.</p>
</tp:docstring>
......@@ -206,7 +206,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
cannot change once the channel has been created</p>
<p>This property is optional when requesting the channel with the
<tp:dbus-ref namespace="im.telepathy.v1">Connection.CreateChannel</tp:dbus-ref>
<tp:dbus-ref namespace="im.telepathy.v1">Connection.Interface.Requests.CreateChannel</tp:dbus-ref>
method.</p>
</tp:docstring>
</property>
......
spec/Channel_Type_Room_List1.xml
View file @ 4f3bd603
......@@ -66,7 +66,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<p>Emitted when information about rooms on the server becomes
available. The array contains the room handle (as can be
passed to the <tp:dbus-ref
namespace="imt1.Connection">CreateChannel</tp:dbus-ref>
namespace="imt1.Connection.Interface.Requests">CreateChannel</tp:dbus-ref>
method with <tp:dbus-ref
namespace="imt1.Channel">TargetHandleType</tp:dbus-ref>=
HANDLE_TYPE_ROOM), the channel type, and a dictionary
......
spec/Channel_Type_Server_Authentication1.xml
View file @ 4f3bd603
......@@ -46,7 +46,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<p>Channels of this type cannot be requested with methods such as
<tp:dbus-ref
namespace="imt1.Connection">CreateChannel</tp:dbus-ref>.
namespace="imt1.Connection.Interface.Requests">CreateChannel</tp:dbus-ref>.
They always have <tp:dbus-ref
namespace="imt1.Channel">Requested</tp:dbus-ref> = False,
<tp:dbus-ref
......
spec/Channel_Type_Server_TLS_Connection1.xml
View file @ 4f3bd603
......@@ -31,7 +31,7 @@
<tp:dbus-ref namespace="im.telepathy.v1.Channel">TargetHandleType</tp:dbus-ref>
= None and <tp:dbus-ref namespace="im.telepathy.v1.Channel">TargetHandle</tp:dbus-ref>
= 0, and cannot be requested with methods such as <tp:dbus-ref
namespace="im.telepathy.v1.Connection">CreateChannel</tp:dbus-ref>.
namespace="im.telepathy.v1.Connection.Interface.Requests">CreateChannel</tp:dbus-ref>.
Also, they SHOULD be dispatched while the
<tp:dbus-ref namespace="im.telepathy.v1">Connection</tp:dbus-ref>
owning them is in the CONNECTING state.</p>
......
spec/Channel_Type_Stream_Tube1.xml
View file @ 4f3bd603
......@@ -246,7 +246,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
<p>When the tube is offered, the service name is transmitted to the
other end.</p>
<p>When requesting a channel with
<tp:dbus-ref namespace="im.telepathy.v1">Connection.CreateChannel</tp:dbus-ref>,
<tp:dbus-ref namespace="im.telepathy.v1">Connection.Interface.Requests.CreateChannel</tp:dbus-ref>,
this property MUST be included in the request.</p>
</tp:docstring>
</property>
......@@ -286,7 +286,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
access control.</p>
<p>When requesting a channel with
<tp:dbus-ref namespace="im.telepathy.v1">Connection.CreateChannel</tp:dbus-ref>,
<tp:dbus-ref namespace="im.telepathy.v1">Connection.Interface.Requests.CreateChannel</tp:dbus-ref>,
this property MUST NOT be included in the request.</p>
</tp:docstring>
......
spec/Channel_Type_Text.xml
View file @ 4f3bd603
......@@ -1494,7 +1494,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
the connection manager MUST allow this, but SHOULD open a new channel
to deliver those messages, signalling it as a new channel with the
<tp:dbus-ref
namespace="imt1.Connection">NewChannel</tp:dbus-ref>
namespace="imt1.Connection.Interface.Requests">NewChannel</tp:dbus-ref>
signal. The new channel should resemble the old channel, but have
<tp:dbus-ref namespace='imt1.Channel'>Requested</tp:dbus-ref> = FALSE
regardless of its previous value; the <tp:dbus-ref
......
spec/Client_Observer.xml
View file @ 4f3bd603
......@@ -122,7 +122,7 @@
interested. The <tp:member-ref>ObserveChannel</tp:member-ref> method
should be called by the channel dispatcher whenever the new
channel in a <tp:dbus-ref
namespace="im.telepathy.v1.Connection">NewChannel</tp:dbus-ref>
namespace="im.telepathy.v1.Connection.Interface.Requests">NewChannel</tp:dbus-ref>
signal matches this description.</p>
<p>Only certain D-Bus types have useful semantics for matching like this,
......@@ -255,7 +255,7 @@ Recover=true
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Called by the channel dispatcher when a channel in which the
observer has registered an interest are announced in a <tp:dbus-ref
namespace="im.telepathy.v1.Connection">NewChannel</tp:dbus-ref>
namespace="im.telepathy.v1.Connection.Interface.Requests">NewChannel</tp:dbus-ref>
signal.</p>
<p>The observer MUST NOT return from this method call until it is ready
......
spec/Connection.xml
View file @ 4f3bd603
This diff is collapsed.
spec/Connection_Interface_Contact_Capabilities1.xml
View file @ 4f3bd603
......@@ -194,7 +194,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>The contact's capabilities. These should be represented
in the same way as in <tp:dbus-ref
namespace="im.telepathy.v1.Connection"
namespace="im.telepathy.v1.Connection.Interface.Requests"
>RequestableChannelClasses</tp:dbus-ref>,
except that they may have more fixed properties or fewer allowed
properties, to represent contacts who do not have all the
......
spec/Connection_Interface_Requests.xml 0 → 100644
View file @ 4f3bd603
This diff is collapsed.
spec/Protocol.xml
View file @ 4f3bd603
......@@ -137,6 +137,10 @@ allowed=im.telepathy.v1.Channel.TargetHandle;im.telepathy.v1.Channel.TargetID;
<code>.manager</code> file, using the key
<code>ConnectionInterfaces</code>. The corresponding value
is a list of D-Bus interface names, each followed by a semicolon.</p>
<p>As a special case, the mandatory <tp:dbus-ref
namespace="imt1.Connection.Interface">Requests</tp:dbus-ref>
interface SHOULD NOT be listed in this property.</p>
</tp:docstring>
</property>
......@@ -149,7 +153,7 @@ allowed=im.telepathy.v1.Channel.TargetHandle;im.telepathy.v1.Channel.TargetID;
<tp:dbus-ref namespace="im.telepathy.v1"
>Connection</tp:dbus-ref> to this protocol (i.e. they will,
or might, appear in the Connection's <tp:dbus-ref
namespace="im.telepathy.v1.Connection"
namespace="im.telepathy.v1.Connection.Interface.Requests"
>RequestableChannelClasses</tp:dbus-ref> property).</p>
<p>Whether a Connection will have all, some or none of these
......
spec/Protocol_Interface_Addressing1.xml
View file @ 4f3bd603
......@@ -116,7 +116,7 @@ AddressableURISchemes=tel;sip;
offline. When it is connected the addressable URI schemes should be
retrieved from the
<tp:dbus-ref
namespace="im.telepathy.v1.Connection">RequestableChannelClasses</tp:dbus-ref>'s
namespace="im.telepathy.v1.Connection.Interface">Requests.RequestableChannelClasses</tp:dbus-ref>'s
TargetURIScheme fixed-property instead.</p>
<p>Connection managers with a <code>.manager</code> file
......
spec/all.xml
View file @ 4f3bd603
......@@ -48,6 +48,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
</p>
</tp:docstring>
<xi:include href="Connection.xml"/>
<xi:include href="Connection_Interface_Requests.xml"/>
<tp:section name="Contact list interfaces">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment