SliceProvider

Kotlin |Java

abstract class SliceProvider : ContentProvider

kotlin.Any
↳	android.content.ContentProvider
	↳	androidx.slice.SliceProvider

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 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 androidx.slice.builders.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 notifyChange 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 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

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

Public functions
`Unit`	`attachInfo(context: Context?, info: ProviderInfo?)`
`Int`	`bulkInsert(uri: Uri, values: Array<ContentValues!>)`
`Bundle?`	`call(method: String, arg: String?, extras: Bundle?)` Handles the call to SliceProvider.
`Uri?`	`@RequiresApi(value = 19) canonicalize(url: Uri)`
`Int`	`delete(uri: Uri, selection: String?, selectionArgs: Array<String!>?)`
`(Mutable)List<Uri!>`	`@RequiresApi(value = 19) getPinnedSlices()` Returns a list of slice URIs that are currently pinned.
`String?`	`getType(uri: Uri)`
`Uri?`	`insert(uri: Uri, values: ContentValues?)`
`abstract Slice?`	`@RequiresApi(value = 19) onBindSlice(sliceUri: Uri)` Implemented to create a slice.
`Boolean`	`onCreate()`
`PendingIntent?`	`onCreatePermissionRequest(sliceUri: Uri, callingPackage: String)` Called when an app requests a slice it does not have write permission to the uri for.
`abstract Boolean`	`@RequiresApi(value = 19) onCreateSliceProvider()` Implement this to initialize your slice provider on startup.
`(Mutable)Collection<Uri!>`	`@RequiresApi(value = 19) onGetSliceDescendants(uri: Uri)` Obtains a list of slices that are descendants of the specified Uri.
`Uri`	`@RequiresApi(value = 19) onMapIntentToUri(intent: Intent)` This method must be overridden if an `IntentFilter` is specified on the SliceProvider.
`Unit`	`@RequiresApi(value = 19) onSlicePinned(sliceUri: Uri)` Called to inform an app that a slice has been pinned.
`Unit`	`@RequiresApi(value = 19) onSliceUnpinned(sliceUri: Uri)` Called to inform an app that a slices is no longer pinned.
`Cursor?`	`@RequiresApi(value = 28) query( uri: Uri, projection: Array<String!>?, queryArgs: Bundle?, cancellationSignal: CancellationSignal? )`
`Cursor?`	`query( uri: Uri, projection: Array<String!>?, selection: String?, selectionArgs: Array<String!>?, sortOrder: String? )`
`Cursor?`	`@RequiresApi(value = 16) query( uri: Uri, projection: Array<String!>?, selection: String?, selectionArgs: Array<String!>?, sortOrder: String?, cancellationSignal: CancellationSignal? )`
`Int`	`update( uri: Uri, values: ContentValues?, selection: String?, selectionArgs: Array<String!>? )`

Inherited Constants

From android.content.ComponentCallbacks2

`const Int`	`TRIM_MEMORY_BACKGROUND = 40`
`const Int`	`TRIM_MEMORY_COMPLETE = 80`
`const Int`	`TRIM_MEMORY_MODERATE = 60`
`const Int`	`TRIM_MEMORY_RUNNING_CRITICAL = 15`
`const Int`	`TRIM_MEMORY_RUNNING_LOW = 10`
`const Int`	`TRIM_MEMORY_RUNNING_MODERATE = 5`
`const Int`	`TRIM_MEMORY_UI_HIDDEN = 20`

Inherited functions

From android.content.ContentProvider

`Array<ContentProviderResult!>!`	`applyBatch( authority: String!, operations: ArrayList<ContentProviderOperation!>! )`
`Bundle!`	`call(authority: String!, method: String!, arg: String!, extras: Bundle!)`
`ContentProvider.CallingIdentity!`	`clearCallingIdentity()`
`Unit`	`dump(fd: FileDescriptor!, writer: PrintWriter!, args: Array<String!>!)`
`AttributionSource!`	`getCallingAttributionSource()`
`String!`	`getCallingAttributionTag()`
`String!`	`getCallingPackage()`
`String!`	`getCallingPackageUnchecked()`
`Context!`	`getContext()`
`Array<PathPermission!>!`	`getPathPermissions()`
`String!`	`getReadPermission()`
`Array<String!>!`	`getStreamTypes(uri: Uri!, mimeTypeFilter: String!)`
`String!`	`getTypeAnonymous(uri: Uri!)`
`String!`	`getWritePermission()`
`Boolean`	`isTemporary()`
`Unit`	`onCallingPackageChanged()`
`Unit`	`onConfigurationChanged(newConfig: Configuration!)`
`Unit`	`onLowMemory()`
`Unit`	`onTrimMemory(level: Int)`
`AssetFileDescriptor!`	`openAssetFile(uri: Uri!, mode: String!)`
`ParcelFileDescriptor!`	`openFile(uri: Uri!, mode: String!)`
`ParcelFileDescriptor!`	`openFileHelper(uri: Uri!, mode: String!)`
`ParcelFileDescriptor!`	`<T> openPipeHelper( uri: Uri!, mimeType: String!, opts: Bundle!, args: T!, func: ContentProvider.PipeDataWriter<T!>! )`
`AssetFileDescriptor!`	`openTypedAssetFile(uri: Uri!, mimeTypeFilter: String!, opts: Bundle!)`
`Boolean`	`refresh(uri: Uri!, extras: Bundle!, cancellationSignal: CancellationSignal!)`
`Context!`	`requireContext()`
`Unit`	`restoreCallingIdentity(identity: ContentProvider.CallingIdentity!)`
`Unit`	`setPathPermissions(permissions: Array<PathPermission!>!)`
`Unit`	`setReadPermission(permission: String!)`
`Unit`	`setWritePermission(permission: String!)`
`Unit`	`shutdown()`
`Uri!`	`uncanonicalize(url: Uri!)`

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

SliceProvider

Summary

Public constructors

Public functions

Inherited Constants

Inherited functions

Public constructors

SliceProvider

SliceProvider

Public functions

attachInfo

bulkInsert

call

canonicalize

delete

getPinnedSlices

getType

insert

onBindSlice

onCreate

onCreatePermissionRequest

onCreateSliceProvider

onGetSliceDescendants

onMapIntentToUri

onSlicePinned

onSliceUnpinned

query

query

query

update