platform_tools_api_testing_functional/com.tomtom.ivi.platform.tools.api.testing.functional.util

Package-level declarations

Properties

DEFAULT_WAIT_LIVE_DATA_TIMEOUT

val DEFAULT_WAIT_LIVE_DATA_TIMEOUT: Duration

Starting the Android service process can be very slow on the CI.

locationOnScreen

@IviExperimental(reasons = [])

val View.locationOnScreen: Point

Returns a Point containing the coordinates of the View's origin in relation to the screen.

Functions

coWaitForLiveData

@IviExperimental(reasons = [])

suspend fun <T> LiveData<T>.coWaitForLiveData(timeoutMs: Long, predicate: (T) -> Boolean): Boolean

@IviExperimental(reasons = [])

suspend fun <T> LiveData<T>.coWaitForLiveData(timeout: Duration = DEFAULT_WAIT_LIVE_DATA_TIMEOUT, predicate: (T) -> Boolean): Boolean

Wait for the LiveData instance to have a given predicate from a coroutine context on the main thread.

getOrAwaitValue

@IviExperimental(reasons = [])

fun <T> LiveData<T>.getOrAwaitValue(timeoutMs: Long): T

@IviExperimental(reasons = [])

fun <T> LiveData<T>.getOrAwaitValue(timeout: Duration = DEFAULT_WAIT_LIVE_DATA_TIMEOUT): T

Waits until this LiveData value is set.

waitFor

@IviExperimental(reasons = [])

fun UiDevice.waitFor(selector: BySelector, timeoutMs: Long = DEFAULT_WAIT_FOR_TIMEOUT_MS): UiObject2

Helper method to wait for a given selector to be found.

waitForAndCheckIviServiceAsyncFunResult

@IviExperimental(reasons = [])

fun <R> waitForAndCheckIviServiceAsyncFunResult(timeoutMs: Long = DEFAULT_WAIT_LIVE_DATA_TIMEOUT.inWholeMilliseconds, expectedResultType: IviServiceFunResult.ResultType = IviServiceFunResult.ResultType.SUCCESSFUL, function: ((IviServiceFunResult<R?>?) -> Unit) -> Unit): IviServiceFunResult<R?>

Utility function to wait for an IVI service async function result and check the result.

waitForAndCheckIviServiceCoFunResult

@IviExperimental(reasons = [])

fun <R, F : KFunction<R>> waitForAndCheckIviServiceCoFunResult(function: F, timeoutMs: Long = DEFAULT_WAIT_LIVE_DATA_TIMEOUT.inWholeMilliseconds, block: suspend (F) -> R): R

Utility function to wait for an IVI service coroutine function result and check it.

waitForIviServiceAsyncFunResult

@IviExperimental(reasons = [])

fun <R> waitForIviServiceAsyncFunResult(timeoutMs: Long = DEFAULT_WAIT_LIVE_DATA_TIMEOUT.inWholeMilliseconds, function: ((IviServiceFunResult<R?>?) -> Unit) -> Unit): IviServiceFunResult<R?>

Utility function to wait for an IVI service async function result.

waitForIviServiceCoFunResult

@IviExperimental(reasons = [])

fun <R, F : KFunction<R>> waitForIviServiceCoFunResult(function: F, timeoutMs: Long, block: suspend (F) -> R): R

Utility function to wait for an IVI service coroutine function result.

waitForLiveData

@IviExperimental(reasons = [])

fun <T> LiveData<T>.waitForLiveData(timeoutMs: Long, predicate: (T) -> Boolean): Boolean

@IviExperimental(reasons = [])

fun <T> LiveData<T>.waitForLiveData(timeout: Duration = DEFAULT_WAIT_LIVE_DATA_TIMEOUT, predicate: (T) -> Boolean): Boolean

Wait for the LiveData instance to have a given predicate.

waitForNonUi

@IviExperimental(reasons = [])

fun waitForNonUi(timeoutMs: Long, intervalMs: Long = DEFAULT_INTERVAL_MS, predicate: () -> Boolean): Boolean

Utility function to wait for a predicate to return true. The predicate is invoked periodically with intervalMs as interval until the timeoutMs timeout is reached.