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.

Setup​

You should first gather some information for your application.

The Bundle Seed Id or App ID Prefix is an identifier for your iOS application. If you look at your application identifier in your developer portal you will see the App ID Prefix listed. It is of the form XYZ1234WCJ (10 alpha-numeric characters).

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.CloudStorage

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.CloudStorage.ane   # CloudStorage 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.CloudStorage

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

Document Storage​

If you plan to use document storage then you will need to create an iCloud container in your application identifier through the developer portal.

Find your application identifier then select the iCloud option and add your container. Take a note of the "cloud identifier" for the container as you will need this when configuring your application.

note

Document storage is not supported on Apple tvOS. If you are supporting this platform you should not include the com.apple.developer.ubiquity-container-identifiers key in your entitlements.

If you are supporting both platforms then we suggest you create a separate project / application descriptor for each and only add the following to your iOS project.

If you plan on using document storage in an iCloud container then you need to add some additional configuration. Firstly add a custom iOS configuration file by running:

apm generate config ios

Edit the config/ios/Entitlements.xml file that was generated to resemble the following, adding the com.apple.developer.ubiquity-container-identifiers node:

<plist version="1.0">
    <dict>

        <!-- ICLOUD ENTITLEMENTS -->
        <key>com.apple.developer.ubiquity-container-identifiers</key>
        <array>
            <string>${iCloudContainerId}</string>
        </array>

    </dict>
</plist>

The iCloudContainerId value will get inserted from your apm project configuration.

Once you have added this configuration run the steps above to update / generate your 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.

if (CloudStorage.isSupported)
{
    // Functionality here
}