public abstract class SearchIndexablesProvider extends ContentProvider
PreferenceScreen
) or either
as some raw data.SearchIndexableResource
,
SearchIndexableData
,
To create a search indexables provider, extend this class, then implement the abstract methods,
and add it to your manifest like this:
<manifest>
...
<application>
...
<provider
android:name="com.example.MyIndexablesProvider"
android:authorities="com.example.myindexablesprovider"
android:exported="true"
android:grantUriPermissions="true"
android:permission="android.permission.READ_SEARCH_INDEXABLES"
<intent-filter>
<action android:name="android.content.action.SEARCH_INDEXABLES_PROVIDER" />
</intent-filter>
</provider>
...
</application>
</manifest>
When defining your provider, you must protect it with
{@link android.Manifest.permission#READ_SEARCH_INDEXABLES}, which is a permission only the system
can obtain.
ContentProvider.PipeDataWriter<T>
TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_RUNNING_CRITICAL, TRIM_MEMORY_RUNNING_LOW, TRIM_MEMORY_RUNNING_MODERATE, TRIM_MEMORY_UI_HIDDEN
Constructor and Description |
---|
SearchIndexablesProvider() |
Modifier and Type | Method and Description |
---|---|
void |
attachInfo(Context context,
ProviderInfo info)
Implementation is provided by the parent class.
|
int |
delete(Uri uri,
String selection,
String[] selectionArgs)
Implementation is provided by the parent class.
|
String |
getType(Uri uri)
Implement this to handle requests for the MIME type of the data at the
given URI.
|
Uri |
insert(Uri uri,
ContentValues values)
Implementation is provided by the parent class.
|
Cursor |
query(Uri uri,
String[] projection,
String selection,
String[] selectionArgs,
String sortOrder)
Implement this to handle query requests from clients.
|
abstract Cursor |
queryNonIndexableKeys(String[] projection)
Returns all
SearchIndexablesContract.NonIndexableKey . |
abstract Cursor |
queryRawData(String[] projection)
Returns all
SearchIndexablesContract.RawData . |
abstract Cursor |
queryXmlResources(String[] projection)
Returns all
SearchIndexablesContract.XmlResource . |
int |
update(Uri uri,
ContentValues values,
String selection,
String[] selectionArgs)
Implementation is provided by the parent class.
|
applyBatch, attachInfoForTesting, bulkInsert, call, canonicalize, coerceToLocalContentProvider, dump, enforceReadPermissionInner, enforceWritePermissionInner, getAppOpsManager, getAuthorityWithoutUserId, getCallingPackage, getContext, getIContentProvider, getPathPermissions, getReadPermission, getStreamTypes, getUriWithoutUserId, getUserIdFromAuthority, getUserIdFromAuthority, getUserIdFromUri, getUserIdFromUri, getWritePermission, isTemporary, matchesOurAuthorities, maybeAddUserId, onConfigurationChanged, onCreate, onLowMemory, onTrimMemory, openAssetFile, openAssetFile, openFile, openFile, openFileHelper, openPipeHelper, openTypedAssetFile, openTypedAssetFile, query, rejectInsert, setAppOps, setAuthorities, setPathPermissions, setReadPermission, setWritePermission, shutdown, uncanonicalize, uriHasUserId
public void attachInfo(Context context, ProviderInfo info)
attachInfo
in class ContentProvider
context
- The context this provider is running ininfo
- Registered information about this content providerpublic Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder)
ContentProvider
Example client call:
// Request a specific record. Cursor managedCursor = managedQuery( ContentUris.withAppendedId(Contacts.People.CONTENT_URI, 2), projection, // Which columns to return. null, // WHERE clause. null, // WHERE clause value substitution People.NAME + " ASC"); // Sort order.Example implementation:
// SQLiteQueryBuilder is a helper class that creates the // proper SQL syntax for us. SQLiteQueryBuilder qBuilder = new SQLiteQueryBuilder(); // Set the table we're querying. qBuilder.setTables(DATABASE_TABLE_NAME); // If the query ends in a specific record number, we're // being asked for a specific record, so set the // WHERE clause in our query. if((URI_MATCHER.match(uri)) == SPECIFIC_MESSAGE){ qBuilder.appendWhere("_id=" + uri.getPathLeafId()); } // Make the query. Cursor c = qBuilder.query(mDb, projection, selection, selectionArgs, groupBy, having, sortOrder); c.setNotificationUri(getContext().getContentResolver(), uri); return c;
query
in class ContentProvider
uri
- The URI to query. This will be the full URI sent by the client;
if the client is requesting a specific record, the URI will end in a record number
that the implementation should parse and add to a WHERE or HAVING clause, specifying
that _id value.projection
- The list of columns to put into the cursor. If
null
all columns are included.selection
- A selection criteria to apply when filtering rows.
If null
then all rows are included.selectionArgs
- You may include ?s in selection, which will be replaced by
the values from selectionArgs, in order that they appear in the selection.
The values will be bound as Strings.sortOrder
- How the rows in the cursor should be sorted.
If null
then the provider is free to define the sort order.null
.public abstract Cursor queryXmlResources(String[] projection)
SearchIndexablesContract.XmlResource
.
Those are Xml resource IDs to some PreferenceScreen
.projection
- list of SearchIndexablesContract.XmlResource
columns to put into the cursor. If null
all supported columns
should be included.public abstract Cursor queryRawData(String[] projection)
SearchIndexablesContract.RawData
.
Those are the raw indexable data.projection
- list of SearchIndexablesContract.RawData
columns
to put into the cursor. If null
all supported columns should be
included.public abstract Cursor queryNonIndexableKeys(String[] projection)
SearchIndexablesContract.NonIndexableKey
.
Those are the non indexable data keys.projection
- list of SearchIndexablesContract.NonIndexableKey
columns to put into the cursor. If null
all supported columns
should be included.public String getType(Uri uri)
ContentProvider
vnd.android.cursor.item
for a single record,
or vnd.android.cursor.dir/
for multiple items.
This method can be called from multiple threads, as described in
Processes
and Threads.
Note that there are no permissions needed for an application to access this information; if your content provider requires read and/or write permissions, or is not exported, all applications can still call this method regardless of their access permissions. This allows them to retrieve the MIME type for a URI when dispatching intents.
getType
in class ContentProvider
uri
- the URI to query.null
if there is no type.public final Uri insert(Uri uri, ContentValues values)
insert
in class ContentProvider
uri
- The content:// URI of the insertion request. This must not be null
.values
- A set of column_name/value pairs to add to the database.
This must not be null
.public final int delete(Uri uri, String selection, String[] selectionArgs)
delete
in class ContentProvider
uri
- The full URI to query, including a row ID (if a specific record is requested).selection
- An optional restriction to apply to rows when deleting.public final int update(Uri uri, ContentValues values, String selection, String[] selectionArgs)
update
in class ContentProvider
uri
- The URI to query. This can potentially have a record ID if this
is an update request for a specific record.values
- A set of column_name/value pairs to update in the database.
This must not be null
.selection
- An optional filter to match rows to update.