Table of Contents

Class FacilityClient

Namespace
DotBahn.Facilities
Assembly
DotBahn.Facilities.dll

Client for accessing 'Deutsche Bahn FaSta'-API

public class FacilityClient : ClientBase, IDisposable, IFacilityClient
Inheritance
FacilityClient
Implements
Inherited Members

Constructors

FacilityClient(ClientOptions, AuthorizationOptions)

Client for accessing 'Deutsche Bahn FaSta'-API

public FacilityClient(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

Properties

ApiName

The API identifier used for telemetry tags

protected override string ApiName { get; }

Property Value

string

Methods

GetFacilitiesAsync(FacilityQuery, CancellationToken)

Finds facilities based on optional filter criteria

public Task<IReadOnlyList<Facility>> GetFacilitiesAsync(FacilityQuery query, CancellationToken ct = default)

Parameters

query FacilityQuery

The query to specify results with

ct CancellationToken

Token to cancel the request

Returns

Task<IReadOnlyList<Facility>>

List of facilities matching the criteria

Exceptions

HttpRequestException

Thrown when non-success status codes occur

ArgumentNullException

Thrown when query is null