public static class ContactsContract.SearchSnippets extends Object
Contacts.CONTENT_FILTER_URI
explaining
why the filter matched the contact. This column will contain extracts from the contact's
constituent Data
items, formatted in a way that indicates the section of the
snippet that matched the filter.
The following example searches for all contacts that match the query "presi" and requests the snippet column as well.
Builder builder = Contacts.CONTENT_FILTER_URI.buildUpon(); builder.appendPath("presi"); // Defer snippeting to the client side if possible, for performance reasons. builder.appendQueryParameter(SearchSnippets.DEFERRED_SNIPPETING_KEY,"1"); Cursor cursor = getContentResolver().query(builder.build()); Bundle extras = cursor.getExtras(); if (extras.getBoolean(ContactsContract.DEFERRED_SNIPPETING)) { // Do our own snippet formatting. // For a contact with the email address (president@organization.com), the snippet // column will contain the string "president@organization.com". } else { // The snippet has already been pre-formatted, we can display it as is. // For a contact with the email address (president@organization.com), the snippet // column will contain the string "[presi]dent@organization.com". }
Modifier and Type | Field and Description |
---|---|
static String |
DEFERRED_SNIPPETING_KEY
The key to ask the provider to defer the formatting of the snippet to the client if
possible, for performance reasons.
|
static String |
SNIPPET
The search snippet constructed by SQLite snippeting functionality.
|
static String |
SNIPPET_ARGS_PARAM_KEY
Comma-separated parameters for the generation of the snippet:
The "start match" text.
|
Constructor and Description |
---|
SearchSnippets() |
public static final String SNIPPET
The snippet may contain (parts of) several data elements belonging to the contact, with the matching parts optionally surrounded by special characters that indicate the start and end of matching text. For example, if a contact has an address "123 Main Street", using a filter "mai" would return the formatted snippet "123 [Mai]n street".
public static final String SNIPPET_ARGS_PARAM_KEY
public static final String DEFERRED_SNIPPETING_KEY
ContactsContract.DEFERRED_SNIPPETING
in the cursor. If it exists, the client
should do its own formatting of the snippet. If it doesn't exist, the snippet column
in the cursor should already contain a formatted snippet.