Zync SDK/zync.api.route/ZyncRouteManager

ZyncRouteManager

class ZyncRouteManager

Public API manager for route operations in the Zync SDK.

This manager provides the public interface for route-related functionality, following the offline-first approach where local data is returned immediately and background sync operations keep the data updated.

Functions

Link copied to clipboard
suspend fun getRouteConfig(routeUid: String, jobUid: String): GetRouteConfigResult

Get route configuration for a specific job within a route.

Link copied to clipboard
suspend fun getRouteDetail(routeUid: String, sendPolyline: Boolean? = null): GetRouteDetailResult

Get detailed information for a specific route by its UID.

Link copied to clipboard
suspend fun getRoutes(page: Int, pageSize: Int, fromDate: String, toDate: String, sendPolyline: Boolean? = null): GetRoutesResult

Get paginated routes list with date range filtering.

Link copied to clipboard
suspend fun getRoutesForDashboard(page: Int, pageSize: Int, fromDate: String, toDate: String, sendPolyline: Boolean): GetDashboardRoutesResult

Get dashboard routes with intelligent cache-first strategy for single-date queries.

Link copied to clipboard
fun observeDashboardChanges(): Flow<ZyncDashboardRouteUpdatesEvent>

Observe dashboard route changes for real-time UI updates.

Link copied to clipboard
fun observeRouteChanges(routeUid: String): Flow<ZyncRouteUpdateEvent>

Observes route changes for a specific route with real-time updates.