Constructor Detail

Method Detail

• getStatus

  @NonNull() abstract CacheStatus getStatus()

  The current status of the cache.

  • For possible values, see CacheStatus.

  Default: UNINITIALISED

  Returns:

  The cache status. (NonNull)

• getTasks

  @NonNull() abstract CachingTaskList getTasks()

  List of caching tasks which control the caching of media.

  • To remove a task from the list, invoke remove.

  Returns:

  List of caching tasks. (NonNull)

• createTask

   abstract CachingTask createTask(@NonNull() SourceDescription source, @Nullable() CachingParameters parameters)

  Creates a caching task which controls the caching of the media.

  Parameters:

  source - Describes the media source to be cached.

  parameters - Contains caching task related options.

• setNotificationBuilder

   abstract void setNotificationBuilder(@NonNull() CacheNotificationsBuilder builder)

  Sets the CacheNotificationsBuilder to be used for constructing cache notifications and notification channel.

  Parameters:

  builder - The CacheNotificationsBuilder instance to be set.

• getNotificationBuilder

  @NonNull() abstract CacheNotificationsBuilder getNotificationBuilder()

  Retrieves the current CacheNotificationsBuilder instance used for constructing cache notifications.

  Returns:

  The current CacheNotificationsBuilder instance.

• getNetwork

  @NonNull() abstract Network getNetwork()

  The Network API that manages the caching.

  Returns:

  The Network API. (NonNull)

• addIntegration

   abstract void addIntegration(@NonNull() CacheIntegration integration)

  Adds an CacheIntegration.

  Parameters:

  integration - The CacheIntegration to be added on the cache.

• removeIntegration

   abstract void removeIntegration(@NonNull() CacheIntegration integration)

  Removes an CacheIntegration.

  Parameters:

  integration - The CacheIntegration to be removed from the cache.