[next] telepathy-glib: TpPresenceMixin: deprecate optional arguments other than "message"

[Simon McVittie]

Module: telepathy-glib
Branch: next
Commit: ccd7aed489d5e3263f0fa4c2f0af4141057aa7dd
URL:    http://cgit.freedesktop.org/telepathy/telepathy-glib/commit/?id=ccd7aed489d5e3263f0fa4c2f0af4141057aa7dd

Author: Simon McVittie <simon.mcvittie at collabora.co.uk>
Date:   Mon Oct 28 14:51:55 2013 +0000

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 at collabora.co.uk>

---

 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 e954b47..141dda8 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 *