AutoaddressClient Class |
Namespace: Autoaddress.Autoaddress2_0
The AutoaddressClient type exposes the following members.
| Name | Description | |
|---|---|---|
| AutoaddressClient(String) |
Constructs AutoaddressClient with a licence key and the other configuration settings using defaults.
| |
| AutoaddressClient(String, AutoaddressConfig) |
Constructs AutoaddressClient with a licence key and an AutoaddressConfig object.
|
| Name | Description | |
|---|---|---|
| AutoComplete |
Lookup a Postcode or Address auto complete options. Returns all available data if found.
| |
| AutoCompleteAsync |
Lookup a Postcode or Address auto complete options as an asynchronous operation. Returns all available data if found.
| |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
| FindAddress(Link) |
Lookup a Postcode or Address. Returns all available data if found.
| |
| FindAddress(Request) |
Lookup a Postcode or Address. Returns all available data if found.
| |
| FindAddressAsync(Link) |
Lookup a Postcode or Address as an asynchronous operation. Returns all available data if found.
| |
| FindAddressAsync(Request) |
Lookup a Postcode or Address as an asynchronous operation. Returns all available data if found.
| |
| GetEcadData(Link) |
Return all the available data from the ECAD for the supplied ECAD Id.
| |
| GetEcadData(Request) |
Return all the available data from the ECAD for the supplied ECAD Id.
| |
| GetEcadDataAsync(Link) |
Return all the available data from the ECAD for the supplied ECAD Id as an asynchronous operation.
| |
| GetEcadDataAsync(Request) |
Return all the available data from the ECAD for the supplied ECAD Id as an asynchronous operation.
| |
| GetGbBuildingData(Link) |
Return data for the supplied UK address ID.
| |
| GetGbBuildingData(Request) |
Return data for the supplied UK address ID.
| |
| GetGbBuildingDataAsync(Link) |
Return data for the supplied UK address ID as an asynchronous operation.
| |
| GetGbBuildingDataAsync(Request) |
Return data for the supplied UK address ID as an asynchronous operation.
| |
| GetGbPostcodeData(Link) |
Return data for the supplied UK postcode.
| |
| GetGbPostcodeData(Request) |
Return data for the supplied UK postcode.
| |
| GetGbPostcodeDataAsync(Link) |
Return data for the supplied UK postcode as an asynchronous operation.
| |
| GetGbPostcodeDataAsync(Request) |
Return data for the supplied UK postcode as an asynchronous operation.
| |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
| GetType | Gets the Type of the current instance. (Inherited from Object.) | |
| MapId(Link) |
Map ID.
| |
| MapId(Request) |
Map ID.
| |
| MapIdAsync(Link) |
Map ID as an asynchronous operation.
| |
| MapIdAsync(Request) |
Map ID as an asynchronous operation.
| |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
| PostcodeLookup(Link) |
Lookup a Postcode. Returns all available data if found.
| |
| PostcodeLookup(Request) |
Lookup a Postcode. Returns all available data if found.
| |
| PostcodeLookupAsync(Link) |
Lookup a Postcode as an asynchronous operation. Returns all available data if found.
| |
| PostcodeLookupAsync(Request) |
Lookup a Postcode as an asynchronous operation. Returns all available data if found.
| |
| ReverseGeocode(Link) |
Reverse geocode a location. Returns the nearest building to the location within the specified maxDistance.
| |
| ReverseGeocode(Request) |
Reverse geocode a location. Returns the nearest building to the location within the specified maxDistance.
| |
| ReverseGeocodeAsync(Link) |
Reverse geocode a location as an asynchronous operation. Returns the nearest building to the location within the specified maxDistance.
| |
| ReverseGeocodeAsync(Request) |
Reverse geocode a location as an asynchronous operation. Returns the nearest building to the location within the specified maxDistance.
| |
| ToString | Returns a string that represents the current object. (Inherited from Object.) | |
| VerifyAddress(Link) |
Verify that the address supplied matches the Eircode supplied.
| |
| VerifyAddress(Request) |
Verify that the address supplied matches the Eircode supplied.
| |
| VerifyAddressAsync(Link) |
Verify that the address supplied matches the Eircode supplied as an asynchronous operation.
| |
| VerifyAddressAsync(Request) |
Verify that the address supplied matches the Eircode supplied as an asynchronous operation.
|
| Name | Description | |
|---|---|---|
| PostRequest |
Occurs after response was received from Autoaddress endpoint.
| |
| PreRequest |
Occurs just before request is sent to Autoaddress endpoint.
|
using System; using Autoaddress.Autoaddress2_0.Model; using Autoaddress.Autoaddress2_0.Model.FindAddress; namespace Autoaddress.Autoaddress2_0.Test.Example { public class AutoaddressClientExample1 { public static void Run() { const string address = "8 Silver Birches, Dunboyne"; var autoaddressClient = new AutoaddressClient(Settings.Licence.Key); var request = new Request(address: address, language: Language.EN, country: Country.IE, limit: 20, geographicAddress: false, vanityMode: false, addressElements: false, addressProfileName: null); var response = autoaddressClient.FindAddress(request); Console.WriteLine("response.Result = {0}", response.Result); Console.WriteLine("response.Postcode = {0}", response.Postcode); Console.WriteLine("response.PostalAddress = {0}", string.Join(",", response.PostalAddress)); } } } // This code example produces the following output: // response.Result = PostcodeAppended // response.Postcode = A86VC04 // response.PostalAddress = 8 SILVER BIRCHES,MILLFARM,DUNBOYNE,CO. MEATH
using System; using Autoaddress.Autoaddress2_0.Model; using Autoaddress.Autoaddress2_0.Model.FindAddress; namespace Autoaddress.Autoaddress2_0.Test.Example { public class AutoaddressClientExample2 { public static void Run() { const string licenceKey = "TheLicenceKey"; const string address = "8 Silver Birches, Dunboyne"; var autoaddressClient = new AutoaddressClient(licenceKey); var request = new Request(address: address, language: Language.EN, country: Country.IE, limit: 20, geographicAddress: false, vanityMode: false, addressElements: false, addressProfileName: null); var response = autoaddressClient.FindAddress(request); Console.WriteLine("response.Result = {0}", response.Result); Console.WriteLine("response.Postcode = {0}", response.Postcode); Console.WriteLine("response.PostalAddress = {0}", string.Join(",", response.PostalAddress)); } } } // This code example produces the following output: // response.Result = PostcodeAppended // response.Postcode = A86VC04 // response.PostalAddress = 8 SILVER BIRCHES,MILLFARM,DUNBOYNE,CO. MEATH
using System; using Autoaddress.Autoaddress2_0.Model; using Autoaddress.Autoaddress2_0.Model.FindAddress; namespace Autoaddress.Autoaddress2_0.Test.Example { public class AutoaddressClientExample3 { public static void Run() { const string apiBaseAddress = "https://api.autoaddress.ie"; const int requestTimeoutMilliseconds = 5000; const string licenceKey = "TheLicenceKey"; const string address = "8 Silver Birches, Dunboyne"; var autoaddressConfig = new AutoaddressConfig(apiBaseAddress, requestTimeoutMilliseconds); var autoaddressClient = new AutoaddressClient(licenceKey, autoaddressConfig); var request = new Request(address: address, language: Language.EN, country: Country.IE, limit: 20, geographicAddress: false, vanityMode: false, addressElements: false, addressProfileName: null); var response = autoaddressClient.FindAddress(request); Console.WriteLine("response.Result = {0}", response.Result); Console.WriteLine("response.Postcode = {0}", response.Postcode); Console.WriteLine("response.PostalAddress = {0}", string.Join(",", response.PostalAddress)); } } } // This code example produces the following output: // response.Result = PostcodeAppended // response.Postcode = A86VC04 // response.PostalAddress = 8 SILVER BIRCHES,MILLFARM,DUNBOYNE,CO. MEATH