Added new dbus methods to emit some signals.
[modest] / libmodest-dbus-client / src / libmodest-dbus-client.h
index 03ac5d8..33c7c56 100644 (file)
@@ -87,15 +87,53 @@ gboolean  libmodest_dbus_client_open_message (osso_context_t *osso_context,
  * libmodest_dbus_client_send_and_receive:
  * @osso_context: a valid osso_context instance
  *
- * send/receive messages
+ * send/receive messages automatically for all accounts. This is equivalent 
+ * to the call
+ * libmodest_dbus_client_send_and_receive_full (@osso_context, %NULL, %TRUE)
  *
- * Returns: TRUE upon success, FALSE otherwise
+ * Returns: %TRUE upon success, %FALSE otherwise
  */
 gboolean libmodest_dbus_client_send_and_receive (osso_context_t *osso_context);
 
 
 
 /**
+ * libmodest_dbus_client_send_and_receive_full:
+ * @osso_context: a valid osso_context instance
+ * @account: the account name, or %NULL to do a send receive on all accounts.
+ * @manual: a #gboolean
+ *
+ * send/receive messages. If @manual is %TRUE, the send receive request
+ * will start immediately. If @manual if %FALSE, it may wait for IP heartbeat
+ * if enabled.
+ *
+ * If Modest is built without heartbeat support, then the result of the call
+ * will be the same independently of @manual value (always immediate start).
+ *
+ * The call will apply to @account only, unless @account is %NULL, that means
+ * send receive will be performed on all accounts.
+ *
+ * Returns: %TRUE upon success, %FALSE otherwise
+ */
+gboolean libmodest_dbus_client_send_and_receive_full (osso_context_t *osso_context,
+                                                     const gchar *account,
+                                                     gboolean manual);
+
+/**
+ * libmodest_dbus_client_update_folder_counts:
+ * @osso_context: a valid osso_context instance
+ * @account: the account name
+ *
+ * updates folder counts of @account.
+ *
+ * Returns: %TRUE upon success, %FALSE otherwise
+ */
+gboolean libmodest_dbus_client_update_folder_counts (osso_context_t *osso_context,
+                                                    const gchar *account);
+
+
+
+/**
  * libmodest_dbus_client_open_default_inbox:
  * @osso_context: a valid osso_context instance
  *
@@ -106,24 +144,43 @@ gboolean libmodest_dbus_client_send_and_receive (osso_context_t *osso_context);
 gboolean libmodest_dbus_client_open_default_inbox (osso_context_t *osso_context);
 
 /**
- * libmodest_dbus_client_open_account:
+ * libmodest_dbus_client_open_edit_accounts_dialog
  * @osso_context: a valid osso_context instance
- * @account_id: the unique ID of one account
  *
- * Starts Modest showing the account that is specified as
- * parametter. Note that this only makes sense when the folder view is
- * showing just one account
+ * Starts Modest showing the edit accounts dialog on top of the
+ * initial window. If there is no account then the new account dialog
+ * is automatically launched
  *
  * Returns: TRUE upon success, FALSE otherwise
  */
-gboolean  libmodest_dbus_client_open_account (osso_context_t *osso_context,
-                                             const gchar *account_id);
+gboolean  libmodest_dbus_client_open_edit_accounts_dialog (osso_context_t *osso_context);
 
+/**
+ * libmodest_dbus_client_open_default_inbox:
+ * @osso_context: a valid osso_context instance
+ *
+ * start modest, and open the inbox for the default account
+ *
+ * Returns: TRUE upon success, FALSE otherwise
+ */
+gboolean libmodest_dbus_client_open_default_inbox (osso_context_t *osso_context);
+
+/**
+ * libmodest_dbus_client_open_account:
+ * @osso_context: a valid osso_context instance
+ * @account_id: the id of the account to open
+ *
+ * Shows the folders of a given account
+ *
+ * Returns:  TRUE upon success, FALSE otherwise
+ **/
+gboolean libmodest_dbus_client_open_account (osso_context_t *osso_context,
+                                            const gchar *account_id);
 
 /*
  * below: functions specific to osso-global-search; not useful for other clients.
- * 
- */ 
+ *
+ */
 
 typedef enum {