summaryrefslogtreecommitdiff
path: root/addressbook/libebook/e-book-client-view.c
diff options
context:
space:
mode:
Diffstat (limited to 'addressbook/libebook/e-book-client-view.c')
-rw-r--r--addressbook/libebook/e-book-client-view.c21
1 files changed, 13 insertions, 8 deletions
diff --git a/addressbook/libebook/e-book-client-view.c b/addressbook/libebook/e-book-client-view.c
index 28ecd891a..8b99cf26d 100644
--- a/addressbook/libebook/e-book-client-view.c
+++ b/addressbook/libebook/e-book-client-view.c
@@ -249,19 +249,24 @@ e_book_client_view_stop (EBookClientView *view, GError **error)
}
/**
- * e_book_client_view_set_restriction:
+ * e_book_client_view_set_fields_of_interest:
* @view: An #EBookClientView object
- * @only_fields: List of field names to restrict result on
+ * @fields_of_interest: List of field names in which the client is interested
* @error: A #GError
*
* Client can instruct server to which fields it is interested in only, thus
* the server can return less data over the wire. The server can still return
* complete objects, this is just a hint to it that the listed fields will
- * be used only. The UID field is returned always. Initial views has no restriction,
- * and using %NULL for @only_fields will unset any previous changes.
+ * be used only. The UID field is returned always. Initial views has no fields
+ * of interest and using %NULL for @fields_of_interest will unset any previous
+ * changes.
+ *
+ * Some backends can use summary information of its cache to create artifical
+ * objects, which will omit stored object parsing. If this cannot be done then
+ * it will simply return object as is stored in the cache.
**/
void
-e_book_client_view_set_restriction (EBookClientView *view, const GSList *only_fields, GError **error)
+e_book_client_view_set_fields_of_interest (EBookClientView *view, const GSList *fields_of_interest, GError **error)
{
EBookClientViewPrivate *priv;
@@ -274,13 +279,13 @@ e_book_client_view_set_restriction (EBookClientView *view, const GSList *only_fi
GError *local_error = NULL;
gchar **strv;
- strv = e_client_util_slist_to_strv (only_fields);
- e_gdbus_book_view_call_set_restriction_sync (priv->gdbus_bookview, (const gchar * const *) strv, NULL, &local_error);
+ strv = e_client_util_slist_to_strv (fields_of_interest);
+ e_gdbus_book_view_call_set_fields_of_interest_sync (priv->gdbus_bookview, (const gchar * const *) strv, NULL, &local_error);
g_strfreev (strv);
e_client_util_unwrap_dbus_error (local_error, error, NULL, 0, 0, FALSE);
} else {
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_DBUS_ERROR, _("Cannot set restriction, D-Bus proxy gone"));
+ g_set_error (error, G_IO_ERROR, G_IO_ERROR_DBUS_ERROR, _("Cannot set fields of interest, D-Bus proxy gone"));
}
}