HapiHimSearchRequest

class HapiHimSearchRequest : HapiRequest<HapiHimMessages>

Types

Companion

object Companion

WeekMask

@JvmInline

value class WeekMask(underlying: Int)

Functions

clear

open override fun clear()

containsKey

open override fun containsKey(key: String): Boolean

containsValue

open override fun containsValue(value: String): Boolean

get

open operator override fun get(key: String): String?

isEmpty

open override fun isEmpty(): Boolean

put

open override fun put(key: String, value: String): String?

putAll

open override fun putAll(from: Map<out String, String>)

remove

open override fun remove(key: String): String?

Properties

accessId

var accessId: String?

Access ID for identifying the requesting client

affectedJourneyMode

var affectedJourneyMode: String?

Define how to return affected journeys

affectedJourneyStopMode

var affectedJourneyStopMode: String?

Define how to return stops of affected journeys

bothways

var bothways: Boolean?

If enabled, messages in both directions - from 'himfromstation' to 'himtostation' as well as from 'himtostation' to 'himfromstation' are returned

categories

var categories: List<String>?

List of train categories seperated by comma

channels

var channels: List<String>?

List of channels seperated by comma

companies

var companies: List<String>?

List of companies seperated by comma

dateB

var dateB: LocalDate?

Sets the event period start date

dateE

var dateE: LocalDate?

Sets the event period end date

entries

open override val entries: MutableSet<MutableMap.MutableEntry<String, String>>

fromstation

var fromstation: String?

Filter messages by line segment starting at this station given as (external) station id

hierarchicalView

var hierarchicalView: Boolean?

Return parent messages with childs

himcategory

var himcategory: String?

HIM category, e.g. Works and/or Disturbance. Value depends on your HAFAS server data

himIds

var himIds: List<String>?

List of HIM message IDs seperated by comma

himtags

var himtags: List<String>?

HIM Tags. Value depends on your HAFAS server data

himtext

var himtext: String?

Filter for Him messages containing the given free text message seperated by comma

keys

open override val keys: MutableSet<String>

lang

var lang: String?

The language of the journey planer

lineids

var lineids: List<String>?

Only HIM messages for the given line (identified by its line ID) are part of the result. To filter multiple lines, separate the line IDs by comma

lines

var lines: List<String>?

Only HIM messages for the given line are part of the result. To filter multiple lines, separate the codes by comma

maxprio

var maxprio: Int?

Filter for HIM messages having this priority as maximum

metas

var metas: List<String>?

List of predefined filters seperated by comma

minprio

var minprio: Int?

Filter for HIM messages having at least this priority

operators

var operators: List<String>?

List of operators seperated by comma

orderBy

var orderBy: List<HafasHimSortOrder>?

Define the Order the returned messages by fields and directions. Multiple, comma separated entries are supported

poly

var poly: Boolean?

Enables/disables returning of geo information for affected edges and regions if available and enabled in the backend

polyEnc

var polyEnc: HafasPolylineEncoding?

Polyline encoding format

requestId

var requestId: String?

Request ID for identifying the request

searchmode

var searchmode: String?

HIM search mode

size

open override val size: Int

stations

var stations: List<String>?

List of (external) station ids to be filtered for seperated by comma

timeB

var timeB: LocalTime?

Sets the event period start time

timeE

var timeE: LocalTime?

Sets the event period end time

tostation

var tostation: String?

Filter messages by line segment travelling in direction of this station given as (external) station id

trainnames

var trainnames: List<String>?

List of train name to be filtered for seperated by comma

values

open override val values: MutableCollection<String>

weekdays

var weekdays: HapiHimSearchRequest.WeekMask?

Bitmask for validity of HIM messages based on weekdays. Each character represents a weekday starting on monday