SliceProvider

See also:

• Slice

SliceProvider

public SliceProvider (String... autoGrantPermissions)

A version of constructing a SliceProvider that allows autogranting slice permissions to apps that hold specific platform permissions.

When an app tries to bind a slice from a provider that it does not have access to, the provider will check if the caller holds permissions to any of the autoGrantPermissions specified, if they do they will be granted persisted uri access to all slices of this provider.

SliceProvider

public SliceProvider ()

attachInfo

public void attachInfo (Context context, 
                ProviderInfo info)

bulkInsert

public final int bulkInsert (Uri uri, 
                ContentValues[] values)

call

public Bundle call (String method, 
                String arg, 
                Bundle extras)

Handles the call to SliceProvider.

This function is unsupported for sdk < 19. For sdk 28 and above the call is handled by SliceProvider

canonicalize

public final Uri canonicalize (Uri url)

delete

public final int delete (Uri uri, 
                String selection, 
                String[] selectionArgs)

getPinnedSlices

public List<Uri> getPinnedSlices ()

Returns a list of slice URIs that are currently pinned.

getType

public final String getType (Uri uri)

insert

public final Uri insert (Uri uri, 
                ContentValues values)

onBindSlice

public abstract Slice onBindSlice (Uri sliceUri)

Implemented to create a slice.

onBindSlice should return as quickly as possible so that the UI tied to this slice can be responsive. No network or other IO will be allowed during onBindSlice. Any loading that needs to be done should happen in the background with a call to ContentResolver.notifyChange(Uri, ContentObserver) when the app is ready to provide the complete data in onBindSlice.

onCreate

public final boolean onCreate ()

onCreatePermissionRequest

public PendingIntent onCreatePermissionRequest (Uri sliceUri, 
                String callingPackage)

Called when an app requests a slice it does not have write permission to the uri for.

The return value will be the action on a slice that prompts the user that the calling app wants to show slices from this app. Returning null will use the default implementation that launches a dialog that allows the user to grant access to this slice. Apps that do not want to allow this user grant, can override this and instead launch their own dialog with different behavior.

onCreateSliceProvider

public abstract boolean onCreateSliceProvider ()

Implement this to initialize your slice provider on startup. This method is called for all registered slice providers on the application main thread at application launch time. It must not perform lengthy operations, or application startup will be delayed.

You should defer nontrivial initialization (such as opening, upgrading, and scanning databases) until the slice provider is used (via #onBindSlice, etc). Deferred initialization keeps application startup fast, avoids unnecessary work if the provider turns out not to be needed, and stops database errors (such as a full disk) from halting application launch.

onGetSliceDescendants

public Collection<Uri> onGetSliceDescendants (Uri uri)

Obtains a list of slices that are descendants of the specified Uri.

Implementing this is optional for a SliceProvider, but does provide a good discovery mechanism for finding slice Uris.

onMapIntentToUri

public Uri onMapIntentToUri (Intent intent)

This method must be overridden if an IntentFilter is specified on the SliceProvider. In that case, this method can be called and is expected to return a non-null Uri representing a slice. Otherwise this will throw UnsupportedOperationException.

onSlicePinned

public void onSlicePinned (Uri sliceUri)

Called to inform an app that a slice has been pinned.

Pinning is a way that slice hosts use to notify apps of which slices they care about updates for. When a slice is pinned the content is expected to be relatively fresh and kept up to date.

Being pinned does not provide any escalated privileges for the slice provider. So apps should do things such as turn on syncing or schedule a job in response to a onSlicePinned.

Pinned state is not persisted through a reboot, and apps can expect a new call to onSlicePinned for any slices that should remain pinned after a reboot occurs.

onSliceUnpinned

public void onSliceUnpinned (Uri sliceUri)

Called to inform an app that a slices is no longer pinned.

This means that no other apps on the device care about updates to this slice anymore and therefore it is not important to be updated. Any syncs or jobs related to this slice should be cancelled.

query

public final Cursor query (Uri uri, 
                String[] projection, 
                Bundle queryArgs, 
                CancellationSignal cancellationSignal)

query

public final Cursor query (Uri uri, 
                String[] projection, 
                String selection, 
                String[] selectionArgs, 
                String sortOrder)

query

public final Cursor query (Uri uri, 
                String[] projection, 
                String selection, 
                String[] selectionArgs, 
                String sortOrder, 
                CancellationSignal cancellationSignal)

update

public final int update (Uri uri, 
                ContentValues values, 
                String selection, 
                String[] selectionArgs)