The Android Developer Challenge is back! Submit your idea before December 2.

SliceViewManager

abstract class SliceViewManager
kotlin.Any
   ↳ androidx.slice.SliceViewManager

Class to handle interactions with Slices.

The SliceViewManager manages permissions and pinned state for slices.

Summary

Nested classes

abstract

Class that listens to changes in Slices.

Public methods

abstract Slice?
bindSlice(@NonNull uri: Uri)

Turns a slice Uri into slice content.

abstract Slice?
bindSlice(@NonNull intent: Intent)

Turns a slice intent into slice content.

open static SliceViewManager
getInstance(@NonNull context: Context)

Get a SliceViewManager.

abstract MutableCollection<Uri!>
getSliceDescendants(@NonNull uri: Uri)

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

abstract Uri?
mapIntentToUri(@NonNull intent: Intent)

Turns a slice intent into a slice uri.

abstract Unit
pinSlice(@NonNull uri: Uri)

Ensures that a slice is in a pinned state.

abstract Unit
registerSliceCallback(@NonNull uri: Uri, @NonNull callback: SliceViewManager.SliceCallback)

Adds a callback to a specific slice uri.

abstract Unit
registerSliceCallback(@NonNull uri: Uri, @NonNull executor: Executor, @NonNull callback: SliceViewManager.SliceCallback)

Adds a callback to a specific slice uri.

abstract Unit
unpinSlice(@NonNull uri: Uri)

Remove a pin for a slice.

abstract Unit
unregisterSliceCallback(@NonNull uri: Uri, @NonNull callback: SliceViewManager.SliceCallback)

Removes a callback for a specific slice uri.

Public methods

bindSlice

@Nullable abstract fun bindSlice(@NonNull uri: Uri): Slice?

Turns a slice Uri into slice content.

Parameters
uri Uri: The URI to a slice provider
Return
Slice?: The Slice provided by the app or null if none is given.

See Also

bindSlice

@Nullable abstract fun bindSlice(@NonNull intent: Intent): Slice?

Turns a slice intent into slice content. Is a shortcut to perform the action of both mapIntentToUri(Intent) and bindSlice(Uri) at once.

Parameters
intent Intent: The intent associated with a slice.
Return
Slice?: The Slice provided by the app or null if none is given.

getInstance

@NonNull open static fun getInstance(@NonNull context: Context): SliceViewManager

Get a SliceViewManager.

getSliceDescendants

@WorkerThread @NonNull abstract fun getSliceDescendants(@NonNull uri: Uri): MutableCollection<Uri!>

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

Not all slice providers will implement this functionality, in which case, an empty collection will be returned.

Parameters
uri Uri: The uri to look for descendants under.
Return
MutableCollection<Uri!>: All slices within the space.

mapIntentToUri

@Nullable abstract fun mapIntentToUri(@NonNull intent: Intent): Uri?

Turns a slice intent into a slice uri. Expects an explicit intent.

This goes through a several stage resolution process to determine if any slice can represent this intent.

  1. If the intent contains data that android.content.ContentResolver#getType is android.app.slice.SliceProvider#SLICE_TYPE then the data will be returned.
  2. If the intent explicitly points at an activity, and that activity has meta-data for key android.app.slice.SliceManager#SLICE_METADATA_KEY, then the Uri specified there will be returned.
  3. Lastly, if the intent with android.app.slice.SliceManager#CATEGORY_SLICE added resolves to a provider, then the provider will be asked to SliceProvider#onMapIntentToUri and that result will be returned.
  4. If no slice is found, then null is returned.
Parameters
intent Intent: The intent associated with a slice.
Return
Uri?: The Slice Uri provided by the app or null if none exists.

pinSlice

abstract fun pinSlice(@NonNull uri: Uri): Unit

Ensures that a slice is in a pinned state.

Pinned state is not persisted across reboots, so apps are expected to re-pin any slices they still care about after a reboot.

Parameters
uri Uri: The uri of the slice being pinned.

registerSliceCallback

abstract fun registerSliceCallback(@NonNull uri: Uri, @NonNull callback: SliceViewManager.SliceCallback): Unit

Adds a callback to a specific slice uri.

This is a convenience method that performs a few slice actions at once. It will put the slice in a pinned state since there is a callback attached. It will also listen for content changes, when a content change is observed, the android system will bind the new slice and provide it to all registered SliceCallbacks.

This will not trigger a bindSlice immediately, it will only perform a bind and pass it to the callback after a change occurs. To avoid race conditions and missing data, callers should call bindSlice immediately after calling registerSliceCallback so that it has the current slice.

Parameters
uri Uri: The uri of the slice being listened to.
callback Uri: The listener that should receive the callbacks.

registerSliceCallback

abstract fun registerSliceCallback(@NonNull uri: Uri, @NonNull executor: Executor, @NonNull callback: SliceViewManager.SliceCallback): Unit

Adds a callback to a specific slice uri.

This is a convenience that performs a few slice actions at once. It will put the slice in a pinned state since there is a callback attached. It will also listen for content changes, when a content change observes, the android system will bind the new slice and provide it to all registered SliceCallbacks.

Parameters
uri Uri: The uri of the slice being listened to.
callback Uri: The listener that should receive the callbacks.

unpinSlice

abstract fun unpinSlice(@NonNull uri: Uri): Unit

Remove a pin for a slice.

If the slice has no other pins/callbacks then the slice will be unpinned.

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

unregisterSliceCallback

abstract fun unregisterSliceCallback(@NonNull uri: Uri, @NonNull callback: SliceViewManager.SliceCallback): Unit

Removes a callback for a specific slice uri.

Removes the app from the pinned state (if there are no other apps/callbacks pinning it) in addition to removing the callback.

Parameters
uri Uri: The uri of the slice being listened to
callback Uri: The listener that should no longer receive callbacks.