capacitor-gleap-plugin 8.2.5 → 8.4.1

package/CapacitorGleapPlugin.podspec

@@ -13,6 +13,6 @@ Pod::Spec.new do |s|
   s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
   s.ios.deployment_target  = '12.0'
   s.dependency 'Capacitor'
-  s.dependency 'Gleap', '8.2.4'
+  s.dependency 'Gleap', '8.4.1'
   s.swift_version = '5.1'
 end

package/README.md

@@ -30,14 +30,20 @@ npx cap sync
 * [`removeCustomData(...)`](#removecustomdata)
 * [`clearCustomData()`](#clearcustomdata)
 * [`trackEvent(...)`](#trackevent)
+* [`trackPage(...)`](#trackpage)
 * [`setEventCallback(...)`](#seteventcallback)
 * [`sendSilentCrashReport(...)`](#sendsilentcrashreport)
 * [`preFillForm(...)`](#prefillform)
 * [`addAttachment(...)`](#addattachment)
 * [`removeAllAttachments()`](#removeallattachments)
 * [`open()`](#open)
-* [`openNews()`](#opennews)
-* [`openFeatureRequests()`](#openfeaturerequests)
+* [`openNews(...)`](#opennews)
+* [`openNewsArticle(...)`](#opennewsarticle)
+* [`openHelpCenter(...)`](#openhelpcenter)
+* [`openHelpCenterArticle(...)`](#openhelpcenterarticle)
+* [`openHelpCenterCollection(...)`](#openhelpcentercollection)
+* [`searchHelpCenter(...)`](#searchhelpcenter)
+* [`openFeatureRequests(...)`](#openfeaturerequests)
 * [`close()`](#close)
 * [`isOpened()`](#isopened)
 * [`startFeedbackFlow(...)`](#startfeedbackflow)
@@ -74,14 +80,14 @@ Initialize Gleap with an API key
 ### identify(...)
 
 ```typescript
-identify(options: { userId: string; userHash?: string; name?: string; email?: string; phone?: string; value?: number; }) => Promise<{ identify: boolean; }>
+identify(options: { userId: string; userHash?: string; name?: string; email?: string; phone?: string; value?: number; customData?: Object; }) => Promise<{ identify: boolean; }>
 ```
 
 Set user identity
 
-| Param         | Type                                                                                                               |
-| ------------- | ------------------------------------------------------------------------------------------------------------------ |
-| **`options`** | <code>{ userId: string; userHash?: string; name?: string; email?: string; phone?: string; value?: number; }</code> |
+| Param         | Type                                                                                                                                                          |
+| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`options`** | <code>{ userId: string; userHash?: string; name?: string; email?: string; phone?: string; value?: number; customData?: <a href="#object">Object</a>; }</code> |
 
 **Returns:** <code>Promise&lt;{ identify: boolean; }&gt;</code>
 
@@ -245,6 +251,25 @@ Log event to Gleap
 --------------------
 
 
+### trackPage(...)
+
+```typescript
+trackPage(options: { pageName: string; }) => Promise<{ trackedPage: boolean; }>
+```
+
+Track a page view
+
+| Param         | Type                               |
+| ------------- | ---------------------------------- |
+| **`options`** | <code>{ pageName: string; }</code> |
+
+**Returns:** <code>Promise&lt;{ trackedPage: boolean; }&gt;</code>
+
+**Since:** 8.4.1
+
+--------------------
+
+
 ### setEventCallback(...)
 
 ```typescript
@@ -349,32 +374,135 @@ Open widget
 --------------------
 
 
-### openNews()
+### openNews(...)
 
 ```typescript
-openNews() => Promise<{ openedNews: boolean; }>
+openNews(options: { showBackButton?: boolean; }) => Promise<{ openedNews: boolean; }>
 ```
 
 Open news
 
+| Param         | Type                                       |
+| ------------- | ------------------------------------------ |
+| **`options`** | <code>{ showBackButton?: boolean; }</code> |
+
 **Returns:** <code>Promise&lt;{ openedNews: boolean; }&gt;</code>
 
-**Since:** 8.0.4
+**Since:** 8.4.0
+
+--------------------
+
+
+### openNewsArticle(...)
+
+```typescript
+openNewsArticle(options: { articleId: string; showBackButton?: boolean; }) => Promise<{ opened: boolean; }>
+```
+
+Open news article
+
+| Param         | Type                                                          |
+| ------------- | ------------------------------------------------------------- |
+| **`options`** | <code>{ articleId: string; showBackButton?: boolean; }</code> |
+
+**Returns:** <code>Promise&lt;{ opened: boolean; }&gt;</code>
+
+**Since:** 8.4.0
+
+--------------------
+
+
+### openHelpCenter(...)
+
+```typescript
+openHelpCenter(options: { showBackButton?: boolean; }) => Promise<{ opened: boolean; }>
+```
+
+Open help center
+
+| Param         | Type                                       |
+| ------------- | ------------------------------------------ |
+| **`options`** | <code>{ showBackButton?: boolean; }</code> |
+
+**Returns:** <code>Promise&lt;{ opened: boolean; }&gt;</code>
+
+**Since:** 8.4.0
+
+--------------------
+
+
+### openHelpCenterArticle(...)
+
+```typescript
+openHelpCenterArticle(options: { articleId: string; showBackButton?: boolean; }) => Promise<{ opened: boolean; }>
+```
+
+Open help center article
+
+| Param         | Type                                                          |
+| ------------- | ------------------------------------------------------------- |
+| **`options`** | <code>{ articleId: string; showBackButton?: boolean; }</code> |
+
+**Returns:** <code>Promise&lt;{ opened: boolean; }&gt;</code>
+
+**Since:** 8.4.0
+
+--------------------
+
+
+### openHelpCenterCollection(...)
+
+```typescript
+openHelpCenterCollection(options: { collectionId: string; showBackButton?: boolean; }) => Promise<{ opened: boolean; }>
+```
+
+Open help center collection
+
+| Param         | Type                                                             |
+| ------------- | ---------------------------------------------------------------- |
+| **`options`** | <code>{ collectionId: string; showBackButton?: boolean; }</code> |
+
+**Returns:** <code>Promise&lt;{ opened: boolean; }&gt;</code>
+
+**Since:** 8.4.0
+
+--------------------
+
+
+### searchHelpCenter(...)
+
+```typescript
+searchHelpCenter(options: { term: string; showBackButton?: boolean; }) => Promise<{ opened: boolean; }>
+```
+
+Search help center
+
+| Param         | Type                                                     |
+| ------------- | -------------------------------------------------------- |
+| **`options`** | <code>{ term: string; showBackButton?: boolean; }</code> |
+
+**Returns:** <code>Promise&lt;{ opened: boolean; }&gt;</code>
+
+**Since:** 8.4.0
 
 --------------------
 
 
-### openFeatureRequests()
+### openFeatureRequests(...)
 
 ```typescript
-openFeatureRequests() => Promise<{ openedFeatureRequests: boolean; }>
+openFeatureRequests(options: { showBackButton?: boolean; }) => Promise<{ openedFeatureRequests: boolean; }>
 ```
 
 Open feature requests
 
+| Param         | Type                                       |
+| ------------- | ------------------------------------------ |
+| **`options`** | <code>{ showBackButton?: boolean; }</code> |
+
 **Returns:** <code>Promise&lt;{ openedFeatureRequests: boolean; }&gt;</code>
 
-**Since:** 8.0.5
+**Since:** 8.4.0
 
 --------------------
 
@@ -499,6 +627,43 @@ Enable debug console log
 ### Interfaces
 
 
+#### Object
+
+Provides functionality common to all JavaScript objects.
+
+| Prop              | Type                                          | Description                                                                                                                                |
+| ----------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
+| **`constructor`** | <code><a href="#function">Function</a></code> | The initial value of <a href="#object">Object</a>.prototype.constructor is the standard built-in <a href="#object">Object</a> constructor. |
+
+| Method                   | Signature                                       | Description                                                              |
+| ------------------------ | ----------------------------------------------- | ------------------------------------------------------------------------ |
+| **toString**             | () =&gt; string                                 | Returns a string representation of an object.                            |
+| **toLocaleString**       | () =&gt; string                                 | Returns a date converted to a string using the current locale.           |
+| **valueOf**              | () =&gt; <a href="#object">Object</a>           | Returns the primitive value of the specified object.                     |
+| **hasOwnProperty**       | (v: PropertyKey) =&gt; boolean                  | Determines whether an object has a property with the specified name.     |
+| **isPrototypeOf**        | (v: <a href="#object">Object</a>) =&gt; boolean | Determines whether an object exists in another object's prototype chain. |
+| **propertyIsEnumerable** | (v: PropertyKey) =&gt; boolean                  | Determines whether a specified property is enumerable.                   |
+
+
+#### Function
+
+Creates a new function.
+
+| Prop            | Type                                          |
+| --------------- | --------------------------------------------- |
+| **`prototype`** | <code>any</code>                              |
+| **`length`**    | <code>number</code>                           |
+| **`arguments`** | <code>any</code>                              |
+| **`caller`**    | <code><a href="#function">Function</a></code> |
+
+| Method       | Signature                                                                            | Description                                                                                                                                                                                                              |
+| ------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| **apply**    | (this: <a href="#function">Function</a>, thisArg: any, argArray?: any) =&gt; any     | Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.                                                                     |
+| **call**     | (this: <a href="#function">Function</a>, thisArg: any, ...argArray: any[]) =&gt; any | Calls a method of an object, substituting another object for the current object.                                                                                                                                         |
+| **bind**     | (this: <a href="#function">Function</a>, thisArg: any, ...argArray: any[]) =&gt; any | For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters. |
+| **toString** | () =&gt; string                                                                      | Returns a string representation of a function.                                                                                                                                                                           |
+
+
 #### Boolean
 
 | Method      | Signature        | Description                                          |

package/android/build.gradle

@@ -53,7 +53,7 @@ dependencies {
     testImplementation "junit:junit:$junitVersion"
     androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
     androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
-    implementation group: 'io.gleap', name: 'gleap-android-sdk', version: '8.2.3'
+    implementation group: 'io.gleap', name: 'gleap-android-sdk', version: '8.4.3'
     if (rootProject && rootProject.ext) {
         if (rootProject.ext.targetSdkVersion == 30 || rootProject.ext.compileSdkVersion == 30) {
             implementation( "androidx.appcompat:appcompat:1.3.0") {

package/android/src/main/java/com/congrapp/b2c/plugins/gleap/GleapPlugin.java

@@ -92,6 +92,9 @@ public class GleapPlugin extends Plugin {
         if (call.getData().has("userHash")) {
             userProperties.setHash(call.getString("userHash"));
         }
+        if (call.getData().has("customData")) {
+            userProperties.setCustomData(call.getObject("customData"));
+        }
 
         String userId = call.getString("userId");
         implementation.identifyUser(userId, userProperties);
@@ -287,6 +290,29 @@ public class GleapPlugin extends Plugin {
         call.resolve(ret);
     }
 
+    @PluginMethod()
+    public void trackPage(PluginCall call) {
+        // If page name is empty, then pass back error
+        if (!call.getData().has("pageName")) {
+            call.reject("No page name provided");
+            return;
+        }
+
+        try {
+            String pageName = call.getString("pageName");
+            JSONObject eventData = new JSONObject();
+            eventData.put("page", pageName);
+            implementation.trackEvent("pageView", eventData);
+        } catch (Exception ignore) {
+
+        }
+
+        // Build Json object and resolve success
+        JSObject ret = new JSObject();
+        ret.put("trackedPage", true);
+        call.resolve(ret);
+    }
+
     @PluginMethod()
     public void addAttachment(PluginCall call) {
         if (!call.getData().has("base64data")) {
@@ -438,8 +464,9 @@ public class GleapPlugin extends Plugin {
 
     @PluginMethod()
     public void openNews(PluginCall call) throws GleapNotInitialisedException {
-        // Open news
-        implementation.openNews();
+        boolean showBackButton = call.getBoolean("showBackButton");
+
+        implementation.openNews(showBackButton);
 
         // Build Json object and resolve success
         JSObject ret = new JSObject();
@@ -448,9 +475,78 @@ public class GleapPlugin extends Plugin {
     }
 
     @PluginMethod()
-    public void openFeatureRequests(PluginCall call) throws GleapNotInitialisedException {
+    public void openNewsArticle(PluginCall call) throws GleapNotInitialisedException {
+        String articleId = call.getString("articleId");
+        boolean showBackButton = call.getBoolean("showBackButton");
+
+        implementation.openNewsArticle(articleId, showBackButton);
+
+        // Build Json object and resolve success
+        JSObject ret = new JSObject();
+        ret.put("opened", true);
+        call.resolve(ret);
+    }
+
+    @PluginMethod()
+    public void openHelpCenter(PluginCall call) throws GleapNotInitialisedException {
+        boolean showBackButton = call.getBoolean("showBackButton");
+
+        implementation.openHelpCenter(showBackButton);
+
+        // Build Json object and resolve success
+        JSObject ret = new JSObject();
+        ret.put("opened", true);
+        call.resolve(ret);
+    }
+
+    @PluginMethod()
+    public void openHelpCenterArticle(PluginCall call) throws GleapNotInitialisedException {
+        // Open news
+        String articleId = call.getString("articleId");
+        boolean showBackButton = call.getBoolean("showBackButton");
+
+        implementation.openHelpCenterArticle(articleId, showBackButton);
+
+        // Build Json object and resolve success
+        JSObject ret = new JSObject();
+        ret.put("opened", true);
+        call.resolve(ret);
+    }
+
+    @PluginMethod()
+    public void openHelpCenterCollection(PluginCall call) throws GleapNotInitialisedException {
+        // Open news
+        String collectionId = call.getString("collectionId");
+        boolean showBackButton = call.getBoolean("showBackButton");
+
+        implementation.openHelpCenterCollection(collectionId, showBackButton);
+
+        // Build Json object and resolve success
+        JSObject ret = new JSObject();
+        ret.put("opened", true);
+        call.resolve(ret);
+    }
+
+    @PluginMethod()
+    public void searchHelpCenter(PluginCall call) throws GleapNotInitialisedException {
         // Open news
-        implementation.openFeatureRequests();
+        String term = call.getString("term");
+        boolean showBackButton = call.getBoolean("showBackButton");
+
+        implementation.searchHelpCenter(term, showBackButton);
+
+        // Build Json object and resolve success
+        JSObject ret = new JSObject();
+        ret.put("opened", true);
+        call.resolve(ret);
+    }
+
+    @PluginMethod()
+    public void openFeatureRequests(PluginCall call) throws GleapNotInitialisedException {
+        boolean showBackButton = call.getBoolean("showBackButton");
+
+        // Open feature requests
+        implementation.openFeatureRequests(showBackButton);
 
         // Build Json object and resolve success
         JSObject ret = new JSObject();