Bug 30281 - Account::haveConnection() and ::connectionStatus() are poorly documented
Summary: Account::haveConnection() and ::connectionStatus() are poorly documented
Status: RESOLVED WONTFIX
Alias: None
Product: Telepathy
Classification: Unclassified
Component: tp-qt (show other bugs)
Version: git master
Hardware: Other All
: medium normal
Assignee: Telepathy bugs list
QA Contact: Telepathy bugs list
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2010-09-20 06:49 UTC by Will Thompson
Modified: 2016-12-14 07:30 UTC (History)
0 users

See Also:
i915 platform:
i915 features:


Attachments

Description Will Thompson 2010-09-20 06:49:00 UTC
The spec's definition of <http://telepathy.freedesktop.org/spec/Account.html#org.freedesktop.Telepathy.Account.ConnectionStatus> is pretty clear about what its value will be in different states. TpQt4's documentation is not. It's not obvious to an API user which method they should use.

(I don't really see the point of haveConnection(); is it any easier than checking if connection() returns non-0?)
Comment 1 Olli Salli 2010-10-04 10:44:17 UTC
Before the "industrialization" (factories) work, the first call to connection() after haveConnection had cycled from false to true did expensive initialization constructing the actual proxy etc. Therefore it made sense to have a separate checker. You're right however that it doesn't really make sense anymore - and we have plans to drop it in the API/ABI break (and have just a connectionChanged instead).

++ for suggestion to improve the docs... Will do at ~some point~ in the future.
Comment 2 Olli Salli 2010-11-16 06:58:13 UTC
0.5.0 removes haveConnection() and haveConnectionChanged() completely. The documentation issues still stands, however...
Comment 3 Alexandr Akulich 2016-12-14 07:30:49 UTC
As there is not such methods for a very long time, we have no any reason to document them.


Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.