1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
|
<?xml version="1.0" ?>
<node name="/Connection_Interface_Simple_Presence" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<tp:copyright> Copyright (C) 2005-2008 Collabora Limited </tp:copyright>
<tp:copyright> Copyright (C) 2005, 2006 Nokia Corporation </tp:copyright>
<tp:copyright> Copyright (C) 2006 INdT </tp:copyright>
<tp:license xmlns="http://www.w3.org/1999/xhtml">
<p>This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or (at
your option) any later version.</p>
<p>This library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
General Public License for more details.</p>
<p>You should have received a copy of the GNU Lesser General Public License
along with this library; if not, write to the Free Software Foundation,
Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p>
</tp:license>
<interface name="org.freedesktop.Telepathy.Connection.Interface.SimplePresence">
<tp:requires interface="org.freedesktop.Telepathy.Connection"/>
<tp:struct name="Simple_Presence">
<tp:docstring>
A struct representing the presence of a contact.
</tp:docstring>
<tp:member type="u" tp:type="Connection_Presence_Type" name="Type">
<tp:docstring>
The presence type, e.g. Connection_Presence_Type_Away.
</tp:docstring>
</tp:member>
<tp:member type="s" name="Status">
<tp:docstring>
The string identifier of the status, e.g. "brb", as defined in the
<tp:member-ref>Statuses</tp:member-ref> property.
</tp:docstring>
</tp:member>
<tp:member type="s" name="Status_Message">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>The user-defined status message, e.g. "Back soon!".</p>
<p>Clients SHOULD set the status message for the local
user to the empty string, unless the user has actually provided
a specific message (i.e. one that conveys more information than the
Status).</p>
<p>User interfaces SHOULD regard an empty status message as unset,
and MAY replace it with a localized string corresponding to the
Status or Type.</p>
<tp:rationale>
Use case: Daf sets his status in Empathy by choosing the Welsh
translation of "Available" from a menu.
It is more informative for his English-speaking colleagues
to see the English translation of "Available" (as localized
by their own clients) than to see "Ar Gael" (which they don't
understand anyway).
</tp:rationale>
</tp:docstring>
</tp:member>
</tp:struct>
<tp:mapping name="Simple_Contact_Presences">
<tp:docstring>
Mapping returned by <tp:member-ref>GetPresences</tp:member-ref>
and signalled by <tp:member-ref>PresencesChanged</tp:member-ref>,
indicating the presence of a number of contacts.
</tp:docstring>
<tp:member type="u" tp:type="Contact_Handle" name="Contact">
<tp:docstring>
A contact
</tp:docstring>
</tp:member>
<tp:member type="(uss)" tp:type="Simple_Presence" name="Presence">
<tp:docstring>
The contact's presence
</tp:docstring>
</tp:member>
</tp:mapping>
<tp:struct name="Simple_Status_Spec">
<tp:docstring>
A struct containing information about a status.
</tp:docstring>
<tp:member type="u" tp:type="Connection_Presence_Type" name="Type">
<tp:docstring>
The type of a presence. This SHOULD NOT be used as a way to set
statuses that the client does not recognise (as explained in
<tp:member-ref>SetPresence</tp:member-ref>), but MAY be used to check
that the client's assumptions about a particular status name
match the connection manager's.
</tp:docstring>
</tp:member>
<tp:member type="b" name="May_Set_On_Self">
<tp:docstring>
If true, the user can set this status on themselves using
<tp:member-ref>SetPresence</tp:member-ref>.
</tp:docstring>
</tp:member>
<tp:member type="b" name="Can_Have_Message">
<tp:docstring>
If true, a non-empty message can be set for this status. Otherwise,
the empty string is the only acceptable message.
<tp:rationale>
On IRC you can be Away with a status message, but if you are
available you cannot set a status message.
</tp:rationale>
</tp:docstring>
</tp:member>
</tp:struct>
<tp:mapping name="Simple_Status_Spec_Map">
<tp:docstring>
A mapping describing possible statuses.
</tp:docstring>
<tp:member type="s" name="Identifier">
<tp:docstring>
The string identifier of this status.
</tp:docstring>
</tp:member>
<tp:member type="(ubb)" tp:type="Simple_Status_Spec" name="Spec">
<tp:docstring>
Details of this status.
</tp:docstring>
</tp:member>
</tp:mapping>
<method name="SetPresence" tp:name-for-bindings="Set_Presence">
<arg direction="in" name="Status" type="s">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>The string identifier of the desired status. Possible status
identifiers are defined in the
<tp:member-ref>Statuses</tp:member-ref> property.</p>
<p>Clients MUST NOT set a status whose string value they do not
recognise, even if its presence type in Statuses
matches what the user requested.</p>
<tp:rationale>
<p>Suppose a protocol has statuses that include 'phone' (of type
BUSY) and 'in-a-meeting' (of type BUSY), but there is no
generic 'busy' status.</p>
<p>If the user requests "Busy" status from a menu, a
client author might be tempted to pick an arbitrary status
that has type BUSY. However, on this protocol, neither of
the choices would be appropriate, and incorrect information
about the user would be conveyed.</p>
</tp:rationale>
<p>Statuses whose <tp:type>Connection_Presence_Type</tp:type>
is Offline, Error or Unknown MUST NOT be passed to this
function. Connection managers SHOULD reject these statuses.</p>
<tp:rationale>
<p>To go offline, call <tp:dbus-ref
namespace="org.freedesktop.Telepathy.Connection">Disconnect</tp:dbus-ref>
instead. The "error" and "unknown" statuses make no sense.</p>
</tp:rationale>
</tp:docstring>
</arg>
<arg direction="in" name="Status_Message" type="s">
<tp:docstring>
The status message associated with the current status.
</tp:docstring>
</arg>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Request that the presence status and status message are published for
the connection. Changes will be indicated by
<tp:member-ref>PresencesChanged</tp:member-ref>
signals being emitted.</p>
<p>This method may be called on a newly-created connection while it
is still in the DISCONNECTED state, to request that when the
connection connects, it will do so with the selected status.</p>
<p>In DISCONNECTED state the
<tp:member-ref>Statuses</tp:member-ref>
property will indicate which statuses are allowed to be set
while DISCONNECTED (none, if the Connection Manager doesn't allow
this). This value MUST NOT be cached, as the set of allowed
presences might change upon connecting.</p>
</tp:docstring>
<tp:possible-errors>
<tp:error name="org.freedesktop.Telepathy.Error.NetworkError"/>
<tp:error name="org.freedesktop.Telepathy.Error.InvalidArgument">
<tp:docstring>
Either the specified status is not supported, the specified
status cannot be set on the user themselves, or a non-empty
message was supplied for a status that does not
accept a message.
</tp:docstring>
</tp:error>
<tp:error name="org.freedesktop.Telepathy.Error.NotAvailable"/>
</tp:possible-errors>
</method>
<method name="GetPresences" tp:name-for-bindings="Get_Presences">
<arg direction="in" name="Contacts" type="au" tp:type="Contact_Handle[]">
<tp:docstring>
An array of the contacts whose presence should be obtained.
</tp:docstring>
</arg>
<arg direction="out" name="Presence" type="a{u(uss)}"
tp:type="Simple_Contact_Presences">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Presence information in the same format as for the
<tp:member-ref>PresencesChanged</tp:member-ref> signal.
The returned mapping MUST include an entry for each contact
in the method's argument.</p>
<p>The definition of the connection presence types Unknown
and Offline means that if a connection manager will return
Unknown for contacts not on the subscribe list, it MUST delay
the reply to this method call until it has found out which
contacts are, in fact, on the subscribe list.</p>
</tp:docstring>
</arg>
<tp:docstring>
Get presence previously emitted by
<tp:member-ref>PresencesChanged</tp:member-ref> for the given
contacts. Data is returned in the same structure as the
PresencesChanged signal; no additional network requests are made.
</tp:docstring>
<tp:possible-errors>
<tp:error name="org.freedesktop.Telepathy.Error.Disconnected"/>
<tp:error name="org.freedesktop.Telepathy.Error.InvalidHandle"/>
<tp:error name="org.freedesktop.Telepathy.Error.NetworkError">
<tp:docstring>
While discovering the subscribe list in order to distinguish
between Unknown and Offline statuses, a network error occurred.
</tp:docstring>
</tp:error>
<tp:error name="org.freedesktop.Telepathy.Error.NotAvailable"/>
</tp:possible-errors>
</method>
<property name="Statuses" tp:name-for-bindings="Statuses" access="read"
type="a{s(ubb)}" tp:type="Simple_Status_Spec_Map">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>A dictionary where the keys are the presence statuses that are
available on this connection, and the values are the corresponding
presence types.</p>
<p>While the connection is in the DISCONNECTED state, it contains
the set of presence statuses allowed to be set before connecting.
The connection manager will attempt to set the appropriate status
when the connection becomes connected, but cannot necessarily
guarantee it. The available statuses cannot change until the
connection status changes, so there is no change notification.</p>
<p>While the connection is in the CONNECTED state, this property
contains the set of presence statuses which are actually available
on this protocol. This set is constant for the remaining lifetime
of the connection, so again, there is no change notification.</p>
<p>While the connection is in the CONNECTING state, the value of
this property is undefined and SHOULD NOT be used. It can change
at any time without notification (in particular, any cached values
from when the connection was in the DISCONNECTED or CONNECTING
state MUST NOT be assumed to still be correct when the state has
become CONNECTED).</p>
<p>This property MUST include the special statuses "unknown" and
"error" if and only if the connection manager can emit them
as a contact's status.</p>
<tp:rationale>
For instance, connection managers for local-xmpp (XEP-0174) would
omit "unknown" since there is no such concept.
</tp:rationale>
</tp:docstring>
</property>
<signal name="PresencesChanged" tp:name-for-bindings="Presences_Changed">
<arg name="Presence" type="a{u(uss)}" tp:type="Simple_Contact_Presences">
<tp:docstring>
A dictionary of contact handles mapped to the status,
presence type and status message.
</tp:docstring>
</arg>
<tp:docstring>
This signal should be emitted when your own presence has been changed,
or the presence of the member of any of the connection's channels has
been changed.
</tp:docstring>
</signal>
<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. This value MUST NOT
appear in the <tp:member-ref>Statuses</tp:member-ref> property,
or in the result of <tp:dbus-ref
namespace="org.freedesktop.Telepathy.Connection.Interface.Presence">GetStatuses</tp:dbus-ref>
on the deprecated <tp:dbus-ref
namespace="org.freedesktop.Telepathy.Connection.Interface">Presence</tp:dbus-ref>
interface.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Offline" value="1">
<tp:docstring>
Offline
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Available" value="2">
<tp:docstring>
Available
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Away" value="3">
<tp:docstring>
Away
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Extended_Away" value="4">
<tp:docstring>
Away for an extended time
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Hidden" value="5">
<tp:docstring>
Hidden (invisible)
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Busy" value="6">
<tp:added version="0.17.0"/>
<tp:docstring>
Busy, Do Not Disturb.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Unknown" value="7">
<tp:added version="0.17.8"/>
<tp:docstring>
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.8"/>
<tp:docstring>
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>
<tp:enum name="Access_Control_Type" type="u"
array-name="Access_Control_Type_List">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>A type for communication access control. These control
policies are used in
<tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection.Interface">CommunicationPolicy.DRAFT</tp:dbus-ref>
as well as most rich presence interfaces.</p>
<p>New interfaces should use this type, and NOT
<tp:type>Rich_Presence_Access_Control_Type</tp:type>.</p>
</tp:docstring>
<tp:enumvalue suffix="Whitelist" value="0">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Only allow contacts that are in a certain whitelist.</p>
<p>The associated variant
in <tp:type>Access_Control</tp:type> is a list of
<tp:type>Contact_Handle</tp:type> representing
the whitelist, with signature <code>au</code>.</p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Publish_List" value="1">
<tp:docstring>
Allow contacts in the user's 'publish' list. The associated
variant in <tp:type>Access_Control</tp:type> is ignored.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Group" value="2">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Only allow contacts that are in a certain group.</p>
<p>The associated variant in <tp:type>Access_Control</tp:type> is a
<tp:type>Group_Handle</tp:type> representing the permitted
group.</p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Open" value="3">
<tp:docstring>
Allow all contacts. The associated
variant in <tp:type>Access_Control</tp:type> is ignored.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Subscribe_Or_Publish_List" value="4">
<tp:docstring>
Allow all contacts in the user's 'subscribe' or 'publish'
list. The associated variant in <tp:type>Access_Control</tp:type> is
ignored.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Closed" value="5">
<tp:docstring>
Forbid all contacts. The associated variant in
<tp:type>Access_Control</tp:type> is ignored.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Not_Understood" value="6">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>The access control rule is too complex to be represented
in the current Telepathy API. The associated variant is
meaningless. Setting this mode is never valid; the
connection manager MUST raise an error if this is attempted.</p>
<tp:rationale>
XEP-0016 Privacy Lists can easily produce access control
mechanisms that can't be expressed in a simpler API. We
need to be able to at least indicate that fact.
</tp:rationale>
<p>The associated variant in <tp:type>Access_Control</tp:type> is
ignored.</p>
</tp:docstring>
</tp:enumvalue>
</tp:enum>
<tp:enum name="Rich_Presence_Access_Control_Type" type="u"
array-name="Rich_Presence_Access_Control_Type_List">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>A type of access control for Rich_Presence_Access_Control.
For most types, the exact access control is given by an associated
variant.</p>
<tp:rationale>
<p>These are the access control types from XMPP publish/subscribe
(XEP-0060).</p>
</tp:rationale>
<p><tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection.Interface">Location</tp:dbus-ref>
uses this for historical reasons, new interfaces will use
<tp:type>Access_Control_Type</tp:type>.</p>
</tp:docstring>
<tp:enumvalue suffix="Whitelist" value="0">
<tp:docstring>
The associated variant is a list of contacts (signature 'au',
Contact_Handle[]) who can see the extended presence information.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Publish_List" value="1">
<tp:docstring>
All contacts in the user's 'publish' contact list can see the
extended presence information. The associated variant is ignored.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Group" value="2">
<tp:docstring>
The associated variant is a handle of type Group (signature 'u',
Group_Handle) representing a group of contacts who can see the
extended presence information.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Open" value="3">
<tp:docstring>
Anyone with access to the service can see the extended presence
information.
</tp:docstring>
</tp:enumvalue>
</tp:enum>
<tp:struct name="Access_Control">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>An access control mode for extended presence items like geolocation.
This type isn't actually used by the SimplePresence interface, but
it's included here so it can be referenced by rich presence
interfaces.</p>
<p>New interfaces should use this type, and NOT
<tp:type>Rich_Presence_Access_Control</tp:type>.</p>
</tp:docstring>
<tp:member name="Type" type="u" tp:type="Access_Control_Type">
<tp:docstring>
The type of access control to apply.
</tp:docstring>
</tp:member>
<tp:member name="Detail" type="v">
<tp:docstring>
Any additional information required by the Type. The required
type and semantics are defined for each
<tp:type>Access_Control_Type</tp:type>.
</tp:docstring>
</tp:member>
</tp:struct>
<tp:struct name="Rich_Presence_Access_Control">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>An access control mode for extended presence items like geolocation.
This type isn't actually used by the SimplePresence interface, but
it's included here so it can be referenced by rich presence interfaces
such as <tp:dbus-ref
namespace="org.freedesktop.Telepathy.Connection.Interface">Location</tp:dbus-ref>.</p>
<p><tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection.Interface">Location</tp:dbus-ref>
uses this for historical reasons, new interfaces will use
<tp:type>Access_Control_Type</tp:type>.</p>
</tp:docstring>
<tp:member name="Type" type="u" tp:type="Rich_Presence_Access_Control_Type">
<tp:docstring>
The type of access control to apply.
</tp:docstring>
</tp:member>
<tp:member name="Detail" type="v">
<tp:docstring>
Any additional information required by the Type. The required
type and semantics are defined for each
<tp:type>Rich_Presence_Access_Control_Type</tp:type>.
</tp:docstring>
</tp:member>
</tp:struct>
<tp:contact-attribute name="presence"
type="(uss)" tp:type="Simple_Presence">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>The same struct that would be returned by
<tp:member-ref>GetPresences</tp:member-ref>
(always present with some value if information from the
SimplePresence interface was requested)</p>
</tp:docstring>
</tp:contact-attribute>
<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.</p>
<p>Presence on an individual (yourself or one of your contacts) is
modelled as a status and a status message. Valid statuses are defined
per connection, and a list of those that can be set on youself
can be obtained from the
<tp:member-ref>Statuses</tp:member-ref>
property.</p>
<p>Each status has an arbitrary string identifier which should have an
agreed meaning between the connection manager and any client which is
expected to make use of it. The following well-known values should be
used where possible to allow clients to identify common choices:</p>
<table>
<tr>
<th>status identifier</th>
<th>Connection_Presence_Type</th>
<th>comments</th>
</tr>
<tr>
<td>available</td>
<td>Connection_Presence_Type_Available</td>
<td></td>
</tr>
<tr>
<td>away</td>
<td>Connection_Presence_Type_Away</td>
<td></td>
</tr>
<tr>
<td>brb</td>
<td>Connection_Presence_Type_Away</td>
<td>Be Right Back (a more specific form of Away)</td>
</tr>
<tr>
<td>busy</td>
<td>Connection_Presence_Type_Busy</td>
<td></td>
</tr>
<tr><td>dnd</td>
<td>Connection_Presence_Type_Busy</td>
<td>Do Not Disturb (a more specific form of Busy)</td>
</tr>
<tr>
<td>xa</td>
<td>Connection_Presence_Type_Extended_Away</td>
<td>Extended Away</td>
</tr>
<tr>
<td>hidden</td>
<td>Connection_Presence_Type_Hidden</td>
<td>Also known as "Invisible" or "Appear Offline"</td>
</tr>
<tr>
<td>offline</td>
<td>Connection_Presence_Type_Offline</td>
<td></td>
</tr>
<tr>
<td>unknown</td>
<td>Connection_Presence_Type_Unknown</td>
<td>special, see below</td>
</tr>
<tr>
<td>error</td>
<td>Connection_Presence_Type_Error</td>
<td>special, see below</td>
</tr>
</table>
<p>As well as these well-known status identifiers, every status also has
a numerical type value chosen from
<tp:type>Connection_Presence_Type</tp:type> which can be
used by the client to classify even unknown statuses into different
fundamental types.</p>
<p>These numerical types exist so that even if a client does not
understand the string identifier being used, and hence cannot present
the presence to the user to set on themselves, it may display an
approximation of the presence if it is set on a contact.</p>
<p>As well as the normal status identifiers, there are two special ones
that may be present: 'unknown' with type Unknown and 'error' with type
Error. 'unknown' indicates that it is impossible to determine the
presence of a contact at this time, for example because it's not on the
'subscribe' list and the protocol only allows one to determine the
presence of contacts you're subscribed to. 'error' indicates that there
was a failure in determining the status of a contact.</p>
<p>If the connection has a 'subscribe' contact list,
<tp:member-ref>PresencesChanged</tp:member-ref>
signals should be emitted to indicate changes of contacts on this list,
and should also be emitted for changes in your own presence. Depending
on the protocol, the signal may also be emitted for others such as
people with whom you are communicating, and any user interface should
be updated accordingly.</p>
</tp:docstring>
</interface>
</node>
<!-- vim:set sw=2 sts=2 et ft=xml: -->
|