Class HummApiUrlSelector

Determines the correct base URI for calling Humm based on a country and API enviroment.

Inheritance

Object

HummApiUrlSelector

Implements

IHummApiUrlSelector

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Yort.Humm.InStore

Assembly: Yort.Humm.InStore.dll

Syntax

public sealed class HummApiUrlSelector : IHummApiUrlSelector

Properties

ApiVersion

Gets or sets the version of the API to call.

Declaration

public decimal ApiVersion { get; set; }

Property Value

Type	Description
Decimal	The API version.

Remarks

Currently the only supported version is 1.

Country

Gets or sets the country the system is operating in.

Declaration

public HummCountry Country { get; set; }

Property Value

Type	Description
HummCountry	A value from the HummCountry enum.

Environment

Gets or sets the API environment to use.

Declaration

public HummEnvironment Environment { get; set; }

Property Value

Type	Description
HummEnvironment	A value from the HummEnvironment specifying a test or live environment to use.

Methods

GetUrl()

Gets the base URL to use for Humm API calls.

Declaration

public Uri GetUrl()

Returns

Type	Description
Uri	A Uri representing the base API address to be used.

Exceptions

Type	Condition
InvalidOperationException	Thrown if a unknown Country, Environment or ApiVersion value is specified.

See Also

Environment

Country

ApiVersion

Implements

IHummApiUrlSelector