- 1. Introduction
- 2. Installation Guide
- 3. Configuration and Description
- 4. Questions or Issues
- 5. Licencing and Terms
This demo application demonstrates the usage of HMS Push Cordova Plugin.
-
Install Ionic CLI.
npm install -g @ionic/cli
-
Create a new Ionic project or use existing Ionic project.
- To create a new Ionic project, you can use
ionic start <name> <template> [options]
command. For more details please follow ionic start - Ionic Documentation.
-
Enable the Cordova integration if haven't done before.
ionic integrations enable cordova
-
Update the widget
id
property which is specified in theconfig.xml
file. -
Add the Android platform to the project if haven't done before.
ionic cordova platform add android
-
Install
HMS Push Cordova Plugin
to the project. You can either install the plugin throughnpm
or bydownloading from HMS Core Plugin page
.a. Run the following command in the root directory of your project to install it through npm.
ionic cordova plugin add @hmscore/cordova-plugin-hms-push
b. Or download the plugin from Plugin > Push Kit > Cordova Plugin page and run the following command in the root directory of your project to install it manually.
ionic cordova plugin add <hms_cordova_push_plugin_path>
-
If you want to enable Ionic Native support then run the following command.
npm install @ionic-native/core @hmscore/ionic-native-hms-push
-
Copy
agconnect-services.json
file to<project_root>/android/app
directory. -
Add
keystore(.jks)
andbuild.json
files to your project's root directory.
-
You can refer to 3rd and 4th steps of Generating a Signing Certificate Codelab tutorial page for generating keystore file.
-
Fill
build.json
file according to your keystore information. For example:{ "android": { "debug": { "keystore": "<keystore_file>.jks", "storePassword": "<keystore_password>", "alias": "<key_alias>", "password": "<key_password>" }, "release": { "keystore": "<keystore_file>.jks", "storePassword": "<keystore_password>", "alias": "<key_alias>", "password": "<key_password>" } } }
-
Run the application.
ionic cordova run android --device
-
Enable the Capacitor integration if haven't done before.
ionic integrations enable capacitor
-
Update the widget
appId
property which is specified in thecapacitor.config.json
file. -
Install
HMS Push Cordova Plugin
to the project. You can either install the plugin throughnpm
or bydownloading from HMS Core Plugin page
.a. Run the following command in the root directory of your project to install it through npm.
npm install @hmscore/cordova-plugin-hms-push
b. Or download the Plugin from Plugin > Push Kit > Cordova Plugin page and run the following command in the root directory of your project to install it manually.
npm install <hms_cordova_push_plugin_path>
-
If you want to enable Ionic Native support then run the following command.
npm install @ionic-native/core @hmscore/ionic-native-hms-push
-
Build Ionic app to generate resource files.
ionic build
-
Add the Android platform to the project if haven't done before.
npx cap add android
-
Copy
agconnect-services.json
file to<project_root>/android/app
directory. -
Copy
keystore(.jks)
file to<project_root>/android/app
directory.
- You can refer to 3rd and 4th steps of Generating a Signing Certificate Codelab tutorial page for generating keystore file.
- Open the
build.gradle
file in the<project_root>/android/app
directory.
-
Add
signingConfigs
entry to android according to your keystore information. -
Enable
signingConfig
configuration to debug and release flavors. -
Apply
com.huawei.agconnect
plugin.... android { ... // Add signingConfigs according to your keystore information signingConfigs { config { storeFile file('<keystore_file>.jks') storePassword '<keystore_password>' keyAlias '<key_alias>' keyPassword '<key_password>' } } buildTypes { debug { signingConfig signingConfigs.config // Enable signingConfig in debug flavor } release { signingConfig signingConfigs.config // Enable signingConfig in release flavor minifyEnabled false proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' } } } ... apply plugin: 'com.huawei.agconnect' // Apply com.huawei.agconnect plugin. This line must be added to the end of the file.
-
Open the
build.gradle
file in the<project_root>/android
directory. Add Huawei's maven repositories and agconnect classpath to the file.buildscript { repositories { /* <Other repositories> */ maven { url 'https://developer.huawei.com/repo/' } } dependencies { /* <Other dependencies> */ classpath 'com.huawei.agconnect:agcp:1.4.2.301' } } /* <Other build.gradle entries> */ allprojects { repositories { /* <Other repositories> */ maven { url 'https://developer.huawei.com/repo/' } } }
-
Open the project in Android Studio and run it.
npx cap open android
If you have questions about how to use HMS samples, try the following options:
- Stack Overflow is the best
place for any programming questions. Be sure to tag your question
with
huawei-mobile-services
. - GitHub is the official repository for these plugins, You can open an issue or submit your ideas.
- Huawei Developer Forum HMS Core Module is great for general questions, or seeking recommendations and opinions.
- Huawei Developer Docs is place to official documentation for all HMS Core Kits, you can find detailed documentations in there.
If you run into a bug in our samples, please submit an issue to the GitHub repository.
HMS Push Cordova Plugin is licensed under the Apache 2.0 license.