Rainbow Android SDK/com.ale.rainbowsdk/RoomContainer/fetchContainers

fetchContainers

abstract suspend fun fetchContainers(    @IntRange(from = 1) limit: Int = DEFAULT_LIMIT_FETCH_CONTAINER,     @IntRange(from = 0) offset: Int = 0,     sortOrder: Int = SORT_ASCENDING): RainbowResult<List<Container>>

Fetches a list of room containers from the server.

This method retrieves a paginated list of containers, allowing the caller to specify the maximum number of containers to fetch, the starting position within the list, and the sorting order of the results.

Return

A RainbowResult containing a list of Container objects retrieved from the server. If the fetch operation is successful, RainbowResult.isSuccess will be true, and the list of containers will be available. If the operation fails, RainbowResult.isFailure will be true, and error details will be provided in the result.

Parameters

limit

The maximum number of containers to fetch. Must be a positive integer, with a default of 100. Determines the number of results to retrieve in one request.

offset

The position of the first container to retrieve, useful for pagination. Must be zero or positive, specifying how many containers to skip in the result set. Defaults to 0.

sortOrder

Specifies the sort order of the container list. Must be either SORT_ASCENDING or SORT_DESCENDING. Defaults to SORT_ASCENDING.