Skip to content

Latest commit

 

History

History
300 lines (207 loc) · 13 KB

INSTALLATION.md

File metadata and controls

300 lines (207 loc) · 13 KB
Raw

Installation

Installation Requirements

Plugin version Cordova CLI Cordova Android Cordova iOS CocoaPods
1.0.0 10.0.0 8.0.0 5.1.1 1.8.0
2.0.0 10.0.0 8.0.0 6.0.0 1.8.0
3.0.0 10.0.0 9.0.0 6.0.0 1.8.0
4.0.0 10.0.0 12.0.0 6.0.0 1.8.0

To install from the command line:

cordova plugin add @havesource/cordova-plugin-push

It is also possible to install via repo url directly (unstable)

or

cordova plugin add github:havesource/cordova-plugin-push

To configure the SENDER_ID, place your google-services.json (Android) and/or GoogleService-Info.plist in the root folder of your project and then add the following lines into your config.xml.

In the platform tag for Android add the following resource-file tag if you are using cordova-android 8.0 or greater:

E.g.

<platform name="android">
  <resource-file src="google-services.json" target="/app/google-services.json" />
</platform>

By default, on iOS, the plugin will register with APNS. If you want to use FCM on iOS, in the platform tag for iOS add the following resource-file tag:

<platform name="ios">
  <resource-file src="GoogleService-Info.plist" />
</platform>

Note: if you are using Ionic you may need to specify the SENDER_ID variable in your package.json.

  "cordovaPlugins": [
    {
      "locator": "phonegap-plugin-push"
    }
  ]

Note: You need to specify the SENDER_ID variable in your config.xml if you plan on installing/restoring plugins using the prepare method. The prepare method will skip installing the plugin otherwise.

<plugin name="@havesource/cordova-plugin-push" spec="3.0.0" />

Cordova-Android 9.x Specifics

Using AndroidX Library:

As of version 3.0.0, this plugin has migrated from the Android Support Library to AndroidX. Since Cordova-Android 9.x does not use the AndroidX library by default, you will need to install the cordova-plugin-androidx-adapter plugin.

This plugin will migrate any Android Support Library references to AndroidX.

Please note that this will also migrate references of other plugins.

If you are using Cordova Android 8.x please continue reading in the Cordova Android 8.x Specifics section.

Android details

Co-existing with Facebook Plugin

There are a number of Cordova Facebook Plugins available but the one that we recommend is Jeduan's fork of the original Wizcorp plugin. It is setup to use Gradle/Maven and the latest Facebook SDK properly.

To add to your app:

cordova plugin add cordova-plugin-facebook4 --variable APP_ID="App ID" --variable APP_NAME="App Name"

Co-existing with plugins that use Firebase

Problems may arise when push plugin is used along plugins that implement Firebase functionality (e.g. cordova-plugin-firebase-analytics). Both plugins include a version of the FCM libraries.

To make the two work together, you need to migrate your GCM project from Google console to Firebase console:

  1. In Firebase console - import your existing GCM project, don't create a new one.
  2. Set your FCM_VERSION variable to match the version used in the other plugin. In case of Cordova, your package.json contains something like this:
{
  "cordova": {
    "plugins": {
      "@havesource/cordova-plugin-push": {
        "ANDROIDX_CORE_VERSION": "1.6.+",
        "FCM_VERSION": "18.+"
      }
    },
    "platforms": []
  }
}

Note: No changes on the back-end side are needed: even though recommended, it isn't yet required and sending messages through GCM gateway should work just fine.

Note: The FCM_VERSION must be greater than or equal to 17.1.0 and less than or equal to 18.0.0.

Common errors

Multidex

If you have an issue compiling the app and you're getting an error similar to this (com.android.dex.DexException: Multiple dex files define):

UNEXPECTED TOP-LEVEL EXCEPTION:
com.android.dex.DexException: Multiple dex files define Landroid/support/annotation/AnimRes;
	at com.android.dx.merge.DexMerger.readSortableTypes(DexMerger.java:596)
	at com.android.dx.merge.DexMerger.getSortedTypes(DexMerger.java:554)
	at com.android.dx.merge.DexMerger.mergeClassDefs(DexMerger.java:535)
	at com.android.dx.merge.DexMerger.mergeDexes(DexMerger.java:171)
	at com.android.dx.merge.DexMerger.merge(DexMerger.java:189)
	at com.android.dx.command.dexer.Main.mergeLibraryDexBuffers(Main.java:502)
	at com.android.dx.command.dexer.Main.runMonoDex(Main.java:334)
	at com.android.dx.command.dexer.Main.run(Main.java:277)
	at com.android.dx.command.dexer.Main.main(Main.java:245)
	at com.android.dx.command.Main.main(Main.java:106)

Then at least one other plugin you have installed is using an outdated way to declare dependencies such as android-support or play-services-gcm. This causes gradle to fail, and you'll need to identify which plugin is causing it and request an update to the plugin author, so that it uses the proper way to declare dependencies for cordova. See this for the reference on the cordova plugin specification, it'll be usefull to mention it when creating an issue or requesting that plugin to be updated.

