diff options
| author | Simon McVittie <simon.mcvittie@collabora.co.uk> | 2013-10-28 14:51:55 +0000 |
|---|---|---|
| committer | Simon McVittie <simon.mcvittie@collabora.co.uk> | 2013-11-11 16:49:09 +0000 |
| commit | ccd7aed489d5e3263f0fa4c2f0af4141057aa7dd (patch) | |
| tree | 76fa75ccbcd9e33e592bc07e02793fd3032306ce | |
| parent | 1c491dae9d8f6a90b4d1398dfc8914d8f4ff20a7 (diff) | |
TpPresenceMixin: deprecate optional arguments other than "message"
Our D-Bus API no longer supports anything else.
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=71048
Reviewed-by: Guillaume Desmottes <guillaume.desmottes@collabora.co.uk>
| -rw-r--r-- | telepathy-glib/presence-mixin.c | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/telepathy-glib/presence-mixin.c b/telepathy-glib/presence-mixin.c index e954b47ff..141dda8cf 100644 --- a/telepathy-glib/presence-mixin.c +++ b/telepathy-glib/presence-mixin.c @@ -131,7 +131,10 @@ * @optional_arguments: An array of #TpPresenceStatusOptionalArgumentSpec * structures representing the optional arguments for this status, terminated * by a NULL name. If there are no optional arguments for a status, this can - * be NULL. + * be NULL. In modern Telepathy connection managers, the only optional + * argument should be a string (type "s") named "message" on statuses + * that have an optional human-readable message. All other optional arguments + * are deprecated. * * Structure specifying a supported presence status. * @@ -153,9 +156,13 @@ * In addition to the fields documented here, there are two gpointer fields * which must currently be %NULL. A meaning may be defined for these in a * future version of telepathy-glib. + * + * In modern Telepathy connection managers, the only optional + * argument should be a %G_TYPE_STRING named "message", on statuses + * that have an optional human-readable message. All other optional arguments + * are deprecated. */ - /** * TpPresenceMixinStatusAvailableFunc: * @obj: An instance of a #TpBaseConnection subclass implementing the presence @@ -333,6 +340,11 @@ deep_copy_hashtable (GHashTable *hash_table) * Construct a presence status structure. You should free the returned * structure with #tp_presence_status_free. * + * In modern Telepathy connection managers, the only optional + * argument should be a %G_TYPE_STRING named "message", on statuses + * that have an optional human-readable message. All other optional arguments + * are deprecated. + * * Returns: A pointer to the newly allocated presence status structure. */ TpPresenceStatus * |