Commit ef3afdcc authored by Guillaume Desmottes's avatar Guillaume Desmottes 🐐

rename Handle_Type to Entity_Type

parent dab1a965
......@@ -68,8 +68,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<p>This is fixed for the lifetime of the channel, so channels which
could potentially be used to communicate with multiple contacts,
and do not have an identity of their own (such as a Handle_Type_Room
handle), must have TargetHandleType set to Handle_Type_None and
and do not have an identity of their own (such as a Entity_Type_Room
handle), must have TargetHandleType set to Entity_Type_None and
TargetHandle set to 0.</p>
<p>Unlike in the telepathy-spec 0.16 API, there is no particular
......@@ -79,7 +79,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<p>If this is present in a channel request, it must be nonzero,
<tp:member-ref>TargetHandleType</tp:member-ref>
MUST be present and not Handle_Type_None, and
MUST be present and not Entity_Type_None, and
<tp:member-ref>TargetID</tp:member-ref> MUST NOT be
present. Properties from
<tp:dbus-ref namespace="im.telepathy.v1.Channel.Interface">Addressing1</tp:dbus-ref>
......@@ -90,7 +90,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<ul>
<li>have the specified TargetHandle property; or</li>
<li>have <tp:member-ref>TargetHandleType</tp:member-ref> =
Handle_Type_None, TargetHandle = 0, and be configured such that
Entity_Type_None, TargetHandle = 0, and be configured such that
it could communicate with the specified handle in some other way
(e.g. have the requested contact handle in its Group
interface)</li>
......@@ -111,7 +111,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<p>If this is present in a channel request,
<tp:member-ref>TargetHandleType</tp:member-ref>
MUST be present and not Handle_Type_None, and
MUST be present and not Entity_Type_None, and
<tp:member-ref>TargetHandle</tp:member-ref> MUST NOT be
present. Properties from
<tp:dbus-ref namespace="im.telepathy.v1.Channel.Interface">Addressing1</tp:dbus-ref>
......@@ -133,15 +133,15 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
</property>
<property name="TargetHandleType" type="u" access="read"
tp:type="Handle_Type" tp:name-for-bindings="Target_Handle_Type">
tp:type="Entity_Type" tp:name-for-bindings="Target_Handle_Type">
<tp:added version="0.17.7"/>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>The type of <tp:member-ref>TargetHandle</tp:member-ref>.</p>
<p>If this is omitted from a channel request, connection managers
SHOULD treat this as equivalent to Handle_Type_None.</p>
SHOULD treat this as equivalent to Entity_Type_None.</p>
<p>If this is omitted or is Handle_Type_None,
<p>If this is omitted or is Entity_Type_None,
<tp:member-ref>TargetHandle</tp:member-ref> and
<tp:member-ref>TargetID</tp:member-ref> MUST be omitted from the
request.</p>
......@@ -385,7 +385,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
</tp:docstring>
<tp:changed version="0.17.7">Previously we guaranteed that, for
any handle type other than Handle_Type_None, and for any channel type
any handle type other than Entity_Type_None, and for any channel type
and any handle, there would be no more than one channel with that
combination of channel type, handle type and handle. This guarantee
has now been removed in order to accommodate features like message
......
......@@ -114,7 +114,7 @@
<tp:dbus-ref namespace="imt1">Channel.ChannelType</tp:dbus-ref>:
<tp:dbus-ref namespace="imt1">Channel.Type.Text</tp:dbus-ref>,
<tp:dbus-ref namespace="imt1">Channel.TargetHandleType</tp:dbus-ref>:
<tp:value-ref type="Handle_Type">Contact</tp:value-ref>,
<tp:value-ref type="Entity_Type">Contact</tp:value-ref>,
<tp:dbus-ref namespace="imt1">Channel.TargetID</tp:dbus-ref>:
<var>Target_ID</var>
}</pre>
......
......@@ -77,7 +77,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<tp:dbus-ref namespace="im.telepathy.v1.Channel">TargetID</tp:dbus-ref>,
and <tp:member-ref>TargetURI</tp:member-ref> MUST NOT be present.
<tp:dbus-ref namespace="im.telepathy.v1.Channel">TargetHandleType</tp:dbus-ref>
must either not be present or set to Handle_Type_Contact.
must either not be present or set to Entity_Type_Contact.
The request MUST fail with error InvalidHandle, without
side-effects, if the requested vCard address cannot be found.</p>
</tp:docstring>
......@@ -98,7 +98,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
and <tp:member-ref>TargetVCardAddress</tp:member-ref> MUST NOT be
present.
<tp:dbus-ref namespace="im.telepathy.v1.Channel">TargetHandleType</tp:dbus-ref>
must either not be present or set to Handle_Type_Contact.
must either not be present or set to Entity_Type_Contact.
The request MUST fail with error InvalidHandle, without
side-effects, if the requested vCard address cannot be found.</p>
</tp:docstring>
......
......@@ -67,7 +67,7 @@
channel into the MUC, or to merge a 1-1 Jingle call into a Muji
call by inviting the peer from the Jingle call into the Muji call.
(MUC and Muji channels are both implemented by XMPP MUCs, with
Handle_Type_Room.)</p>
Entity_Type_Room.)</p>
</tp:rationale>
</tp:docstring>
......
......@@ -50,7 +50,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
{ ...<tp:dbus-ref namespace='imt1.Channel'>ChannelType</tp:dbus-ref>:
...<tp:dbus-ref namespace='imt1.Channel.Type'>Text</tp:dbus-ref>,<br/>
  ...<tp:dbus-ref namespace='imt1.Channel'>TargetHandleType</tp:dbus-ref>:
<tp:value-ref type="Handle_Type">Contact</tp:value-ref>,<br/>
<tp:value-ref type="Entity_Type">Contact</tp:value-ref>,<br/>
  ...<tp:dbus-ref namespace='imt1.Channel.Interface'>SMS1.Flash</tp:dbus-ref>:
True,<br/>
}</code></blockquote>
......@@ -74,7 +74,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
({ ...<tp:dbus-ref namespace='imt1.Channel'>ChannelType</tp:dbus-ref>:
...<tp:dbus-ref namespace='imt1.Channel.Type'>Text</tp:dbus-ref>,<br/>
   ...<tp:dbus-ref namespace='imt1.Channel'>TargetHandleType</tp:dbus-ref>:
<tp:value-ref type="Handle_Type">Contact</tp:value-ref>,<br/>
<tp:value-ref type="Entity_Type">Contact</tp:value-ref>,<br/>
 },<br/>
 [ ...<tp:dbus-ref namespace='imt1.Channel'>TargetHandle</tp:dbus-ref>,
...<tp:dbus-ref namespace='imt1.Channel'>TargetID</tp:dbus-ref> ]),<br/>
......@@ -82,7 +82,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
({ ...<tp:dbus-ref namespace='imt1.Channel'>ChannelType</tp:dbus-ref>:
...<tp:dbus-ref namespace='imt1.Channel.Type'>Text</tp:dbus-ref>,<br/>
   ...<tp:dbus-ref namespace='imt1.Channel'>TargetHandleType</tp:dbus-ref>:
<tp:value-ref type="Handle_Type">Contact</tp:value-ref>,<br/>
<tp:value-ref type="Entity_Type">Contact</tp:value-ref>,<br/>
   ...<tp:member-ref>SMSChannel</tp:member-ref>: True,<br/>
 },<br/>
 [ ...<tp:dbus-ref namespace='imt1.Channel'>TargetHandle</tp:dbus-ref>,
......@@ -152,7 +152,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
<blockquote><pre>{
Channel.Type: Channel.Type.Text,
Channel.TargetHandleType: Handle_Type_Contact,
Channel.TargetHandleType: Entity_Type_Contact,
Channel.TargetID: escher.cat,
Channel.Interface.SMS.SMSChannel: True,
}</pre></blockquote>
......
......@@ -33,7 +33,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
type. A tube channel contains exactly one tube; if you need several
tubes, you have to create several tube channels.</p>
<p>Tube channels can be requested for <tp:type>Handle_Type</tp:type>
<p>Tube channels can be requested for <tp:type>Entity_Type</tp:type>
Contact (for 1-1 communication) or Room (to communicate with others in
the room simultaneously).</p>
</tp:docstring>
......
......@@ -42,7 +42,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
namespace='imt1.Channel'>ChannelType</tp:dbus-ref> fixed to this
interface,
<tp:dbus-ref namespace='imt1.Channel'>TargetHandleType</tp:dbus-ref>
fixed to Handle_Type_None, and no other fixed properties. That requestable
fixed to Entity_Type_None, and no other fixed properties. That requestable
channel class MAY also have the Server and Limit properties in its
list of allowed properties, depending on the protocol.</p>
......
......@@ -36,7 +36,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
on a bus, or all participants are expected to export those
objects/interfaces.</p>
<p>In a multi-user context (Handle_Type_Room) the tube behaves
<p>In a multi-user context (Entity_Type_Room) the tube behaves
like the D-Bus bus daemon, so participants can send each other
private messages, or can send broadcast messages which are
received by everyone in the tube (including themselves).
......@@ -45,7 +45,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
sender unique name, and SHOULD attempt to avoid participants
receiving messages not intended for them.</p>
<p>In a 1-1 context (Handle_Type_Contact) the tube behaves like
<p>In a 1-1 context (Entity_Type_Contact) the tube behaves like
a peer-to-peer D-Bus connection - arbitrary D-Bus messages with
any sender and/or destination can be sent by each participant,
and each participant receives all messages sent by the other
......@@ -110,7 +110,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
<signal name="DBusNamesChanged" tp:name-for-bindings="DBus_Names_Changed">
<tp:docstring>
Emitted on a multi-user (i.e. Handle_Type_Room) D-Bus tube when a
Emitted on a multi-user (i.e. Entity_Type_Room) D-Bus tube when a
participant opens or closes the tube. This provides change
notification for the <tp:member-ref>DBusNames</tp:member-ref> property.
</tp:docstring>
......@@ -146,9 +146,9 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
<property name="DBusNames" tp:name-for-bindings="DBus_Names"
access="read" type="a{us}" tp:type="DBus_Tube_Participants">
<tp:docstring>
For a multi-user (i.e. Handle_Type_Room) D-Bus tube, a mapping
For a multi-user (i.e. Entity_Type_Room) D-Bus tube, a mapping
between contact handles and their unique bus names on this tube.
For a peer-to-peer (i.e. Handle_Type_Contact) D-Bus tube, the empty
For a peer-to-peer (i.e. Entity_Type_Contact) D-Bus tube, the empty
dictionary. Change notification is via
<tp:member-ref>DBusNamesChanged</tp:member-ref>.
</tp:docstring>
......
......@@ -1431,7 +1431,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<p>Simple one-to-one chats (such as streams of private messages in
XMPP or IRC) should be represented by a Text channel whose
<tp:dbus-ref namespace="imt1.Channel">TargetHandleType</tp:dbus-ref>
is <tp:value-ref type="Handle_Type">Contact</tp:value-ref>. The
is <tp:value-ref type="Entity_Type">Contact</tp:value-ref>. The
expected way to request such a channel is to set the <tp:dbus-ref
namespace='imt1.Channel'>ChannelType</tp:dbus-ref>, <tp:dbus-ref
namespace='imt1.Channel'>TargetHandleType</tp:dbus-ref>,
......@@ -1445,7 +1445,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
(IRC channels, Jabber MUCs) are expected to be represented by Text
channels with <tp:dbus-ref
namespace="imt1.Channel">TargetHandleType</tp:dbus-ref> =
<tp:value-ref type="Handle_Type">Room</tp:value-ref> and the
<tp:value-ref type="Entity_Type">Room</tp:value-ref> and the
<tp:dbus-ref namespace="imt1.Channel.Interface">Group1</tp:dbus-ref>
interface. In protocols where a chatroom can be used as a continuation
of one or more one-to-one chats, these channels should also have the
......@@ -1457,7 +1457,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
three or more participants) are expected to be represented by Text
channels with <tp:dbus-ref
namespace="imt1.Channel">TargetHandleType</tp:dbus-ref> = <tp:value-ref
type="Handle_Type">None</tp:value-ref> (and hence <tp:dbus-ref
type="Entity_Type">None</tp:value-ref> (and hence <tp:dbus-ref
namespace="imt1.Channel">TargetHandle</tp:dbus-ref> = 0),
<tp:dbus-ref namespace="imt1.Channel.Interface">Group1</tp:dbus-ref>
interface, and optionally the
......@@ -1469,7 +1469,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
more members can be invited, the initial one-to-one conversation
SHOULD be represented with <tp:dbus-ref
namespace="imt1.Channel">TargetHandleType</tp:dbus-ref> =
<tp:value-ref type="Handle_Type">Contact</tp:value-ref>. If a third
<tp:value-ref type="Entity_Type">Contact</tp:value-ref>. If a third
participant
joins or is invited, this SHOULD be represented by signalling
a new <tp:dbus-ref
......
......@@ -148,7 +148,7 @@ USA.</p>
<tp:added version="0.19.2"/>
</property>
<tp:enum name="Handle_Type" type="u">
<tp:enum name="Entity_Type" type="u">
<tp:enumvalue suffix="None" value="0">
<tp:docstring>
A "null" handle type used to indicate the absence of a handle.
......@@ -176,13 +176,13 @@ USA.</p>
<tp:simple-type name="Contact_Handle" type="u"
array-name="Contact_Handle_List">
<tp:docstring>An unsigned 32-bit integer representing a handle of type
Handle_Type_Contact</tp:docstring>
Entity_Type_Contact</tp:docstring>
</tp:simple-type>
<tp:simple-type name="Room_Handle" type="u"
array-name="Room_Handle_List">
<tp:docstring>An unsigned 32-bit integer representing a handle of type
Handle_Type_Room</tp:docstring>
Entity_Type_Room</tp:docstring>
</tp:simple-type>
<tp:enum name="Connection_Status" plural="Connection_Statuses" type="u">
......@@ -950,7 +950,7 @@ USA.</p>
<tp:rationale>
<p>For instance, if
TargetHandleType takes a value that is not Handle_Type_None,
TargetHandleType takes a value that is not Entity_Type_None,
one or the other of TargetHandle and TargetID is required.
Clients are expected to understand the documented relationship
between the properties, so we do not have separate arrays
......
......@@ -213,7 +213,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
RequestableChannelClasses and contact capabilities.</p>
</tp:rationale>
<p>Channel classes with target handle type Handle_Type_Contact
<p>Channel classes with target handle type Entity_Type_Contact
indicate that a request that matches the channel class, and also
either has the contact's handle as <tp:dbus-ref
namespace="im.telepathy.v1.Channel"
......@@ -230,8 +230,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
capabilities with the same code.</p>
</tp:rationale>
<p>Channel classes with target handle type Handle_Type_Room or
Handle_Type_None indicate that if a channel matching the channel
<p>Channel classes with target handle type Entity_Type_Room or
Entity_Type_None indicate that if a channel matching the channel
class is created, then inviting the contact to that channel
can be expected to succeed.</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