Summary: Inherited Constants | Ctors | Methods | Inherited Methods

SliceProvider

Kotlin |Java

public abstract class SliceProvider
extends ContentProvider

java.lang.Object
↳	android.content.ContentProvider
	↳	androidx.slice.SliceProvider

Known direct subclasses

SliceProviderWithCallbacks<T extends SliceProviderWithCallbacks>

SliceProviderWithCallbacks<T extends SliceProviderWithCallbacks> Version of SliceProvider that can be used as a CallbackReceiver.

A SliceProvider allows an app to provide Slices to the Android OS. A slice is a piece of app content and actions that can be displayed outside of the app in Android system surfaces or within another app. Slices are identified by a Uri and a SliceProvider allows your app to provide a slice based on a uri.

The primary method to implement in SliceProvider is onBindSlice(Uri) which is called whenever something wants to display a slice from your app. An app can have multiple slices all served from the same slice provider, the Uri passed to onBindSlice will identify the specific slice being requested.

 public MySliceProvider extends SliceProvider {

      public Slice onBindSlice(Uri sliceUri) {
          String path = sliceUri.getPath();
          switch (path) {
              case "/weather":
                  return createWeatherSlice(sliceUri);
              case "/traffic":
                  return createTrafficSlice(sliceUri);
          }
          return null;
      }
 }

Slices are constructed with TemplateSliceBuilders.

Slices are not currently live content. They are bound once and shown to the user. If the content in the slice changes due to user interaction or an update in the data being displayed, then ContentResolver.notifyChange(Uri, ContentObserver) should be used to notify the system to request the latest slice from the app.

The provider needs to be declared in the manifest to provide the authority for the app. The authority for most slices is expected to match the package of the application.

 <provider
     android:name="com.android.mypkg.MySliceProvider"
     android:authorities="com.android.mypkg" />

Slices can also be identified by an intent. To link an intent with a slice, the slice provider must have an IntentFilter matching the slice intent. When a slice is being requested via an intent, onMapIntentToUri(Intent) will be called and is expected to return an appropriate Uri representing the slice.

 <provider
     android:name="com.android.mypkg.MySliceProvider"
     android:authorities="com.android.mypkg">
     <intent-filter>
         <action android:name="android.intent.action.MY_SLICE_INTENT" />
         <category android:name="android.app.slice.category.SLICE" />
     </intent-filter>
 </provider>

See also:

Slice

Summary

Inherited constants

From interface android.content.ComponentCallbacks2

`int`	`TRIM_MEMORY_BACKGROUND`
`int`	`TRIM_MEMORY_COMPLETE`
`int`	`TRIM_MEMORY_MODERATE`
`int`	`TRIM_MEMORY_RUNNING_CRITICAL`
`int`	`TRIM_MEMORY_RUNNING_LOW`
`int`	`TRIM_MEMORY_RUNNING_MODERATE`
`int`	`TRIM_MEMORY_UI_HIDDEN`

Public constructors
`SliceProvider(String... autoGrantPermissions)` A version of constructing a SliceProvider that allows autogranting slice permissions to apps that hold specific platform permissions.
`SliceProvider()`

