diff options
| author | Simon McVittie <simon.mcvittie@collabora.co.uk> | 2010-03-03 20:05:53 +0000 |
|---|---|---|
| committer | Simon McVittie <simon.mcvittie@collabora.co.uk> | 2010-03-03 20:05:53 +0000 |
| commit | 8af2ff1ace5074b71a1a89f052d0d4a62f99fbc9 (patch) | |
| tree | 145fb0d6f053e47dbc93f2a914a4cee177dc6ca3 /telepathy-glib/account.c | |
| parent | 244b4ac10c2fbae17b896a0b38e1e488044d35fb (diff) | |
| download | telepathy-glib-8af2ff1ace5074b71a1a89f052d0d4a62f99fbc9.tar.gz | |
tp_account_get_parameters: explain what's in the GHashTable
It's not immediately obvious that the values are GValues.
Diffstat (limited to 'telepathy-glib/account.c')
| -rw-r--r-- | telepathy-glib/account.c | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/telepathy-glib/account.c b/telepathy-glib/account.c index f598d5349..812d87a7a 100644 --- a/telepathy-glib/account.c +++ b/telepathy-glib/account.c @@ -1537,7 +1537,18 @@ tp_account_get_icon_name (TpAccount *account) * tp_account_get_parameters: * @account: a #TpAccount * - * <!-- --> + * Returns the parameters of the account, in a hash table where each string + * is the parameter name (account, password, require-encryption etc.), and + * each value is a #GValue. Using the tp_asv_get family of functions + * (tp_asv_get_uint32(), tp_asv_dup_string() etc.) to access the parameters is + * recommended. + * + * The allowed parameters depend on the connection manager, and can be found + * via tp_connection_manager_get_protocol() and + * tp_connection_manager_protocol_get_param(). Well-known parameters are + * listed + * <ulink url="http://telepathy.freedesktop.org/spec/org.freedesktop.Telepathy.ConnectionManager.html#org.freedesktop.Telepathy.ConnectionManager.RequestConnection">in + * the Telepathy D-Bus Interface Specification</ulink>. * * Returns: the hash table of parameters on @account * |