Release v1.1.0

Author: rohan-devrev

CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to this project will be documented in this file.
 
+## 1.1.0
+
+### Added
+- Introducing a logout mechanism that clears the user's credentials, unregisters the device from receiving push notifications, and stops the session recording.
+- Added a boolean flag to check if the SDK has been configured.
+- Added a boolean flag to check if the user has been identified.
+- Added a boolean flag to check if the session is being recorded.
+- Added a boolean flag to check if the monitoring is enabled.
+- Added a boolean flag to check if the on-demand sessions are enabled.
+
 ## 1.0.3
 
 ### Added

README.md

@@ -11,6 +11,9 @@
   - [Identification](#identification)
     - [Anonymous identification](#anonymous-identification)
     - [Unverified identification](#unverified-identification)
+    - [Verified identification](#verified-identification)
+    - [Updating the user](#updating-the-user)
+    - [Logout](#logout)
     - [Examples](#examples)
   - [PLuG support chat](#plug-support-chat)
   - [Analytics](#analytics)
@@ -103,6 +106,16 @@ DevRev.configure(context: Context, appId: String, prefersDialogMode: Boolean)
 DevRev.INSTANCE.configure(Context context, String appId, Boolean prefersDialogMode);
 ```
 
+Use this property to check whether the DevRev SDK has been configured:
+- Kotlin
+```kotlin
+DevRev.isConfigured
+```
+- Java
+```java
+DevRev.INSTANCE.isConfigured();
+```
+
 > [!NOTE]
 > `prefersDialogMode`, if set to true, enables the SDK to open the screens in the app's main task/activity
 
@@ -202,6 +215,17 @@ DevRev.INSTANCE.identifyUnverifiedUser(
 
 The function accepts the `Identity` object, with the user identifier (`userId`) as the only required property, all other properties are optional.
 
+### Verified identification
+The verified identification method is used to identify the user with a unique identifier and verify the user's identity with the DevRev backend.
+
+```kotlin
+DevRev.identifyVerifiedUser(userId: String, sessionToken: String)
+```
+
+```java
+DevRev.INSTANCE.identifyVerifiedUser(String userId, String sessionToken);
+```
+
 ### Examples
 
 - Kotlin
@@ -228,7 +252,17 @@ DevRev.identifyUnverifiedUser(
 
 The identification function should be placed at the appropriate place in your app after you login your user. If you have the user information at app launch, call the function after the `DevRev.configure(context, appID)` method.
 
-#### Updating the user
+Use this property to check whether the user has been provided to the SDK:
+- Kotlin
+```kotlin
+DevRev.isUserIdentified
+```
+- Java
+```java
+DevRev.INSTANCE.isUserIdentified();
+```
+
+### Updating the user
 You can update the user's information using the following method:
 
 - Kotlin
@@ -252,6 +286,19 @@ The function accepts the `DevRev.Identity` ojbect.
 > [!IMPORTANT]
 > The `userID` property can *not* be updated.
 
+### Logout
+
+You can perform a logout of the current user by calling the following method:
+
+```kotlin
+DevRev.logout(context: Context, deviceId: String)
+```
+
+```java
+DevRev.INSTANCE.logout(Context context, String deviceId);
+```
+
+The user will be logged out by clearing their credentials, as well as unregistering the device from receiving push notifications, and stopping the session recording.
 
 ## PLuG support chat
 
@@ -346,6 +393,14 @@ DevRev.resumeAllMonitoring()
 ```java
 DevRevObservabilityExtKt.resumeAllMonitoring(DevRev.INSTANCE);
 ```
+You can check whether session monitoring has been enabled by using this property:
+```kotlin
+DevRev.isMonitoringEnabled
+```
+- Java
+```java
+DevRevObservabilityExtKt.isMonitoringEnabled(DevRev.INSTANCE);
+```
 If the user was disabled for session recording by using the stopAllMonitoring() method, you can use this method to enable recording at runtime.
 > [!NOTE]
 > This feature will only store a monitoring permission flag, it will **not** provide any UI or dialog.
@@ -364,6 +419,22 @@ The session recording feature has a number of methods to help you control the re
 | DevRev.stopRecording()   | DevRevObservabilityExtKt.stopRecording(DevRev.INSTANCE);           | Stops the session recording and uploads it to the portal. |
 | DevRev.pauseRecording()  | DevRevObservabilityExtKt.pauseRecording(DevRev.INSTANCE);          | Pauses the ongoing session recording.                     |
 | DevRev.resumeRecording() | DevRevObservabilityExtKt.resumeRecording(DevRev.INSTANCE);         | Resumes a paused session recording.                       |
+Using this property will return the status of the session recording:
+```kotlin
+DevRev.isRecording
+```
+- Java
+```java
+DevRevObservabilityExtKt.isRecording(DevRev.INSTANCE);
+```
+To check if on-demand sessions are enabled, use:
+```kotlin
+DevRev.areOnDemandSessionsEnabled
+```
+- Java
+```java
+DevRevObservabilityExtKt.areOnDemandSessionsEnabled(DevRev.INSTANCE);
+```
 
 ### Session properties
 You can add custom properties to the session recording to help you understand the context of the session. The properties are defined as a dictionary of string values.

docs/html/core/ai.devrev.sdk/-dev-rev/index.html

@@ -136,6 +136,21 @@ <h2 class="">Functions</h2>
             </div>
           </div>
         </div>
+<a data-name="-385953269%2FFunctions%2F197447377" anchor-label="logout" id="-385953269%2FFunctions%2F197447377" data-filterable-set=":core:dokkaHtml/release"></a>
+        <div class="table-row" data-filterable-current=":core:dokkaHtml/release" data-filterable-set=":core:dokkaHtml/release">
+          <div class="main-subrow keyValue ">
+            <div class=""><span class="inline-flex">
+                <div><a href="logout.html"><span><span>logout</span></span></a></div>
+<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-385953269%2FFunctions%2F197447377"></span>
+                  <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
+                </span></span></div>
+            <div>
+              <div class="title">
+                <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="logout.html"><span class="token function">logout</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">context<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/android/content/Context.html">Context</a><span class="token punctuation">, </span></span><span class="parameter ">deviceId<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Logs out the current identified user and resets the session. The process will also unregister the user's device from receiving push notifications, and stop any ongoing session recording.</p></div></div></div>
+              </div>
+            </div>
+          </div>
+        </div>
 <a data-name="-69298287%2FFunctions%2F197447377" anchor-label="processPushNotification" id="-69298287%2FFunctions%2F197447377" data-filterable-set=":core:dokkaHtml/release"></a>
         <div class="table-row" data-filterable-current=":core:dokkaHtml/release" data-filterable-set=":core:dokkaHtml/release">
           <div class="main-subrow keyValue ">
@@ -258,17 +273,32 @@ <h2 class="">Functions</h2>
         </div>
       </div>
       <h2 class="">Properties</h2>
-      <div class="table" data-togglable="Properties"><a data-name="-67997467%2FProperties%2F197447377" anchor-label="isInitialized" id="-67997467%2FProperties%2F197447377" data-filterable-set=":core:dokkaHtml/release"></a>
+      <div class="table" data-togglable="Properties"><a data-name="-40923581%2FProperties%2F197447377" anchor-label="isConfigured" id="-40923581%2FProperties%2F197447377" data-filterable-set=":core:dokkaHtml/release"></a>
+        <div class="table-row" data-filterable-current=":core:dokkaHtml/release" data-filterable-set=":core:dokkaHtml/release">
+          <div class="main-subrow keyValue ">
+            <div class=""><span class="inline-flex">
+                <div><a href="is-configured.html"><span>is</span><wbr></wbr><span><span>Configured</span></span></a></div>
+<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-40923581%2FProperties%2F197447377"></span>
+                  <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
+                </span></span></div>
+            <div>
+              <div class="title">
+                <div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core:dokkaHtml/release"><a data-name="-40923581%2FProperties%2F197447377" anchor-label="isConfigured" id="-40923581%2FProperties%2F197447377" data-filterable-set=":core:dokkaHtml/release"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="is-configured.html">isConfigured</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a></div></div></div>
+              </div>
+            </div>
+          </div>
+        </div>
+<a data-name="-636019525%2FProperties%2F197447377" anchor-label="isUserIdentified" id="-636019525%2FProperties%2F197447377" data-filterable-set=":core:dokkaHtml/release"></a>
         <div class="table-row" data-filterable-current=":core:dokkaHtml/release" data-filterable-set=":core:dokkaHtml/release">
           <div class="main-subrow keyValue ">
             <div class=""><span class="inline-flex">
-                <div><a href="is-initialized.html"><span>is</span><wbr></wbr><span><span>Initialized</span></span></a></div>
-<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-67997467%2FProperties%2F197447377"></span>
+                <div><a href="is-user-identified.html"><span>is</span><wbr></wbr><span>User</span><wbr></wbr><span><span>Identified</span></span></a></div>
+<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-636019525%2FProperties%2F197447377"></span>
                   <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
                 </span></span></div>
             <div>
               <div class="title">
-                <div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core:dokkaHtml/release"><a data-name="-67997467%2FProperties%2F197447377" anchor-label="isInitialized" id="-67997467%2FProperties%2F197447377" data-filterable-set=":core:dokkaHtml/release"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="is-initialized.html">isInitialized</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a></div></div></div>
+                <div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core:dokkaHtml/release"><a data-name="-636019525%2FProperties%2F197447377" anchor-label="isUserIdentified" id="-636019525%2FProperties%2F197447377" data-filterable-set=":core:dokkaHtml/release"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="is-user-identified.html">isUserIdentified</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a></div></div></div>
               </div>
             </div>
           </div>
@@ -290,6 +320,21 @@ <h2 class="tabbedcontent">Extensions</h2>
             </div>
           </div>
         </div>
+<a data-name="-14298317%2FExtensions%2F197447377" anchor-label="areOnDemandSessionsEnabled" id="-14298317%2FExtensions%2F197447377" data-filterable-set=":core:dokkaHtml/release"></a>
+        <div class="table-row" data-filterable-current=":core:dokkaHtml/release" data-filterable-set=":core:dokkaHtml/release">
+          <div class="main-subrow keyValue ">
+            <div class=""><span class="inline-flex">
+                <div><a href="../are-on-demand-sessions-enabled.html"><span>are</span><wbr></wbr><span>On</span><wbr></wbr><span>Demand</span><wbr></wbr><span>Sessions</span><wbr></wbr><span><span>Enabled</span></span></a></div>
+<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-14298317%2FExtensions%2F197447377"></span>
+                  <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
+                </span></span></div>
+            <div>
+              <div class="title">
+                <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="index.html">DevRev</a><span class="token punctuation">.</span><a href="../are-on-demand-sessions-enabled.html">areOnDemandSessionsEnabled</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">A flag denoting whether on-demand sessions are enabled.</p></div></div></div>
+              </div>
+            </div>
+          </div>
+        </div>
 <a data-name="-1510739491%2FExtensions%2F197447377" anchor-label="clearSessionProperties" id="-1510739491%2FExtensions%2F197447377" data-filterable-set=":core:dokkaHtml/release"></a>
         <div class="table-row" data-filterable-current=":core:dokkaHtml/release" data-filterable-set=":core:dokkaHtml/release">
           <div class="main-subrow keyValue ">
@@ -335,6 +380,21 @@ <h2 class="tabbedcontent">Extensions</h2>
             </div>
           </div>
         </div>
+<a data-name="-60914486%2FExtensions%2F197447377" anchor-label="isMonitoringEnabled" id="-60914486%2FExtensions%2F197447377" data-filterable-set=":core:dokkaHtml/release"></a>
+        <div class="table-row" data-filterable-current=":core:dokkaHtml/release" data-filterable-set=":core:dokkaHtml/release">
+          <div class="main-subrow keyValue ">
+            <div class=""><span class="inline-flex">
+                <div><a href="../is-monitoring-enabled.html"><span>is</span><wbr></wbr><span>Monitoring</span><wbr></wbr><span><span>Enabled</span></span></a></div>
+<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-60914486%2FExtensions%2F197447377"></span>
+                  <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
+                </span></span></div>
+            <div>
+              <div class="title">
+                <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="index.html">DevRev</a><span class="token punctuation">.</span><a href="../is-monitoring-enabled.html">isMonitoringEnabled</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">A flag denoting whether session monitoring is enabled.</p></div></div></div>
+              </div>
+            </div>
+          </div>
+        </div>
 <a data-name="-892045902%2FExtensions%2F197447377" anchor-label="isRecording" id="-892045902%2FExtensions%2F197447377" data-filterable-set=":core:dokkaHtml/release"></a>
         <div class="table-row" data-filterable-current=":core:dokkaHtml/release" data-filterable-set=":core:dokkaHtml/release">
           <div class="main-subrow keyValue ">
@@ -345,7 +405,7 @@ <h2 class="tabbedcontent">Extensions</h2>
                 </span></span></div>
             <div>
               <div class="title">
-                <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="index.html">DevRev</a><span class="token punctuation">.</span><a href="../is-recording.html"><span class="token function">isRecording</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div></div></div>
+                <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="index.html">DevRev</a><span class="token punctuation">.</span><a href="../is-recording.html">isRecording</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">A flag denoting whether the session is being recorded.</p></div></div></div>
               </div>
             </div>
           </div>