[Galago-commits] r2568 - in branches/libgalago/protocol-cleanup: . docs/protocol

[galago-commits at freedesktop.org]

Author: chipx86
Date: 2006-02-07 10:15:07 -0800 (Tue, 07 Feb 2006)
New Revision: 2568

Modified:
   branches/libgalago/protocol-cleanup/ChangeLog
   branches/libgalago/protocol-cleanup/docs/protocol/protocol.hh
Log:
Update the protocol documentation.


Modified: branches/libgalago/protocol-cleanup/ChangeLog
===================================================================
--- branches/libgalago/protocol-cleanup/ChangeLog	2006-02-07 10:03:31 UTC (rev 2567)
+++ branches/libgalago/protocol-cleanup/ChangeLog	2006-02-07 18:15:07 UTC (rev 2568)
@@ -1,3 +1,8 @@
+Tue Feb 07 10:14:48 PST 2006  Christian Hammond <chipx86 at chipx86.com>
+
+	* docs/protocol/protocol.hh:
+	  - Update the protocol documentation.
+
 Tue Feb 07 02:02:46 PST 2006  Christian Hammond <chipx86 at chipx86.com>
 
 	* libgalago/galago-account.c:

Modified: branches/libgalago/protocol-cleanup/docs/protocol/protocol.hh
===================================================================
--- branches/libgalago/protocol-cleanup/docs/protocol/protocol.hh	2006-02-07 10:03:31 UTC (rev 2567)
+++ branches/libgalago/protocol-cleanup/docs/protocol/protocol.hh	2006-02-07 18:15:07 UTC (rev 2568)
@@ -84,13 +84,25 @@
 	uint32 GetContactsCount();
 
 	/**
-	 * Sets the account's presence.
+	 * Creates an account's presence.
 	 *
+	 * An account only has one presence. If this is called multiple times,
+	 * the first presence object's path will be returned.
+	 *
 	 * @param presence The presence to set.
+	 *
+	 * @return The object path of the presence.
 	 */
-	void SetPresence(Presence presence);
+	string SetPresence();
 
 	/**
+	 * Destroys the account's presence.
+	 *
+	 * This removes the presence from the account.
+	 */
+	void DestroyPresence();
+
+	/**
 	 * Returns the account's presence.
 	 *
 	 * @return The presence, or org.freedesktop.Galago.Error.ObjectNotFound
@@ -100,11 +112,6 @@
 	Presence GetPresence();
 
 	/**
-	 * Unsets the account's presence.
-	 */
-	void UnsetPresence();
-
-	/**
 	 * Sets the account's avatar.
 	 *
 	 * @param avatar The avatar to set.
@@ -225,16 +232,13 @@
 	void RemoveService(Service service);
 
 	/**
-	 * Clears all services from Galago's services cache.
-	 */
-	void ClearServices(); /* DBUS_HANDLER_RESULT_NOT_YET_HANDLED */
-
-	/**
 	 * Adds a person to Galago's person cache.
 	 *
 	 * @param person The person to add.
+	 *
+	 * @return The person's new object path.
 	 */
-	void AddPerson(Person person);
+	string AddPerson(Person person);
 
 	/**
 	 * Removes a person from Galago's person cache.
@@ -244,11 +248,6 @@
 	void RemovePerson(Person person);
 
 	/**
-	 * Clears all people from Galago's person cache.
-	 */
-	void ClearPeople();
-
-	/**
 	 * Registers a Galago connection to the daemon.
 	 *
 	 * @param appName      The ID name used for this connection. It's often
@@ -516,8 +515,10 @@
 	 * Adds a single status to a presence.
 	 *
 	 * @param status The status.
+	 *
+	 * @return The status's new object path.
 	 */
-	void AddStatus(Status status);
+	string AddStatus(Status status);
 
 	/**
 	 * Removes a single status from a presence.