Skip to main content

Add the Extension

The simplest way to install and manage your AIR native extensions and libraries is to use the AIR Package Manager (apm). We highly recommend using apm, as it will handle downloading all required dependencies and manage your application descriptor (Android manifest additions, iOS info additions etc).

However you can choose to install it manually, as you would have done in the past.

AIR SDK

This ANE currently requires at least AIR 33+. This is required in order to support versions of Android > 9.0 (API 28). We always recommend using the most recent build with AIR especially for mobile development where the OS changes rapidly.

Install​

info

Note: All of the commands below should be run in a terminal / command prompt in the root directory of your application, generally the level above your source directory.

If you don't have an APM project setup, expand the guide below to setup an APM project before installing the extension.

Setup APM

Install APM​

If you haven't installed apm follow the install guide on airsdk.dev.

Setup an APM project​

You will need an APM project for your application.

There are many ways to do this and for more options see the APM documentation. Here we will just initialise a new empty project:

apm init

Check your github token​

We use github to secure our extensions so you must have created a github personal access token and configured apm to use it.

To do this create a token using this guide from github and then set it in your apm config using:

apm config set github_token ghp_XXXXXXXXXXXXXXXXXXXXXXXXXXXX

If you don't do this correctly you may find the install will fail.

Install the extension​

Install the extension by running: 

apm install com.distriqt.Location

This will download and install the extension, required assets, and all dependencies.

Once complete apm will have created something like the following file structure: 

.
|____ ane
| |____ com.distriqt.Location.ane   # Location extension
| |____ [dependencies]
|____ apm_packages                  # cache directory - ignore
|____ project.apm                   # apm project file
  • Add the ane directory to your IDE. See the tutorials located here on adding an extension to your IDE.
info

We suggest you use the locations directly in your builds rather than copying the files elsewhere. The reason for this is if you ever go to update the extensions using apm that these updates will be pulled into your build automatically.

  • You will need to set the usage description strings for use in the authorisation dialogs. Call the following to step through the configuration values for this extension:
apm project config set com.distriqt.Location

Application Descriptor​

Updating your application descriptor will insert the required extensionID's and generate the manifest and info additions for your application.

You update your application descriptor by running:

apm generate app-descriptor src/MyApp-app.xml

Change the path (src/MyApp-app.xml) to point to your application descriptor.

caution

This will modify your application descriptor replacing the manifest additions and info additions with the ones generated from apm.

You should backup your application descriptor before running this command to ensure you don't lose any information.

If you need to insert custom data into these sections see the guides for Android and iOS

Background Updates​

Android​

On Android, if you require access to the location data in the background or if you are using geofences then you must also add the background permission:

<!-- NEEDED FOR BACKGROUND LOCATION AND GEOFENCES -->
<uses-permission android:name="android.permission.ACCESS_BACKGROUND_LOCATION" />
To add this you need to add some additional configuration to apm. Firstly add a custom Android configuration file by running:
apm generate config android

Edit the config/android/AndroidManifest.xml file that was generated to resemble the following, adding the required permissions, i.e.:

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android" xmlns:tools="http://schemas.android.com/tools">

    <uses-permission android:name="android.permission.ACCESS_BACKGROUND_LOCATION" />

</manifest>

Once you have added this configuration run the steps above to update / generate your application descriptor.

You can add any other additions you require in your application here and these will be merged by apm when you generate your application descriptor.

iOS​

If you are planning to setup your application to receive background updates then you should include the UIBackgroundModes key, (however it is not required). If it is enabled, you will be able to receive updates in the background to trigger an event when your application is running in the background (and you have been granted the ALWAYS authorisation by the user, see later). If you don't add it, then you will only receive the updates when the application is running in the foreground.

Currently due to an AIR bug we can't receive location updates on iOS when the application isn't running. This is due to a bug where AIR applications cannot "start into the background" on iOS.

To add these additions you need to add some additional configuration. Firstly add a custom iOS configuration file by running:
apm generate config ios

Edit the config/ios/InfoAdditions.xml file that was generated to resemble the following, adding the UIBackgroundModes node:

<plist version="1.0">
    <dict>

    <!-- Required if you wish to receive background location updates -->
    <key>UIBackgroundModes</key>
    <array>
        <string>location</string>
    </array>

    </dict>
</plist>

Once you have added this configuration run the steps above to update / generate your application descriptor.

You can add any other additions you require in your application here and these will be merged by apm when you generate your application descriptor.

note

If your application requires locations services to run then you should also add the following to your info additions:

<!-- Add this if your application needs location services to run -->
<key>UIRequiredDeviceCapabilities</key>
<array>
    <string>location-services</string>
</array>