Callbacks

Introduction

The Autoaddress plugin is designed with an event-driven architecture, allowing you to enhance its functionality by subscribing to these events. This document serves as a comprehensive guide for the events within the Autoaddress plugin.

Event driven plugin

An event-driven plugin is one that relies on events or triggers to communicate and execute specific functions. The Autoaddress plugin responds to various events that occur during its lifecycle, and by understanding and utilizing these events, you can extend and customize the behavior of the plugin to suit your specific requirements. 

Subscribing to events

The below code snippet demonstrates the usage of callback events within the Autoaddress control.

In this code:

Autoaddress is an object representing the Autoaddress plugin, and you initialize it with configuration options.

apiKey should be replaced with your actual API key from the Account Center.

elementId specifies the ID of the HTML element where the Autoaddress plugin will be rendered.

The code also defines several sample callback events:

onPostInit: This event is triggered after the plugin is initialized. You can add custom logic within the callback function to perform actions once the plugin is ready.

onAddressResult: This event is triggered by either the user selecting an address from autocomplete options or if the user opted into format entered address changes on the Autoaddress form. The latter is only available if your integration is AutoaddressForm.

onAddressFormChange: This event is triggered when the user chooses to enter the address manually instead of using autocomplete. You can define how to handle this user action.

<script type="text/javascript">
var aa = Autoaddress({
  key: "YOUR_KEY",
  elementId: "aa-control",    
  onPostInit: function(token) {
    // This callback is triggered after the plugin is initialized.
    // You can add custom logic here.
  },
  onAddressResult: function(result) {
    // This callback is triggered when the user selects an address from autocomplete api.
    // Also additionally gets triggered if you called `aa.triggerFormatEnteredAddress()` which will include form changes.
    const result = await aa.getAddressResult();
    const { lines, city, region, postcode, country } = result?.address;
    const addressLabel = result?.address?.label;
 
    // Sample extracting data attributes (if available)
    const { location = {} } = result?.data;
    const { latitude, longitude } = location;
  },
  onAddressFormChange: function(address) {
    // This callback is triggered when the user makes manual changes to the Autoaddress form.
 
    // For example trigger a call to our FormatEnteredAddress api on form change to keep address result in sync with live changes.
    // This will also invoke the onAddressResult callback
    aa.triggerFormatEnteredAddress(address)
  },
  // Add more callback events as needed...
});
</script>

Callbacks

You can add more callback events to respond to various interactions and stages within the Autoaddress plugin. These callbacks allow you to tailor the behavior of the plugin to your specific requirements.

API Callbacks

Two generic callbacks, onPreAPI and onPostAPI,  are provided for when the javascript control interacts with the Autoaddress 3 API. These callbacks are typically used for debugging but can also be used to influence the behaviour of the Autoaddress control.

Note: Using the onPreAPI and on PostAPI callbacks to influence the behaviour of the Autoaddress control 

Search Lifecycle Callbacks

Control Display Callbacks

 User Action Callbacks

Error Callbacks