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.facebook.Share
This will download and install the extension, required assets, and all dependencies.
apm will have created something like the following file structure:
| |____ ios
| | |____ Frameworks
| | | |____ [dynamic frameworks]
| |____ com.distriqt.facebook.Share.ane # Facebook Share extension
| |____ com.distriqt.facebook.Core.ane # Facebook Core extension
| |____ [dependencies]
|____ apm_packages # cache directory - ignore
|____ project.apm # apm project file
anedirectory to your IDE. See the tutorials located here on adding an extension to your IDE.
You will have an
assetsdirectory that contains required assets for the installed extensions. You must add the
assets/iosfolder to the root of your iOS application package. (The
iosfolder contains a
Frameworksfolder with the required iOS dynamic frameworks).
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 some configuration items such as the Facebook application identifier. If you installed
com.distriqt.facebook.Corealready you would have set these configuration values then. If not, call the following to step through the configuration values:
apm project config set com.distriqt.facebook.Core
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.
The Facebook Share SDK is contained in the
This extension depends upon the Facebook Core SDK so you will need to make sure you have added the
com.distriqt.facebook.Core extension before continuing.
There are no additional dependencies beyond the dependencies added for the facebook core extension.
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 Facebook Share extension requires some manifest additions beyond the ones you have added for the Facebook Core extension.
You should add the following to your manifest additions, you will need to replace
FACEBOOK_APP_ID with your Facebook App ID, the same way you did when adding the Core extension.
These additions should go inside the
application node in your manifest additions.
<!-- Share -->
Facebook is based on a dynamic framework so you must include the framework and dependent swift libs in your application for signing by AIR.
To do this create a
Frameworks directory at the top / root level of your application and ensure it is packaged with your AIR application.
If should contain any of the files in the supplied
Frameworks directory (including
framework directories) and any of the Facebook SDK components that you are using in your application.
The Core extension requires several frameworks so your
Frameworks directory should contain:
The Facebook Share extension doesn't require any info additions beyond the ones you have added for the Facebook Core extension.
However you should ensure that you added the
NSPhotoLibraryAddUsageDescription usage description strings as these will be used when sharing certain content.