Here we will show you how to add the extension to your development environment and make the necessary changes to your application descriptor to correctly support the extension.
The extension supports different services and most likely you will not want to use them all in your applications. As such we have produced different "variants" of the extension (and air package) which include support for different services while providing exactly the same Actionscript API.
However while the API is identical there are varying dependencies and application descriptor additions required. As such we have broken the guide for adding the extension into the various services, each showing the variant(s) that support the service and the required additions to your application.
The base variant supports the most common services, being:
- Apple In-App Purchases;
- Google Play Billing;
The other variants generally include these services as well but also include additional stores. If you are looking to support them we suggest using the following install guides.
The guide below will focus on Play Billing and Apple In-App Purchases.
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.
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.
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:
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.InAppBilling
This will download and install the base variant of the extension, including the required assets, and all dependencies.
apm will have created something like the following file structure:
| |____ com.distriqt.InAppBilling.ane # InAppBilling extension
| |____ [dependencies]
|____ apm_packages # cache directory - ignore
|____ project.apm # apm project file
- Add the
anedirectory to your IDE. See the tutorials located here on adding an extension to your IDE.
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 find there are several variants of this extension available and each is listed as a separate package. A variant contains different supported services allowing you to integrate only the services you require in your application.
To install a variant you will need to modify the install command as follows:
apm install com.distriqt.InAppBilling-VARIANT
apm install com.distriqt.InAppBilling-Amazon
See the individual section on each variant for more details.
Only install one variant of an package. The base variant is installed when no variant is specified and cannot be included alongside another variant. You will likely get an error if you attempt to install multiple variants with
The following guide is used to manually install the extension, download dependencies and update the application descriptor. We highly recommend installing extensions using
apm will automate the installation and automatically handle updates and dependencies along with greatly simplifying the application descriptor generation.
First step is always to add the extension to your development environment. Download the extension from the repository and then follow the tutorial located here to add the extension to your development environment.
Many of our extensions use some common libraries, for example, the Android Support libraries.
We have to separate these libraries into separate extensions in order to avoid multiple versions of the libraries being included in your application and causing packaging conflicts. This means that you need to include some additional extensions in your application along with the main extension file.
You will add these extensions as you do with any other extension, and you need to ensure it is packaged with your application.
The Core extension is required by this extension. You must include this extension in your application.
The Core extension doesn't provide any functionality in itself but provides support libraries and frameworks used by our extensions. It also includes some centralised code for some common actions that can cause issues if they are implemented in each individual extension.
This extension requires you call the
init() function at some point early in your application, generally at the same time as the initialisation of this extension. If you are using other extensions that also require the Core extension, you only need to initialise it once, before initialising the other extensions.
You can access this extension here: https://github.com/distriqt/ANE-Core.
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.
This will modify your application descriptor replacing the manifest additions and info additions with the ones generated from
You should backup your application descriptor before running this command to ensure you don't lose any information.
The following should be added to your
extensions node in your application descriptor to identify all the required ANEs in your application:
The following additions must be added to your applications manifest additions in your application descriptor.
There are additions specific for Google Play Billing and Amazon In App Purchases. If you aren't using either of those services you can remove those additions if you wish.
<uses-permission android:name="com.android.vending.BILLING" />
<!-- GOOGLE PLAY BILLING -->
<meta-data android:name="com.google.android.play.billingclient.version" android:value="3.0.3" />
There are no required iOS additions to the application descriptor.
Checking for Support
You can use the
isSupported flag to determine if this extension is supported on the current platform and device.
This allows you to react to whether the functionality is available on the device and provide an alternative solution if not.
// Functionality here
This only checks if there is some functionality supported, not whether a particular billing service is available.