YahooRateProviderOptions Class

Definition

Namespace

Bodu.Financial.ExchangeRates

Assembly

Bodu.Financial.ExchangeRates.Yahoo.dll

Package

Bodu.Financial.ExchangeRates.Yahoo 0.7.1

Source

YahooRateProviderOptions.cs

Configures how the YahooRateProvider addresses and interprets the Yahoo Finance chart REST service.

public sealed class YahooRateProviderOptions : WebRateProviderOptions

Inheritance

object

WebRateProviderOptions

YahooRateProviderOptions

Inherited Members

WebRateProviderOptions.Validate()

WebRateProviderOptions.TryValidate(out string)

WebRateProviderOptions.BaseAddress

WebRateProviderOptions.HttpTimeout

WebRateProviderOptions.MaxResponseContentBufferSize

WebRateProviderOptions.UserAgent

WebRateProviderOptions.AllowSynchronousNetworkAccess

WebRateProviderOptions.DefaultLookback

WebRateProviderOptions.HistoryAvailability

WebRateProviderOptions.CurrencyAliases

WebRateProviderOptions.DownloadStartingLogLevel

WebRateProviderOptions.DownloadCompletedLogLevel

WebRateProviderOptions.DownloadFailedLogLevel

WebRateProviderOptions.ObservationIngestedLogLevel

WebRateProviderOptions.SynchronousNetworkFetchLogLevel

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ComparableExtensions.AtLeast<T>(T, T, IComparer<T>)

ComparableExtensions.AtMost<T>(T, T, IComparer<T>)

ComparableExtensions.IsEqualTo<T>(T, T, IComparer<T>)

ComparableExtensions.Max<T>(T, T, IComparer<T>)

ComparableExtensions.Min<T>(T, T, IComparer<T>)

Remarks

This type derives from WebRateProviderOptions, which supplies the endpoint base address, the HTTP contract, the synchronous-access and look-back behaviour, the currency-alias map, and the per-concern log levels. The members declared here are Yahoo-specific: the ChartPath template and the SymbolFormat used to build the foreign-exchange ticker. The chart bar interval is fixed at one day, and the date range is supplied per call through the provider's lookup and range methods.

Every member carries a working default, so the options bind cleanly through Microsoft.Extensions.Options and require no configuration for the common case. The dependency-injection package binds this type from configuration and a configure delegate.

Constructors

YahooRateProviderOptions()

Initializes a new instance of the YahooRateProviderOptions class with the Yahoo Finance host as its base address and a fixed history floor at the chart data's December 2003 inception.

public YahooRateProviderOptions()

Remarks

The advertised HistoryAvailability is advisory: individual pairs may start later than the December 2003 inception of the longest-running pairs. Override the property when the pairs in use are known to have a later floor.

Properties

ChartPath

Gets or sets the relative chart-endpoint path template. The {symbol} placeholder is replaced by the foreign-exchange ticker before the request is issued.

public string ChartPath { get; set; }

Property Value

string

The chart path template; defaults to v8/finance/chart/{symbol}.

SymbolFormat

Gets or sets the template used to build a Yahoo foreign-exchange ticker from a currency pair. The {from} and {to} placeholders are replaced by the source and destination currency codes.

public string SymbolFormat { get; set; }

Property Value

string

The ticker template; defaults to {from}{to}=X (for example, AUDUSD=X).

Methods

TryValidateCore(out string?)

Validates the Yahoo-specific options, ensuring the chart path and ticker template carry their placeholders.

protected override bool TryValidateCore(out string? error)

Parameters

error string

When this method returns false, a message describing the violated invariant; otherwise null.

Returns

bool

true when every Yahoo-specific invariant holds; otherwise false.

Applies to

Product	Versions
.NET	8, 10