Class StationClient

Namespace

DotBahn.Stations

Assembly

DotBahn.Stations.dll

Client for accessing 'Deutsche Bahn StaDa'-API.

public class StationClient : ClientBase, IDisposable, IStationClient

Inheritance

object

ClientBase

StationClient

Implements

IDisposable

IStationClient

Inherited Members

ClientBase.GetAsync<TContract>(string, IParser<TContract>, string, QueryParameters, CancellationToken)

ClientBase.Dispose()

ClientBase.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

StationClient(ClientOptions, AuthorizationOptions)

Client for accessing 'Deutsche Bahn StaDa'-API.

public StationClient(ClientOptions options, AuthorizationOptions auth)

Parameters

options ClientOptions

The options for this instance.

auth AuthorizationOptions

The auth credentials for the client.

Remarks

Creates and owns its own HttpClient. Dispose this instance to release it. Use only when instantiating manually without a DI container.

Exceptions

ArgumentNullException

Thrown when options is null.

ArgumentNullException

Thrown when auth is null.

Methods

GetStationsAsync(StationQuery, CancellationToken)

Searches for stations using a query structure.

public Task<IReadOnlyList<Station>> GetStationsAsync(StationQuery query, CancellationToken cancellation = default)

Parameters

query StationQuery

The query to specify results with.

cancellation CancellationToken

Token to cancel the request.

Returns

Task<IReadOnlyList<Station>>

List of stations matching the search criteria.

Exceptions

HttpRequestException

Thrown when non-success status codes occur.

ArgumentNullException

Thrown when query is null.