gbfs-v2/dev.sargunv.mobilitydata.gbfs.v2/GbfsV2Client

GbfsV2Client

class GbfsV2Client : AutoCloseable(source)

HTTP client for fetching GBFS v2 feeds.

Constructors

constructor(block: HttpClientConfig<*>.() -> Unit = {})

constructor(engine: HttpClientEngine, block: HttpClientConfig<*>.() -> Unit = {})

Functions

open override fun close()

getFreeBikeStatus

context(service: Service)
suspend fun getFreeBikeStatus(): Result<GbfsFeedResponse<FreeBikeStatus>>

Fetches real-time status of free-floating vehicles not currently docked.

getGeofencingZones

context(service: Service)
suspend fun getGeofencingZones(): Result<GbfsFeedResponse<GeofencingZones>>

Fetches geofencing zones that define geographic restrictions.

getStationInformation

context(service: Service)
suspend fun getStationInformation(): Result<GbfsFeedResponse<StationInformation>>

Fetches static information about stations in the system.

getStationStatus

context(service: Service)
suspend fun getStationStatus(): Result<GbfsFeedResponse<StationStatus>>

Fetches real-time status of stations including available bikes and docks.

getSystemAlerts

context(service: Service)
suspend fun getSystemAlerts(): Result<GbfsFeedResponse<SystemAlerts>>

Fetches current system alerts about service disruptions or changes.

getSystemCalendar

context(service: Service)
suspend fun getSystemCalendar(): Result<GbfsFeedResponse<SystemCalendar>>

Fetches the operating calendar for seasonal systems.

context(service: Service)
suspend fun getSystemHours(): Result<GbfsFeedResponse<SystemHours>>

Fetches hours of operation for the system.

getSystemInformation

context(service: Service)
suspend fun getSystemInformation(): Result<GbfsFeedResponse<SystemInformation>>

Fetches system information including name, operator, timezone, and contact details.

getSystemManifest

suspend fun getSystemManifest(discoveryUrl: Url): Result<GbfsFeedResponse<SystemManifest>>

Fetches the GBFS manifest (auto-discovery file) from the given URL.

getSystemPricingPlans

context(service: Service)
suspend fun getSystemPricingPlans(): Result<GbfsFeedResponse<SystemPricingPlans>>

Fetches pricing plans for the system.

getSystemRegions

context(service: Service)
suspend fun getSystemRegions(): Result<GbfsFeedResponse<SystemRegions>>

Fetches information about geographic regions in the system.

getVehicleTypes

context(service: Service)
suspend fun getVehicleTypes(): Result<GbfsFeedResponse<VehicleTypes>>

Fetches information about vehicle types available in the system.

getVersionManifest

context(service: Service)
suspend fun getVersionManifest(): Result<GbfsFeedResponse<VersionManifest>>

Fetches the list of GBFS versions supported by this system.