set_alphabetic_index_sync
Description:
Sets the cursor to point to an Alphabetic Index.
After setting the alphabetic index, for example the index for letter 'E', then further calls to step will return results starting with the letter 'E' (or results starting with the last result in 'D' when navigating through cursor results in reverse).
The passed index must be a valid index into the alphabet parameters returned by get_alphabet.
If this method is called from the same thread context in which the cursor was created, then the updates to the position property are guaranteed to be delivered synchronously upon successful completion of moving the cursor. Otherwise, notifications will be delivered asynchronously in the cursor's original thread context.
If this method completes with an OUT_OF_SYNC error, it is an indication that the addressbook has been set into a new locale and it would be unsafe to set the alphabetic index at this time. If you receive an out of sync error from this method, then you should wait until an alphabet property change notification is delivered and then proceed to load the new alphabet before trying to set any alphabetic index.
Parameters:
| this | |
| index |
the alphabetic index |
| cancellable |
a Cancellable to optionally cancel this operation while in progress |
Returns:
|
|