summaryrefslogtreecommitdiff
path: root/spec/Connection_Interface_Presence.xml
diff options
context:
space:
mode:
authorSjoerd Simons <sjoerd@luon.net>2008-07-17 15:45:11 +0000
committerSjoerd Simons <sjoerd@luon.net>2008-07-17 15:45:11 +0000
commit48da44430e0cce8a4507908362fae6f7b7f5034e (patch)
treeb1c2ad89c2531c84003eba178ae2f7798aee22ff /spec/Connection_Interface_Presence.xml
parent2c361a1e78947f773eb43c58e19c31e067eecbea (diff)
downloadtelepathy-glib-48da44430e0cce8a4507908362fae6f7b7f5034e.tar.gz
Update to tp-spec head
20080717154511-93b9a-116972b240dc055f91ef95b430c427cb4e1e22a1.gz
Diffstat (limited to 'spec/Connection_Interface_Presence.xml')
-rw-r--r--spec/Connection_Interface_Presence.xml51
1 files changed, 34 insertions, 17 deletions
diff --git a/spec/Connection_Interface_Presence.xml b/spec/Connection_Interface_Presence.xml
index 9527b6143..489ac238a 100644
--- a/spec/Connection_Interface_Presence.xml
+++ b/spec/Connection_Interface_Presence.xml
@@ -258,10 +258,17 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
</tp:possible-errors>
</method>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>This interface is for services which have a concept of presence which can
- be published for yourself and monitored on your contacts. Telepathy's
- definition of presence is based on that used by the Galago project
- (see http://www.galago-project.org/).</p>
+ <p>This interface will become deprecated in future versions. New
+ client implementations MAY use
+ org.freedesktop.Telepathy.Connection.Interface.SimplePresence
+ instead; new connection managers SHOULD implement both
+ Presence and SimplePresence.</p>
+
+ <p>This interface is for services which have a concept of presence which
+ can be published for yourself and monitored on your contacts.
+ Telepathy's definition of presence is based on that used by
+ <a href="http://www.galago-project.org/">the Galago
+ project</a>.</p>
<p>Presence on an individual (yourself or one of your contacts) is modelled as
a last activity time along with a set of zero or more statuses, each of
@@ -276,14 +283,20 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
choices:</p>
<ul>
- <li>available</li>
- <li>away</li>
- <li>brb (Be Right Back)</li>
- <li>busy</li>
- <li>dnd (Do Not Disturb),</li>
- <li>xa (Extended Away)</li>
- <li>hidden (aka Invisible)</li>
- <li>offline</li>
+ <li>available (corresponding to Connection_Presence_Type_Available)</li>
+ <li>away (corresponding to Connection_Presence_Type_Away)</li>
+ <li>brb (Be Right Back) (corresponding to
+ Connection_Presence_Type_Away, but more specific)</li>
+ <li>busy (corresponding to Connection_Presence_Type_Busy)</li>
+ <li>dnd (Do Not Disturb) (corresponding to
+ Connection_Presence_Type_Busy, but more specific)</li>
+ <li>xa (Extended Away) (corresponding to
+ Connection_Presence_Type_Extended_Away)</li>
+ <li>hidden (aka Invisible) (corresponding to
+ Connection_Presence_Type_Hidden)</li>
+ <li>offline (corresponding to Connection_Presence_Type_Offline)</li>
+ <li>unknown (corresponding to Connection_Presence_Type_Unknown)</li>
+ <li>error (corresponding to Connection_Presence_Type_Error)</li>
</ul>
<p>As well as these well-known status identifiers, every status also has a
@@ -317,7 +330,9 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<tp:enum name="Connection_Presence_Type" type="u">
<tp:enumvalue suffix="Unset" value="0">
<tp:docstring>
- An invalid presence type used as a null value
+ An invalid presence type used as a null value. This value MUST NOT
+ appear in the result of GetStatuses, or in the Statuses property
+ of the SimplePresence interface.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Offline" value="1">
@@ -352,15 +367,17 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Unknown" value="7">
- <tp:added version="0.17.unreleased"/>
+ <tp:added version="0.17.UNRELEASED"/>
<tp:docstring>
- Unknown, unable to determine presence.
+ Unknown, unable to determine presence for this contact, for example
+ if the protocol only allows presence of subscribed contacts.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Error" value="8">
- <tp:added version="0.17.unreleased"/>
+ <tp:added version="0.17.UNRELEASED"/>
<tp:docstring>
- Error, error while trying to determine presence.
+ Error, an error occurred while trying to determine presence. The
+ message, if set, is an error from the server.
</tp:docstring>
</tp:enumvalue>
</tp:enum>