Class DepartureQuery

Namespace

DotVgn.Client.Queries

Assembly

DotVgn.Client.dll

Defines a query to search for departures by line or by transport filters.

public sealed record DepartureQuery : IQuery, IEquatable<DepartureQuery>

Inheritance

object

DepartureQuery

Implements

IQuery

IEquatable<DepartureQuery>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

DepartureQuery(int, TransportType[], int, int, int)

Creates a query that searches by transport types.

public DepartureQuery(int stationId, TransportType[] transports, int limit, int timespan = 10, int delay = 5)

Parameters

stationId int

The unique identifier of the station for which departures are queried.

transports TransportType[]

An array of transport types to include in the query. Must not be empty.

limit int

The maximum number of departures to return.

timespan int

The time window, in minutes, within which to search for departures. Defaults to 10 minutes if not specified.

delay int

The minimum delay, in minutes, to apply before considering departures. Defaults to 5 minutes if not specified.

Exceptions

ArgumentException

Thrown if transports is an empty array.

DepartureQuery(int, string, int, int, int)

Creates a query that searches by line.

public DepartureQuery(int stationId, string line, int limit, int timespan = 10, int delay = 5)

Parameters

stationId int

The unique identifier of the station for which departures are queried.

line string

The line to search for.

limit int

The maximum number of departures to return.

timespan int

The time window, in minutes, within which to search for departures. Defaults to 10 minutes if not specified.

delay int

The minimum delay, in minutes, to apply before considering departures. Defaults to 5 minutes if not specified.

Methods

Equals(DepartureQuery?)

public bool Equals(DepartureQuery? other)

Parameters

other DepartureQuery

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

GetRelativeUriExtension()

Gets a uri extension string with included query parameters.

public string GetRelativeUriExtension()

Returns

string

A string representing the relative uri extension, including parameters.

ToString()

public override string ToString()

Returns

string

Operators

operator ==(DepartureQuery?, DepartureQuery?)

public static bool operator ==(DepartureQuery? left, DepartureQuery? right)

Parameters

left DepartureQuery

right DepartureQuery

Returns

bool

operator !=(DepartureQuery?, DepartureQuery?)

public static bool operator !=(DepartureQuery? left, DepartureQuery? right)

Parameters

left DepartureQuery

right DepartureQuery

Returns

bool