Understanding ANE Setup instruction
When Adobe AIR Native Extensions were first introduced, implementing them in AIR apps were easy. because the number of available ANEs were limited and they were doing limited work. Today, it’s very hard to think an AIR app can succeed without using any ANEs! ANE Setup is becoming very confusing.
Imagine, the Firebase ANEs. Check out the implementation setup menu. It’s confusing and time-consuming. I’m sure we all agree on that. To avoid wasting time, we developed the ANELAB software. But still, there are some developers who have not joined the Myflashlabs Club so they can’t use the software. If you are reading this, it’s very likely that you are one of those developers 🙂 So, keep on reading because this post is for you.
When we started to develop ANELAB, we needed a solution for every ANE to somehow tell ANELAB how it must be implemented. To do this, we used the extension.xml file which is found in all ANEs. We invented a JSON specialized format which any ANE can use and the ANELAB software can read and understand how that ANE must be implemented in the project.
Take this as a simple example:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
{ "minAirVersion":"30.0", "minSwfVersion":"36", "miniOS":"8.0", "minAndroid":"15", "platforms":[ { "platform":"android", "dependencies":[ { "id":"com.myflashlab.air.extensions.dependency.overrideAir", "v":"5.1.4" } ], "manifest":[ { "node":"<xml><uses-permission android:name=\"android.permission.INTERNET\"/></xml>", "parent":"manifest", "sibling":"" } ] }, { "platform":"ios", "dependencies":[ { "id":"com.myflashlab.air.extensions.dependency.overrideAir", "v":"5.1.4" } ] } ] } |
The above instruction tells you that the minimum AIR SDK to compile this ANE is V30 and also you must make sure to set the -swf-version of your app to at least 36. It also tell you that this ANE will run on iOS devices 8.0 and above. Alike, it tells you that Android devices with API version lower than 15 cannot run this ANE.
On line 6, we have an Array “platforms” which holds two objects, one for Android and another for iOS. This tells you that this ANE supports Android and iOS and also there are some settings you need to do on each platform. Let’s check out the android platform first.
On line 9, we have an Array “dependencies”. It tells you that this ANE cannot run unless the listed dependencies are also included in your project. You can find all the available dependency ANEs from Myflashlabs, here: https://github.com/myflashlab/common-dependencies-ANE
On line 15, we have an Array “manifest”. This tells you what changes you must make to your manifest .xml file. In this example, it tells you that you must add one new node to your manifest.
|
1 |
<uses-permission android:name="android.permission.INTERNET"/> |
The good thing is that it also tells you where exactly to put the new node with the help of line 18 and 19. Line 18, tells you that the parent xml node of our tag is named manifest, So, you just need to located the manifest tag in your manifest .xml file and add the note to it. Let me give you a quick other example. if the parent value was manifest.application, then you could know that you should look for the application tag which itself is already under the manifest tag. So, you should have added the node under that application tag. We will give you more examples to know this locations better.
Ok, great, you are done with the android side. Let’s move on to the iOS side. Well, the iOS side has only one dependency and you’re good to go.
Congratulations! you have just been able to do what ANELAB is meant to do. All it does is to read these instruction blocks and automatically edit your app’s manifest file on your behalf. But don’t get too much excited. The sample instruction setup you saw above was a simple example to get you familiar with the overall format. Let’s now check out the instruction of the Firebase Core ANE.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 |
{ "minAirVersion":"30.0", "minSwfVersion":"36", "miniOS":"8.0", "minAndroid":"15", "inputValue":[ { "title":"Enter your application scheme", "value":"", "info":"<b>Application scheme</b><br><br>app scheme is usually your app package name for example 'air.com.site.app'.", "shortcode":"[APP_SCHEME]" } ], "platforms":[ { "platform":"android", "dependencies":[ { "id":"com.myflashlab.air.extensions.dependency.overrideAir", "v":"5.1.3" }, { "id":"com.myflashlab.air.extensions.dependency.androidSupport.arch", "v":"1.1.1" }, { "id":"com.myflashlab.air.extensions.dependency.androidSupport.core", "v":"27.1.1" }, { "id":"com.myflashlab.air.extensions.dependency.androidSupport.v4", "v":"27.1.1" }, { "id":"com.myflashlab.air.extensions.dependency.firebase.analytics", "v":"16.0.1" }, { "id":"com.myflashlab.air.extensions.dependency.firebase.analytics.impl", "v":"16.1.1" }, { "id":"com.myflashlab.air.extensions.dependency.firebase.common", "v":"16.0.0" }, { "id":"com.myflashlab.air.extensions.dependency.firebase.iid", "v":"16.2.0" }, { "id":"com.myflashlab.air.extensions.dependency.firebase.measurement.connector", "v":"16.0.0" }, { "id":"com.myflashlab.air.extensions.dependency.firebase.measurement.connector.impl", "v":"16.0.1" }, { "id":"com.myflashlab.air.extensions.dependency.googlePlayServices.ads", "v":"15.0.1" }, { "id":"com.myflashlab.air.extensions.dependency.googlePlayServices.base", "v":"15.0.1" }, { "id":"com.myflashlab.air.extensions.dependency.googlePlayServices.basement", "v":"15.0.1" }, { "id":"com.myflashlab.air.extensions.dependency.googlePlayServices.measurementBase", "v":"16.0.0" }, { "id":"com.myflashlab.air.extensions.dependency.googlePlayServices.stats", "v":"15.0.1" }, { "id":"com.myflashlab.air.extensions.dependency.googlePlayServices.tasks", "v":"15.0.1" } ], "manifest":[ { "node":"<xml><uses-permission android:name=\"android.permission.INTERNET\"/></xml>", "parent":"manifest", "sibling":"" }, { "node":"<xml><uses-permission android:name=\"android.permission.ACCESS_NETWORK_STATE\"/></xml>", "parent":"manifest", "sibling":"" }, { "node":"<xml><uses-permission android:name=\"android.permission.WAKE_LOCK\"/></xml>", "parent":"manifest", "sibling":"" }, { "node":"<xml><uses-sdk android:targetSdkVersion=\"26\"/></xml>", "parent":"manifest", "sibling":"" }, { "node":"<xml><uses-permission android:name=\"com.google.android.finsky.permission.BIND_GET_INSTALL_REFERRER_SERVICE\"/></xml>", "parent":"manifest", "sibling":"" }, { "node":"<xml><uses-permission android:name=\"com.google.android.c2dm.permission.RECEIVE\"/></xml>", "parent":"manifest", "sibling":"" }, { "node":"<xml><permission android:name=\"[PROJECT_ID].permission.C2D_MESSAGE\" android:protectionLevel=\"signature\"/></xml>", "parent":"manifest", "sibling":"" }, { "node":"<xml><uses-permission android:name=\"[PROJECT_ID].permission.C2D_MESSAGE\"/></xml>", "parent":"manifest", "sibling":"" }, { "node":"<xml><data android:scheme=\"[APP_SCHEME]\"/></xml>", "parent":"", "sibling":"<xml><category android:name=\"android.intent.category.BROWSABLE\"/></xml>" }, { "node":"<xml><receiver android:name=\"com.google.android.gms.measurement.AppMeasurementReceiver\" android:enabled=\"true\" android:exported=\"false\"/></xml>", "parent":"manifest.application", "sibling":"" }, { "node":"<xml><service android:name=\"com.google.android.gms.measurement.AppMeasurementService\" android:enabled=\"true\" android:exported=\"false\"/></xml>", "parent":"manifest.application", "sibling":"" }, { "node":"<xml><service android:name=\"com.google.android.gms.measurement.AppMeasurementJobService\" android:enabled=\"true\" android:exported=\"false\" android:permission=\"android.permission.BIND_JOB_SERVICE\"/></xml>", "parent":"manifest.application", "sibling":"" }, { "node":"<xml><receiver android:name=\"com.google.android.gms.measurement.AppMeasurementInstallReferrerReceiver\" android:enabled=\"true\" android:exported=\"true\" android:permission=\"android.permission.INSTALL_PACKAGES\"><intent-filter><action android:name=\"com.android.vending.INSTALL_REFERRER\"/></intent-filter></receiver></xml>", "parent":"manifest.application", "sibling":"" }, { "node":"<xml><provider android:name=\"com.google.firebase.provider.FirebaseInitProvider\" android:authorities=\"[PROJECT_ID].firebaseinitprovider\" android:exported=\"false\" android:initOrder=\"100\"/></xml>", "parent":"manifest.application", "sibling":"" }, { "node":"<xml><service android:name=\"com.google.firebase.components.ComponentDiscoveryService\"/></xml>", "parent":"manifest.application", "sibling":"" }, { "node":"<xml><meta-data android:name=\"com.google.firebase.components:com.google.firebase.iid.Registrar\" android:value=\"com.google.firebase.components.ComponentRegistrar\"/></xml>", "parent":"manifest.application.service{name:com.google.firebase.components.ComponentDiscoveryService}", "sibling":"" }, { "node":"<xml><meta-data android:name=\"com.google.firebase.components:com.google.firebase.analytics.connector.internal.AnalyticsConnectorRegistrar\" android:value=\"com.google.firebase.components.ComponentRegistrar\"/></xml>", "parent":"manifest.application.service{name:com.google.firebase.components.ComponentDiscoveryService}", "sibling":"" }, { "node":"<xml><meta-data android:name=\"com.google.android.gms.version\" android:value=\"@integer/google_play_services_version\"/></xml>", "parent":"manifest.application", "sibling":"" }, { "node":"<xml><receiver android:name=\"com.google.firebase.iid.FirebaseInstanceIdReceiver\" android:exported=\"true\" android:permission=\"com.google.android.c2dm.permission.SEND\"><intent-filter><action android:name=\"com.google.android.c2dm.intent.RECEIVE\"/><action android:name=\"com.google.android.c2dm.intent.REGISTRATION\"/><category android:name=\"[PROJECT_ID]\"/></intent-filter></receiver></xml>", "parent":"manifest.application", "sibling":"" }, { "node":"<xml><service android:name=\"com.google.firebase.iid.FirebaseInstanceIdService\" android:exported=\"true\"><intent-filter android:priority=\"-500\"><action android:name=\"com.google.firebase.INSTANCE_ID_EVENT\"/></intent-filter></service></xml>", "parent":"manifest.application", "sibling":"" }, { "node":"<xml><activity android:name=\"com.google.android.gms.common.api.GoogleApiActivity\" android:theme=\"@android:style/Theme.Translucent.NoTitleBar\" android:exported=\"false\"/></xml>", "parent":"manifest.application", "sibling":"" } ], "applicationAtt":[ { "name":"name", "value":"android.support.multidex.MultiDexApplication" } ] }, { "platform":"ios", "dependencies":[ { "id":"com.myflashlab.air.extensions.dependency.overrideAir", "v":"5.1.3" } ], "frameworks":[ { "name":"FirebaseAnalytics.framework", "url":"https://dl.google.com/firebase/sdk/ios/5_4_1/Firebase-5.4.1.zip", "sdk":"firebase", "v":"5.4.1" }, { "name":"FirebaseCore.framework", "url":"https://dl.google.com/firebase/sdk/ios/5_4_1/Firebase-5.4.1.zip", "sdk":"firebase", "v":"5.4.1" }, { "name":"FirebaseCoreDiagnostics.framework", "url":"https://dl.google.com/firebase/sdk/ios/5_4_1/Firebase-5.4.1.zip", "sdk":"firebase", "v":"5.4.1" }, { "name":"FirebaseNanoPB.framework", "url":"https://dl.google.com/firebase/sdk/ios/5_4_1/Firebase-5.4.1.zip", "sdk":"firebase", "v":"5.4.1" }, { "name":"FirebaseInstanceID.framework", "url":"https://dl.google.com/firebase/sdk/ios/5_4_1/Firebase-5.4.1.zip", "sdk":"firebase", "v":"5.4.1" }, { "name":"GoogleToolboxForMac.framework", "url":"https://dl.google.com/firebase/sdk/ios/5_4_1/Firebase-5.4.1.zip", "sdk":"firebase", "v":"5.4.1" }, { "name":"nanopb.framework", "url":"https://dl.google.com/firebase/sdk/ios/5_4_1/Firebase-5.4.1.zip", "sdk":"firebase", "v":"5.4.1" } ] } ], "manualExtra":"%3Cp%20align%3D%22left%22%3EBefore%20installing%20the%20Firebase%20Core%20ANE%2C%20you%20should%20have%20setup%20your%20Firebase%20app%20on%20%3Cfont%20color%3D%22%23990000%22%3E%3Ca%20href%3D%22https%3A%2F%2Fconsole.firebase.google.com%22%3Efirebase%20console%20page%3C%2Fa%3E%3C%2Ffont%3E.%20When%20that%20step%20is%20completed%2C%20you%20should%20download%20your%20Firebase%20configuration%20files.%20They%20are%20named%20%3Cfont%20color%3D%22%23990000%22%3Egoogle-services.json%3C%2Ffont%3E%20for%20Android%20and%20%3Cfont%20color%3D%22%23990000%22%3EGoogleService-Info.plist%3C%2Ffont%3E%20for%20iOS.%20These%20files%20must%20be%20packaged%20at%20the%20root%20of%20your%20app%20just%20like%20any%20other%20resources.%3C%2Fp%3E" } |
On line 6, we have inputValue, ANELAB uses these inputValues to ask you for some values so it can place those values in appropriate locations in the manifest. Here on line 11, we have a shortcode being known as [APP_SCHEME]. This is just a place holder and the actual value must be replaced in the manifest in all places where the shortcode name is used. If you check the above instruction, you will see that on line 125 this shortcode has been used. So you know you must include the actual value instead of the String [APP_SCHEME].
Every inputValue or as we call them shortcode, has a description (line 10) which tells you what value must be used for this item.
It’s worthy to mention that the value of some common shortcodes are generated automatically by the ANELAB. For example, the shortcode [PROJECT_ID] on line 115. ANELAB automatically changes this shortcode with the package id of your application. it could be air.com.site.app for instance. So, everytime you see the [PROJECT_ID] shortcode, replace it with your app package name.
On line 190, we have applicationAtt; Android tags could have attributes and some ANEs may require different attributes. in our example, we know that we must add a new attribute to the application tag of our Android setup. The name of this attribute must be “name” as indicated at line 192 and its value must be “android.support.multidex.MultiDexApplication“ as indicated at line 193.
Now, let’s check out the iOS side. on line 205, we have an Array of frameworks. Our ANE depends on these frameworks to be able to compile. These frameworks must be copied to your AIR SDK/lib/aot/stub directory. And you know where to download them. Look at line 208, there is a url which you should download and extract in your computer, then look for the “FirebaseAnalytics.framework” file as mentioned at line 207. The same thing is true for all the other framework files. You should find them one by one and copy them to your AIR SDK/lib/aot/stub directory.
Some ANEs, may have some extra configurations which if they do, they will notify you on ANELAB using something like what you see On line 251, If you are doing things manually, you should be able to read these notes. We have urlencoded them so they won’t break the ANE and they will be decoded in ANELAB. However, it’s easy to read them. copy it first “%3Cp%20align%3D%22left%22%3EBefore%20installing%20the%20Firebase%20Core%20ANE%2C%20you%20should%20have%20setup%20your%20Firebase%20app%20on%20%3Cfont%20color%3D%22%23990000%22%3E%3Ca%20href%3D%22https%3A%2F%2Fconsole.firebase.google.com%22%3Efirebase%20console%20page%3C%2Fa%3E%3C%2Ffont%3E.%20When%20that%20step%20is%20completed%2C%20you%20should%20download%20your%20Firebase%20configuration%20files.%20They%20are%20named%20%3Cfont%20color%3D%22%23990000%22%3Egoogle-services.json%3C%2Ffont%3E%20for%20Android%20and%20%3Cfont%20color%3D%22%23990000%22%3EGoogleService-Info.plist%3C%2Ffont%3E%20for%20iOS.%20These%20files%20must%20be%20packaged%20at%20the%20root%20of%20your%20app%20just%20like%20any%20other%20resources.%3C%2Fp%3E” and decode it here: https://meyerweb.com/eric/tools/dencoder/ it’s a simple html block which now you can understand.
Please support the ANELAB software by joining the MyFlashLabs Club. ❤️