metamap-capacitor-plugin 3.2.0 → 3.4.0

package/README.md

@@ -1,42 +1,53 @@
 ---
 title: "Capacitor"
-excerpt: "Add the MetaMap button to your Capacitor app."
-slug: "capacitor-sdk"
-category: 61ae8e8dba577a0010791480
+excerpt: "Add the Metamap button to your Capacitor app."
+slug: "mobile-sdks"
+category: 61141a8437375100442f3d20
 ---
 
-# MetaMap for Capacitor Usage Guide
+# Metamap for Capacitor Usage Guide
 
-The following instructions use command line tools to install MetaMap for Capacitor to your existing Capacitor application.
+This is a guide to implement Metamap in the [Ionic Capacitor framework](https://capacitorjs.com/docs).
 
-1. Use the following CLI to install MetaMap for your Capacitor project.
+## Capacitor Demo App
+
+You can go to GitHub to download the [Metamap Capacitor demo app](https://github.com/GetMati/mati-mobile-examples/tree/main/capacitorDemoApp).
+
+## Install Metamap for Capacitor
+
+The following instructions use command line tools to install Metamap for Capacitor to your existing Capacitor application.
+
+1. Use the following CLI to install Metamap for your Capacitor project.
 ```bash
 npm i metamap-capacitor-plugin
-  ```
+ ```
 
-2. Build your application.
+1. Build your application.
 ```bash
 ionic build
-  ```
-3. Update the Capacitor files.
+ ```
+
+1. Update the Capacitor files.
 ```bash
 npx cap sync
-  ```
+```
+
+## Add the Metamap Button
 
-4. Add the MetaMap button to your application's HTML and JavaScript files.
+Add the Metamap button to your application's HTML and JavaScript files.
 
 `your_index.html`
 
 ```html
 <ion-content>
-    <ion-button className="metaMapButtonCss" (click)="showMetaMapFlow()">Show MetaMapFlow
-    </ion-button>
+   <ion-button className="matiButtonCss" (click)="showMatiFlow()">Show MatiFlow
+   </ion-button>
 </ion-content>
 ```
 
-`your_index.ts`
+ `your_index.ts`
 
-```bash
+```json
 import { Component } from '@angular/core';
 
 import { MetaMapCapacitor } from "metamap-capacitor-plugin";
@@ -49,11 +60,11 @@ import { MetaMapCapacitor } from "metamap-capacitor-plugin";
 export class HomePage {
   constructor() {}
 
-  showMetaMapFlow() {
+  showMatiFlow() {
     let metadataParams = { param1: "value1" };
-    let registerParams = { clientId: "YOUR_CLIENT_ID", flowId: "YOUR_FLOW_ID", metadata: metadataParams};
+    let registerParams = { clientId: "5c94e3c401ddc6001be83c07", flowId: "5e962a23728ddc001b5937aa", metadata: metadataParams};
 
-    MetaMapCapacitor.showMetaMapFlow(registerParams)
+    MatiCapacitor.showMatiFlow(registerParams)
       .then( verification => console.log("verification success:" + verification.verificationId))
       .catch(() => console.log("verification cancelled"))
   }
@@ -62,7 +73,6 @@ export class HomePage {
 
 ## Launch for Android
 
-1. Run the following command to launch the application for Android:
 ```bash
 ionic capacitor run android
 ```
@@ -70,63 +80,63 @@ ionic capacitor run android
 # Launch for iOS
 
 1. Set minimum iOS version in `capacitor.config.json`
- ```bash
-"ios": {
-  "minVersion": "12.0"
-  }
+```json
+     "ios": {
+      "minVersion": "12.0"
+    }
 ```
 
-2. Add the following to info.plist:
+1. Add the following to info.plist:
 ```bash
-<key>NSCameraUsageDescription</key>
-<string>MetaMap verification SDK requires camera use</string>
+    <key>NSCameraUsageDescription</key>
+    <string>MetaMap verification SDK requires camera use</string>
 
-<key>NSMicrophoneUsageDescription</key>
-<string>MetaMap verification SDK requires microphone use</string>
+    <key>NSMicrophoneUsageDescription</key>
+    <string>MetaMap verification SDK requires microphone use</string>
 
-<key>NSPhotoLibraryUsageDescription</key>
-<string>MetaMap verification SDK requires access to media library</string>
+    <key>NSPhotoLibraryUsageDescription</key>
+    <string>MetaMap verification SDK requires access to media library</string>
 
-<key>NSLocationWhenInUseUsageDescription</key>
-<string>MetaMap will use your location information to provide best possible verification experience.</string>
+    <key>NSLocationWhenInUseUsageDescription</key>
+    <string>MetaMap will use your location information to provide best possible verification experience.</string>
 
-<key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
-<string>MetaMap will use your location information to provide best possible verification experience.</string>
+    <key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
+    <string>MetaMap will use your location information to provide best possible verification experience.</string>
 
-<key>NSLocationAlwaysUsageDescription</key>
-<string>MetaMap will use your location information to provide best possible verification experience.</string>
-```
+    <key>NSLocationAlwaysUsageDescription</key>
+    <string>MetaMap will use your location information to provide best possible verification experience.</string>
+  ```
 
-3. Launch the application for iOS
+1. Launch the application for iOS
 ```bash
 ionic capacitor run ios
-```
-
-3. Launch the application for android
-```bash
-ionic capacitor run android
-```
-
-4. ## Metadata is an additional optional parameters:
+  ```
 
-4.1. Set the Language:
+## Metadata is an additional optional parameters:
 
+1. Set the Language:
 ```bash
 metadata: {"fixedLanguage": "es"}
 ```
-4.2. Set the Button Color:
 
+1.  Set the Button Color:
 ```bash
 metadata: {"buttonColor": "hexColor"}
-   ```
-
-4.3. Set the Title color of the button:
+```
 
+1. Set the Title color of the button:
 ```bash
 metadata: {"buttonTextColor": "hexColor"}
    ```
-
-4.4. Set identity Id as parameter for re-verification:
+   
+1. Set identity Id as parameter for re-verification:
 ```bash
 metadata: {"identityId": "value"}
-   ```
+```
+
+
+## Some error codes you may get during integration
+
+`402` - MetaMap services are not paid: please contact your customer success manager
+
+`403` - MetaMap credentials issues: please check your client id and MetaMap id

package/android/build.gradle

@@ -51,5 +51,5 @@ dependencies {
     implementation fileTree(dir: 'libs', include: ['*.jar'])
     implementation project(':capacitor-android')
     implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
-    implementation ('com.metamap:android-sdk:3.22.5')
+    implementation ('com.metamap:android-sdk:3.22.6')
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "metamap-capacitor-plugin",
-  "version": "3.2.0",
+  "version": "3.4.0",
   "description": "Capacitor plugin for MetaMapSDK",
   "main": "dist/plugin.js",
   "module": "dist/esm/index.js",