Citymapper SDK/com.citymapper.sdk.core.transit

Package com.citymapper.sdk.core.transit

Types

class AncestorResultIdentifier constructor(signature: Signature, token: String)

Identifies the ancestor result for a Route. Two Routes have the same identifier if they are descendants from the same original routing result, even if they now have different signatures. This allows treating updates to a Route (for example, due to re-routing events) as the "same" route from a user-facing point of view

BoardingSection

enum BoardingSection : Enum<BoardingSection>

Brand

data class Brand(id: String, images: ImageResources<BrandImageResource>, name: String?)

BrandImageResource

data class BrandImageResource(uiRole: BrandUiRole, dimensions: ImageResource.Dimensions, @Size(min = 1) pixelRatioVariants: List<ImageResource.PixelRatioVariant>, hasSpaceForText: Boolean, isGeneric: Boolean, isDropoff: Boolean, lowCapacity: Boolean) : ImageResource<BrandUiRole>

BrandUiRole

enum BrandUiRole : Enum<BrandUiRole>

Departure

sealed class Departure

DepartureAvailability

enum DepartureAvailability : Enum<DepartureAvailability>

DirectionsResults

data class DirectionsResults(routes: List<Route>)

DurationAccuracy

enum DurationAccuracy : Enum<DurationAccuracy>

Frequency

data class Frequency(min: Duration, max: Duration, startTime: Date?, endTime: Date?)

FrequencyDeparture

data class FrequencyDeparture(serviceId: ServiceId?, headsign: String?, shortName: String?, platformShortName: String?, frequency: Frequency) : Departure

HasInstructions

interface HasInstructions

HasPathAnnotations

interface HasPathAnnotations

HasService

interface HasService

HiredVehicleLeg

data class HiredVehicleLeg(distance: Distance, travelDuration: Duration?, vehicleType: VehicleType, service: Service, instructionSegments: List<InstructionSegment>?, pathAnnotations: List<PathAnnotation>?, path: PathGeometry, vehiclePickupOptions: List<VehiclePickupOption>, vehicleDropoffOptions: List<VehicleDropoffOption>) : SelfPilotedLeg, HasService

A leg where the user drives or rides a vehicle which they hire at the start of the leg, represented by the service.

HireVehicle

data class HireVehicle(coords: Coords, name: String?, serviceId: String, propulsionType: PropulsionType?, currentRangeMeters: Int?, currentFuelPercent: Float?)

HireVehicleStation

data class HireVehicleStation(coords: Coords, name: String?, serviceId: String?, numberOfVehiclesAvailable: Int?, numberOfDocksAvailable: Int?)

ImageResource

interface ImageResource<UiRole : Enum<*>>

ImageResources

data class ImageResources<T : ImageResource<*>>(allImages: List<T>)

Instruction

data class Instruction(pathIndex: Int, location: Coords, descriptionText: String, descriptionFormat: String?, descriptionFormatReplacements: List<InstructionDescriptionFormatReplacement>?, type: InstructionType?, typeDirection: InstructionDirection?, bearingBefore: Float, bearingAfter: Float)

InstructionDescriptionFormatReplacement

data class InstructionDescriptionFormatReplacement(key: String, text: String, type: InstructionDescriptionFormatReplacement.Type, language: Locale?) : RichReplacement

InstructionDirection

sealed class InstructionDirection

InstructionSegment

data class InstructionSegment(distance: Distance, duration: Duration?, endInstruction: Instruction, startPathIndex: Int, containingLegPath: PathGeometry)

InstructionType

sealed class InstructionType

Leg

sealed class Leg

A Leg represents a section of a Route traversed using a single mode of travel

LegStop

data class LegStop(id: StopId, name: String, coordinates: Coords, indicatorText: String?, serviceChange: ServiceChange?)

NoDeparture

object NoDeparture : Departure

OwnVehicleLeg

data class OwnVehicleLeg(distance: Distance, travelDuration: Duration?, vehicleType: VehicleType, instructionSegments: List<InstructionSegment>?, pathAnnotations: List<PathAnnotation>?, path: PathGeometry) : SelfPilotedLeg

A leg where the user drives or rides a vehicle of their own

PathAnnotation

data class PathAnnotation(startIndex: Int, endIndex: Int, shouldWalk: Boolean?)

Price

data class Price(formatted: String, amount: String?, currency: String?)

Profile

data class Profile(id: String)

ProfileDetail

data class ProfileDetail(profile: Profile, localizedName: String)

PropulsionType

enum PropulsionType : Enum<PropulsionType>

Route

data class Route(signature: Signature, ancestorResult: AncestorResultIdentifier, legs: List<Leg>, start: Waypoint, end: Waypoint, profileDetail: ProfileDetail?, duration: Duration?, durationAccuracy: DurationAccuracy, price: Price?, departureTime: Date?, arrivalTime: Date?)

SelfPilotedLeg

sealed class SelfPilotedLeg : VehicleLeg, HasInstructions, HasPathAnnotations

A leg where the user drives or rides a vehicle themselves e.g. e-scooters, bicycles, motor scooters, private automobiles

Service

data class Service(id: ServiceId, name: String, vehicleType: VehicleType, brand: Brand?, images: ImageResources<ServiceImageResource>, @ColorInt color: Int?, @ColorInt backgroundColor: Int?, textColor: String?)

ServiceChange

data class ServiceChange(service: Service, headsign: String?)

ServiceId

typealias ServiceId = String

ServiceImageResource

data class ServiceImageResource(uiRole: ServiceUiRole, dimensions: ImageResource.Dimensions, @Size(min = 1) pixelRatioVariants: List<ImageResource.PixelRatioVariant>, replacesName: Boolean) : ImageResource<ServiceUiRole>

ServiceStatus

data class ServiceStatus(severity: Severity, title: String, description: String?, stopRanges: List<StopRange>?, serviceIds: List<ServiceId>) : Status

ServiceUiRole

enum ServiceUiRole : Enum<ServiceUiRole>

Severity

enum Severity : Enum<Severity>

Signature

interface Signature

StationWalkDetails

data class StationWalkDetails(duration: Duration, recommendedExitName: String?)

StationWalkType

enum StationWalkType : Enum<StationWalkType>

Status

sealed class Status

StopId

typealias StopId = String

StopRange

data class StopRange(startId: StopId, endId: StopId)

StopStatus

data class StopStatus(severity: Severity, title: String, description: String?, stopIds: List<StopId>) : Status

TimeStatus

enum TimeStatus : Enum<TimeStatus>

TransitLeg

data class TransitLeg(distance: Distance, path: PathGeometry, fallbackDuration: Duration?, stops: List<LegStop>, departure: Departure, allServiceOptions: List<Service>, allDepartureOptions: List<Departure>, statuses: List<Status>?, legDepartureTime: Date?, legArrivalTime: Date?, directionDescription: String?, bestBoardingSections: List<BoardingSection>?) : VehicleLeg, HasService

A leg of a Journey involving taking transit. This leg usually represents a specific departure, but may include some information about alternative routes which may be taken.

VehicleDeparture

data class VehicleDeparture(serviceId: ServiceId, headsign: String?, shortName: String?, timeName: String?, platformShortName: String?, scheduledTime: Date?, liveTime: Date?, isLive: Boolean, timeStatus: TimeStatus?) : Departure

VehicleDropoffOption

sealed class VehicleDropoffOption

VehicleLeg

sealed class VehicleLeg : Leg

A leg which involves using a vehicle to travel

VehiclePickupOption

sealed class VehiclePickupOption

VehicleType