platform_framework_api_ipc_iviservice/com.tomtom.ivi.platform.framework.api.ipc.iviservice.datasource

Package com.tomtom.ivi.platform.framework.api.ipc.iviservice.datasource

API of TomTom Digital Cockpit's IPC framework specific to sharing data sources.

Types

interface IviDataSource<E : Any, Q : Any>

Interface of all IVI data source implementations.

Interface for an abstraction of pageable static data from some source, where loading pages of data is typically an expensive operation. Some examples of common PagingSources might be from network or from a database.

IviPagingSourceBase

abstract class IviPagingSourceBase<E : Any> constructor : IviPagingSource<E>

Generic base class for all IviPagingSource implementations.

MutableIviDataSource

abstract class MutableIviDataSource<E : Any, Q : Any>(val jumpingSupported: Boolean) : IviDataSource<E, Q>

Base class for IviDataSource implementations that contains the code to load data from a data source.

MutableIviPagingSource

abstract class MutableIviPagingSource<E : Any> : IviPagingSourceBase<E>

Base class for IviPagingSource implementations that contains the the code to load data from a data source.

PageProvider

interface PageProvider<E : Any>

Interface to load an IviPagingSource.LoadResult.Page from an IviPagingSource.

Functions

first

fun , E : Any> Flow.first(): Flow<E>

Transforms this IviPagingSource to a E with only the first element from the IviPagingSource.

fun , E : Any> LiveData.first(timeout: Duration = Duration.ZERO): LiveData<E>

Transforms this IviPagingSource to a E with only the first element from the IviPagingSource. If the returned LiveData becomes inactive while values are still being emitted, the underlying coroutine will be cancelled after the timeout, unless the LiveData becomes active again before that timeout. By default, timeout is Duration.ZERO, which means that once the returned LiveData becomes inactive it is not usable anymore.

mapQuery

fun <D : IviDataSource<E, Q>, E : Any, Q : Any> Flow<D>.mapQuery(query: Q): Flow<IviPagingSource<E>>

Transforms this IviDataSource to an IviPagingSource for the given query.

fun <D : IviDataSource<E, Q>, E : Any, Q : Any> LiveData<D>.mapQuery(query: Q, timeout: Duration = Duration.ZERO): LiveData<IviPagingSource<E>>

Transforms this IviDataSource to a IviPagingSource for a given query. If the returned LiveData becomes inactive while values are still being emitted, the underlying coroutine will be cancelled after the timeout, unless the LiveData becomes active again before that timeout. By default, timeout is Duration.ZERO, which means that once the returned LiveData becomes inactive it is not usable anymore.

fun <D : IviDataSource<E, Q>, E : Any, Q : Any, R> Flow<D>.mapQuery(query: Q, transformation: suspend (PageProvider<E>) -> R): Flow<R>

Transforms this IviDataSource to a R for the given query and given transformation lambda.

fun <D : IviDataSource<E, Q>, E : Any, Q : Any, R> LiveData<D>.mapQuery( query: Q, timeout: Duration = Duration.ZERO, transformation: suspend (PageProvider<E>) -> R): LiveData<R>

Transforms this IviDataSource to a LiveData of type R for a given query and a given transformation. If the returned LiveData becomes inactive while values are still being emitted, the underlying coroutine will be cancelled after the timeout, unless the LiveData becomes active again before that timeout. By default, timeout is Duration.ZERO, which means that once the returned LiveData becomes inactive it is not usable anymore.

toList

fun , E : Any> Flow.toList(): Flow<List<E>>

Transforms this IviPagingSource to a List containing elements of type E with all elements from the IviPagingSource.

fun , E : Any> LiveData.toList(timeout: Duration = Duration.ZERO): LiveData<List<E>>

Transforms this IviPagingSource to a List containing elements of type E with all elements from the IviPagingSource. If the returned LiveData becomes inactive while values are still being emitted, the underlying coroutine will be cancelled after the timeout, unless the LiveData becomes active again before that timeout. By default, timeout is Duration.ZERO, which means that once the returned LiveData becomes inactive it is not usable anymore.