ContactsContract.SearchSnippets

Kotlin |Java

public static class ContactsContract.SearchSnippets
extends Object

java.lang.Object
↳	android.provider.ContactsContract.SearchSnippets

Additional column returned by 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".
}

Summary

Constants
`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.
`String`	`SNIPPET` The search snippet constructed by SQLite snippeting functionality.

Public constructors
`SearchSnippets()`

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

DEFERRED_SNIPPETING_KEY

Added in API level 21

public static final 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. A value of 1 indicates true, 0 indicates false. False is the default. When a cursor is returned to the client, it should check for an extra with the name 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.

Constant Value: "deferred_snippeting"

SNIPPET

Added in API level 21

public static final String SNIPPET

The search snippet constructed by SQLite snippeting functionality.

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".

See also:

http://www.sqlite.org/fts3.html#snippet

Constant Value: "snippet"

Public constructors

SearchSnippets

public SearchSnippets ()

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

ContactsContract.SearchSnippets

Summary

Constants

Public constructors

Inherited methods

Constants

DEFERRED_SNIPPETING_KEY

SNIPPET

Public constructors

SearchSnippets

More Android

Discover

Android Devices

Releases

Documentation and Downloads

Support