Public methods
`final int`	`bulkInsert(Uri uri, ContentValues[] values)`
`Bundle`	`call(String method, String arg, Bundle extras)`
`final Uri`	`canonicalize(Uri url)`
`final int`	`delete(Uri uri, String selection, String[] selectionArgs)`
`List<Uri>`	`getPinnedSlices()` Returns a list of slice URIs that are currently pinned.
`final String`	`getType(Uri uri)`
`final Uri`	`insert(Uri uri, ContentValues values)`
`abstract Slice`	`onBindSlice(Uri sliceUri)` Implemented to create a slice.
`final boolean`	`onCreate()`
`PendingIntent`	`onCreatePermissionRequest(Uri sliceUri, String callingPackage)` Called when an app requests a slice it does not have write permission to the uri for.
`abstract boolean`	`onCreateSliceProvider()` Implement this to initialize your slice provider on startup.
`Collection<Uri>`	`onGetSliceDescendants(Uri uri)` Obtains a list of slices that are descendants of the specified Uri.
`Uri`	`onMapIntentToUri(Intent intent)` This method must be overridden if an `IntentFilter` is specified on the SliceProvider.
`void`	`onSlicePinned(Uri sliceUri)` Called to inform an app that a slice has been pinned.
`void`	`onSliceUnpinned(Uri sliceUri)` Called to inform an app that a slices is no longer pinned.
`final Cursor`	`query(Uri uri, String[] projection, Bundle queryArgs, CancellationSignal cancellationSignal)`
`final Cursor`	`query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder)`
`final Cursor`	`query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder, CancellationSignal cancellationSignal)`
`final int`	`update(Uri uri, ContentValues values, String selection, String[] selectionArgs)`

Inherited methods

From class


        
          android.content.ContentProvider

`ContentProviderResult[]`	`applyBatch(String arg0, ArrayList<ContentProviderOperation> arg1)`
`ContentProviderResult[]`	`applyBatch(ArrayList<ContentProviderOperation> arg0)`
`void`	`attachInfo(Context arg0, ProviderInfo arg1)`
`int`	`bulkInsert(Uri arg0, ContentValues[] arg1)`
`Bundle`	`call(String arg0, String arg1, String arg2, Bundle arg3)`
`Bundle`	`call(String arg0, String arg1, Bundle arg2)`
`Uri`	`canonicalize(Uri arg0)`
`final ContentProvider.CallingIdentity`	`clearCallingIdentity()`
`abstract int`	`delete(Uri arg0, String arg1, String[] arg2)`
`int`	`delete(Uri arg0, Bundle arg1)`
`void`	`dump(FileDescriptor arg0, PrintWriter arg1, String[] arg2)`
`final String`	`getCallingAttributionTag()`
`final String`	`getCallingPackage()`
`final String`	`getCallingPackageUnchecked()`
`final Context`	`getContext()`
`final PathPermission[]`	`getPathPermissions()`
`final String`	`getReadPermission()`
`String[]`	`getStreamTypes(Uri arg0, String arg1)`
`abstract String`	`getType(Uri arg0)`
`final String`	`getWritePermission()`
`Uri`	`insert(Uri arg0, ContentValues arg1, Bundle arg2)`
`abstract Uri`	`insert(Uri arg0, ContentValues arg1)`
`boolean`	`isTemporary()`
`void`	`onCallingPackageChanged()`
`void`	`onConfigurationChanged(Configuration arg0)`
`abstract boolean`	`onCreate()`
`void`	`onLowMemory()`
`void`	`onTrimMemory(int arg0)`
`AssetFileDescriptor`	`openAssetFile(Uri arg0, String arg1, CancellationSignal arg2)`
`AssetFileDescriptor`	`openAssetFile(Uri arg0, String arg1)`
`ParcelFileDescriptor`	`openFile(Uri arg0, String arg1, CancellationSignal arg2)`
`ParcelFileDescriptor`	`openFile(Uri arg0, String arg1)`
`final ParcelFileDescriptor`	`openFileHelper(Uri arg0, String arg1)`
`<T> ParcelFileDescriptor`	`openPipeHelper(Uri arg0, String arg1, Bundle arg2, T arg3, PipeDataWriter<T> arg4)`
`AssetFileDescriptor`	`openTypedAssetFile(Uri arg0, String arg1, Bundle arg2, CancellationSignal arg3)`
`AssetFileDescriptor`	`openTypedAssetFile(Uri arg0, String arg1, Bundle arg2)`
`Cursor`	`query(Uri arg0, String[] arg1, Bundle arg2, CancellationSignal arg3)`
`Cursor`	`query(Uri arg0, String[] arg1, String arg2, String[] arg3, String arg4, CancellationSignal arg5)`
`abstract Cursor`	`query(Uri arg0, String[] arg1, String arg2, String[] arg3, String arg4)`
`boolean`	`refresh(Uri arg0, Bundle arg1, CancellationSignal arg2)`
`final Context`	`requireContext()`
`final void`	`restoreCallingIdentity(ContentProvider.CallingIdentity arg0)`
`final void`	`setPathPermissions(PathPermission[] arg0)`
`final void`	`setReadPermission(String arg0)`
`final void`	`setWritePermission(String arg0)`
`void`	`shutdown()`
`Uri`	`uncanonicalize(Uri arg0)`
`int`	`update(Uri arg0, ContentValues arg1, Bundle arg2)`
`abstract int`	`update(Uri arg0, ContentValues arg1, String arg2, String[] arg3)`

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