Common plugins to suffer from this outdated dependency management are plugins related to facebook, google+, notifications, crosswalk and google maps.

More than one library with package name 'com.google.android.gms'

When some other packages include cordova-google-play-services as a dependency, such as is the case with the cordova-admob and cordova-plugin-analytics plugins, it is impossible to also add the @havesource/cordova-plugin-push, for the following error will rise during the build process:

:processDebugResources FAILED
FAILURE: Build failed with an exception.

What went wrong: Execution failed for task ':processDebugResources'. > Error: more than one library with package name 'com.google.android.gms'

Those plugins should be using gradle to include the Google Play Services package but instead they include the play services jar directly or via a plugin dependency. So all of that is bad news. These plugins should be updated to use gradle. Please raise issues on those plugins as the change is not hard to make.

In fact there is a PR open to do just that appfeel/analytics-google#11 for cordova-plugin-analytics. You should bug the team at appfeel to merge that PR.

Alternatively, switch to another plugin that provides the same functionality but uses gradle:

https://github.com/danwilson/google-analytics-plugin https://github.com/cmackay/google-analytics-plugin

Browser details

For the time being, push support on the browser is not supported. The original plugin used the PhoneGap push server which may no longer be active.

Browser Support

Chrome 49+ Firefox 46+

iOS details

System & Cordova Requirements

System:

  • Xcode: 11.0 or greater.
  • CocoaPods: 1.8.0 or greater. Preferably 1.9.x
  • Ruby: 2.0.0 or greater.

Cordova:

  • cordova-cli: 10.0.0 or greater.
  • cordova-ios: 6.0.0 or greater. Preferably 6.1.x

Bitcode

If you are running into a problem where the linker is complaining about bit code. For instance:

ld: '<file.o>' does not contain bitcode. You must rebuild it with bitcode enabled (Xcode setting ENABLE_BITCODE), obtain an updated library from the vendor, or disable bitcode for this target. for architecture arm64 clang: error: linker command failed with exit code 1 (use -v to see invocation)

You have two options. The first is to disable bitcode as per this StackOverflow answer or upgrade to cordova-ios 6.0.0 or greater.

cordova platform rm ios
cordova platform add [email protected]

CocoaPods

To install CocoaPods, please follow the installation instructions here. Since version 1.8.0 and greater, the pod repo no longer needs to be setup or fetched. Pods specs will be fetched directly from the CocoaPods CDN.

If you are upgrading from an older version, it might be best to uninstall first the older version and remove the ~/.cocoapods/ directory.

This plugin uses the Firebase/Messaging library.

Common CocoaPod Installation issues

If you are attempting to install this plugin and you run into this error:

Installing "@havesource/cordova-plugin-push" for ios
Failed to install '@havesource/cordova-plugin-push':Error: pod: Command failed with exit code 1
    at ChildProcess.whenDone (/Users/smacdona/code/push151/platforms/ios/cordova/node_modules/cordova-common/src/superspawn.js:169:23)
    at emitTwo (events.js:87:13)
    at ChildProcess.emit (events.js:172:7)
    at maybeClose (internal/child_process.js:818:16)
    at Process.ChildProcess._handle.onexit (internal/child_process.js:211:5)
Error: pod: Command failed with exit code 1

Please try to add the plugin again, with the --verbose flag. The above error is generic and can actually be caused by a number of reasons. The --verbose flag should help display the exact cause of the install failure.

One of the most common reason is that it is trying to fetch the podspec from the CocoaPods repo and the repo is out-of-date. It recommended to use CocoaPods CDN over the repo. If your using an older version of CocoaPods, it is recommend to upgrade with a fresh installation.

With a fresh installations, you should have one repo source which can be checked with the pod repo command.

$ pod repo

trunk
- Type: CDN
- URL:  https://cdn.cocoapods.org/
- Path: /Users/home/.cocoapods/repos/trunk

1 repo
Library not found for -lPods-Appname

If you open the app in Xcode and you get an error like:

ld: library not found for -lPods-Appname
clang: error: linker command failed with exit code 1

Then you are opening the .xcodeproj file when you should be opening the .xcworkspace file.

Library not found for -lGoogleToolboxForMac

Trying to build for iOS using the latest cocoapods (1.9.3) but failed with the following error (from terminal running cordova build ios):

ld: library not found for -lGoogleToolboxForMac

Workarounds are to add the platform first and install the plugins later, or to manually run pod install on projectName/platforms/ios.

Another workaround is to go to build phases in your project at Link Binary Libraries and add libPods-PROJECTNAME.a and libGoogleToolboxForMac.a

Additional Resources

The push plugin enables you to play sounds and display different icons during push (Android only). These additional resources need to be added to your projects platforms directory in order for them to be included into your final application binary.

You can now use the resource-file tag to deliver the image and sound files to your application. For example if you wanted to include an extra image file for only your Android build you would add the resource-file tag to your android platform tag:

<platform name="android">
  <resource-file src="myImage.png" target="res/drawable/myImage.png" />
</platform>

or if you wanted to include a sound file for iOS:

<platform name="ios">
  <resource-file src="mySound.caf" />
</platform>