Skip to content

Latest commit

 

History

History

apm

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
.img
.img
 
 
www
www
 
 
LICENCE
LICENCE
 
 
README.md
README.md
 
 
config.xml
config.xml
 
 
package.json
package.json
 
 

README.md

AGC APM Cordova Demo

Contents

1. Introduction

This demo application demonstrates the usage of AGC App Performance Management (APM) Cordova plugin.

2. Installation Guide

Before you get started, you must register as a HUAWEI Developer and complete identity verification on the HUAWEI Developer website. For details, please refer to Register a HUAWEI ID.

2.1. Creating a Project in AppGallery Connect

Creating an app in AppGallery Connect is required in order to communicate with the Huawei services. To create an app, perform the following steps:

  1. Sign in to AppGallery Connect and select My projects.
  2. Select your project from the project list or create a new one by clicking the Add Project button.
  3. Go to Project settings > General information, and click Add app. If an app exists in the project and you need to add a new one, expand the app selection area on the top of the page and click Add app.
  4. On the Add app page, enter the app information, and click OK.

2.2. Obtaining agconnect-services.json and agconnect-services.plist

  1. Sign in to AppGallery Connect and select your project from My Projects. Then go to Project settings > General information. In the App information field,

    • If platform is Android, click agconnect-services.json button to download the configuration file.
    • If platform is iOS, click agconnect-services.plist button to download the configuration file.

2.3. Cordova

  1. Install Cordova CLI.

    npm install -g cordova

  2. Set preference in your Cordova project config.xml.

    <!--<platform name="ios">-->
 <preference name="deployment-target" value="11.0" />
 <preference name="SwiftVersion" value="5" />

  3. Update the widget id property which is specified in the config.xml file. It must be same with client > package_name value of the agconnect-services.json and agconnect-services.plist files.

  4. Add the Android or iOS platform to the project if haven't done before.

    cordova platform add android
    cordova platform add ios

  5. Install AGC APM Cordova Plugin to the project.

    • Run the following command in the root directory of your project to install it through npm.

      cordova plugin add @cordova-plugin-agconnect/apm --variable APMS_DEBUG_LOG_ENABLED="true" --variable SESSIONS_SAMPLING_PERCENTAGE="1.0" --variable COLLECT_CPU_FREQUENCY_FG_MS="100" --variable COLLECT_MEMORY_FREQUENCY_FG_MS="100" --save

2.3.1. iOS App Development

  1. Add agconnect-services.plist file to the app's root directory of your Xcode project.

  2. Check Signing & Capabilities tab page of your Xcode project.

  3. Run the application.

    cordova run ios --device

2.3.2. Android App Development

  1. Copy agconnect-services.json file to <project_root>/platforms/android/app directory your Android project.

  2. Open MainActivity.java class in your Cordova-Android project.

  3. Fields marked with red should be written in your MainActivity.java class.

  1. Run the application.

    cordova run android --device

3. Configuration and Description

No.

4. Development Environment

You are advised to use the plug-ins in an environment that meets the following requirements.

Software Allowed Version Range Description
cordova 9.0.0 or later Platform
cordova-android >=8.1.0 or later Platform
cordova-ios 5.0.0 or later Platform
npm 6.4.1 or later Tool

5. FAQs

No.

6. Licencing and Terms

AGC APM Cordova Plugin is licensed under the Apache 2.0 license.