From interface


        
          android.content.ComponentCallbacks2

abstract void onTrimMemory(int arg0)

From interface


        
          android.content.ComponentCallbacks

`abstract void`	`onConfigurationChanged(Configuration arg0)`
`abstract void`	`onLowMemory()`

Public constructors

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.

Parameters
`autoGrantPermissions`	`String`: List of permissions that holders are auto-granted access to slices.

SliceProvider

public SliceProvider ()

Public methods

bulkInsert

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

Parameters
`uri`	`Uri`
`values`	`ContentValues`

Returns
`int`

call

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

Parameters
`method`	`String`
`arg`	`String`
`extras`	`Bundle`

Returns
`Bundle`

canonicalize

public final Uri canonicalize (Uri url)

Parameters
`url`	`Uri`

Returns
`Uri`

delete

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

Parameters
`uri`	`Uri`
`selection`	`String`
`selectionArgs`	`String`

Returns
`int`

getPinnedSlices

public List<Uri> getPinnedSlices ()

Returns a list of slice URIs that are currently pinned.

Returns
`List<Uri>`	All pinned slices.

getType

public final String getType (Uri uri)

Parameters
`uri`	`Uri`

Returns
`String`

insert

public final Uri insert (Uri uri, 
                ContentValues values)

Parameters
`uri`	`Uri`
`values`	`ContentValues`

Returns
`Uri`

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.

Parameters
`sliceUri`	`Uri`

Returns
`Slice`

See also:

Slice
Slice.HINT_PARTIAL

onCreate

public final boolean onCreate ()

Returns
`boolean`

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.

Parameters
`sliceUri`	`Uri`: the Uri of the slice attempting to be bound.
`callingPackage`	`String`: the packageName of the app requesting the slice

Returns
`PendingIntent`

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.

Returns
`boolean`	true if the provider was successfully loaded, false otherwise

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.

Parameters
`uri`	`Uri`: The uri to look for descendants under.

Returns
`Collection<Uri>`	All slices within the space.

See also:

SliceViewManager.getSliceDescendants(Uri)

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.

Parameters
`intent`	`Intent`

Returns
`Uri`	Uri representing the slice associated with the provided intent.

See also:

Slice

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.

Parameters
`sliceUri`	`Uri`: The uri of the slice being unpinned.

See also:

onSliceUnpinned(Uri)

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.

Parameters
`sliceUri`	`Uri`

See also:

onSlicePinned(Uri)

query

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

Parameters
`uri`	`Uri`
`projection`	`String`
`queryArgs`	`Bundle`
`cancellationSignal`	`CancellationSignal`

Returns
`Cursor`

query

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

Parameters
`uri`	`Uri`
`projection`	`String`
`selection`	`String`
`selectionArgs`	`String`
`sortOrder`	`String`

Returns
`Cursor`

query

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

Parameters
`uri`	`Uri`
`projection`	`String`
`selection`	`String`
`selectionArgs`	`String`
`sortOrder`	`String`
`cancellationSignal`	`CancellationSignal`

Returns
`Cursor`

update

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

Parameters
`uri`	`Uri`
`values`	`ContentValues`
`selection`	`String`
`selectionArgs`	`String`

Returns
`int`