Click or drag to resize

AutoaddressClientAutoCompleteAsync Method

Lookup a Postcode or Address auto complete options as an asynchronous operation. Returns all available data if found.

Namespace:  Autoaddress.Autoaddress2_0
Assembly:  Autoaddress2.0SDK (in Autoaddress2.0SDK.dll) Version: 1.0.18
Syntax
public Task<Response> AutoCompleteAsync(
	Request request
)

Parameters

request
Type: Autoaddress.Autoaddress2_0.Model.AutoCompleteRequest
AutoComplete request.

Return Value

Type: TaskResponse
The task object representing the asynchronous operation.

Implements

IAutoaddressAutoCompleteAsync(Request)
Examples
The following code example creates an AutoaddressClient and calls AutoCompleteAsync with a request.
C#
using System;
using Autoaddress.Autoaddress2_0.Model;
using Autoaddress.Autoaddress2_0.Model.AutoComplete;

namespace Autoaddress.Autoaddress2_0.Test.Example
{
    public class AutoaddressClientAutoCompleteAsyncRequestExample1
    {
        public static async void Run()
        {
            const string address = "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 = await autoaddressClient.AutoCompleteAsync(request);

            Console.WriteLine("response.TotalOptions = {0}", response.TotalOptions);
            Console.WriteLine("response.Options[0].DisplayName = {0}", response.Options[0].DisplayName);
        }
    }
}

// This code example produces the following output:
// response.TotalOptions = 1
// response.Options[0].DisplayName = SILVER BIRCHES, MILLFARM, DUNBOYNE, CO. MEATH
See Also