Features

Identification

To access certain features of the DevRev SDK, user identification is required.

The identification function should be placed appropriately in your app after the user logs in. If you have the user information available at app launch, call the function after the DevRev.configure(context, appID) method.

Anonymous identification

The anonymous identification method allows you to create an anonymous user with an optional user identifier, ensuring that no other data is stored or associated with the user.

1
DevRev.identifyAnonymousUser(
2
    userId: String
3
)

Unverified identification

The unverified identification method identifies users with a unique identifier, but it does not verify their identity with the DevRev backend.

1
DevRev.identifyUnverifiedUser(
2
    identity: Identity
3
)

The function accepts the DevRev.Identity structure, with the user identifier (userID) as the only required property, all other properties are optional.

For example:

1
// Identify an unverified user using their email address as the user identifier.
2
DevRev.identifyUnverifiedUser(Identity(userId = "user@example.org"))

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.

1
DevRev.identifyVerifiedUser(userId: String, sessionToken: String)

Updating the user

To update a user’s information, use the following method:

1
DevRev.updateUser(
2
 identity: Identity
3
)

The function accepts the DevRev.Identity ojbect.

Logout

You can perform a logout of the current user by calling the following method:

1
DevRev.logout(context: Context, deviceId: String)

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

Once user identification is complete, you can start using the chat (conversations) dialog supported by our DevRev SDK. To open the chat dialog, your application should use the showSupport API, as shown in the following example:

1
DevRev.showSupport(context: Context)

Creating a new conversation

You have the ability to create a new conversation from within your app. The method will show the support chat screen and create a new conversation at the same time.

1
DevRev.createSupportConversation(context: Context)

The DevRev SDK also provides a support button, which can be integrated into your application. To include it on the current screen, add the following code to your XML layout:

1
<ai.devrev.sdk.plug.view.PlugFloatingActionButton
2
    android:id="@+id/plug_fab"
3
    android:layout_width="wrap_content"
4
    android:layout_height="wrap_content"
5
    android:layout_margin="24dp"
6
    app:layout_constraintBottom_toBottomOf="parent"
7
    app:layout_constraintEnd_toEndOf="parent" />

The support button can be customized using default parameters, enabling you to tailor its appearance to your application’s design.

1
android:src="@your_drawable_here"

and

1
android:backgroundTint="@your_background_color"

At this stage, your app is fully configured to utilize all functionalities of the DevRev SDK. Pressing the support button directs the user to the chat interface, enabling effective interaction and support.

In-app link handling

The DevRev SDK provides a mechanism to handle links opened from within any screen that is part of the DevRev SDK.

You can fully customize the link handling behavior by setting the specialized in-app link handler. That way you can decide what should happen when a link is opened from within the app.

1
DevRev.setInAppLinkHandler(handler: (String) -> Unit)

You can further customize the behavior by setting the setShouldDismissModalsOnOpenLink boolean flag. This flag controls whether the DevRev SDK should dismiss the top-most modal screen when a link is opened.

1
DevRev.setShouldDismissModalsOnOpenLink(value: boolean)

For example:

1
DevRev.setInAppLinkHandler { link ->
2
   // Do something here
3
}
4
5
DevRev.setShouldDismissModalsOnOpenLink(false)

Analytics

The DevRev SDK allows you to send custom analytic events by using a name and a string dictionary. You can track these events using the following function:

1
DevRev.trackEvent(name: String, properties: HashMap<String, String>)

For example:

1
DevRev.trackEvent(name = "open-message-screen", properties = {"id": "message-1337"})

Session analytics

The DevRev SDK provides observability features to help you understand how your users are interacting with your app.

Opt in or out

Session analytics features are opted-in by default, enabling them from the start. However, you can opt-out using the following method:

1
DevRev.stopAllMonitoring()

To opt back in, use the following method:

1
DevRev.resumeAllMonitoring()

You can check whether session monitoring has been enabled by using this property:

If session recording was disabled for the user using the stopAllMonitoring() method, you can enable recording at runtime with this method.

1
DevRev.isMonitoringEnabled

If the user was disabled for session recording by using the stopAllMonitoring() method, you can use this method to enable recording at runtime.

Session recording

You can enable session recording to capture user interactions with your app.

Here are the available methods to help you control the session recording feature:

Using this property will return the status of the session recording:

1
DevRev.isRecording

To check if on-demand sessions are enabled, use:

1
DevRev.areOnDemandSessionsEnabled

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.

1
DevRev.addSessionProperties(properties: HashMap<String, Any>)

To clear the session properties in scenarios such as user logout or when the session ends, use the following method:

1
DevRev.clearSessionProperties()

Masking sensitive data

To protect sensitive data, the DevRev SDK provides an auto-masking feature that masks data before sending to the server. Input views such as text fields, text views, and web views are automatically masked.

While the auto-masking feature may be sufficient for most situations, you can manually mark/unmark additional views as sensitive.

Mask

Using tag

1
android:tag="devrev-mask"

For example:

1
<WebView
2
    android:id="@+id/webview2"
3
    android:layout_width="fill_parent"
4
    android:layout_height="200dp"
5
    android:background="@android:color/transparent"
6
    android:tag="devrev-mask"/>

You can also set the tag programmatically:

1
val anyView: View = findViewById(R.id.anyView)
2
anyView.tag = "devrev-mask"

Using API

1
DevRev.markSensitiveViews(sensitiveViews: List<View>)

For example:

1
val view1 = findViewById(R.id.view1)
2
val view2 = findViewById(R.id.view2)
3
4
DevRev.markSensitiveViews(listOf(view1, view2))

Unmask

Using tag

1
android:tag="devrev-unmask"

For example:

1
<WebView
2
    android:id="@+id/webview2"
3
    android:layout_width="fill_parent"
4
    android:layout_height="200dp"
5
    android:background="@android:color/transparent"
6
    android:tag="devrev-unmask"/>

You can also set the tag programmatically:

1
val anyView: View = findViewById(R.id.anyView)
2
anyView.tag = "devrev-unmask"

Using API

1
DevRev.unmarkSensitiveViews(sensitiveViews: List<View>)

For example:

1
val view1 = findViewById(R.id.view1)
2
val view2 = findViewById(R.id.view2)
3
4
DevRev.unmarkSensitiveViews(listOf(view1, view2))

Mask jetpack compose views

If you want to mask any Jetpack Compose UI element(s) or view(s), you can apply a mask on it using a modifier.

1
modifier = Modifier.markAsMaskedLocation("Name or ID of the Compose View")

For example:

1
TextField(
2
       modifier = Modifier
3
             .markAsMaskedLocation("myTextField")
4
             .padding(horizontal = 20.dp)
5
             .onGloballyPositioned { coordinates = it },
6
       value = input,
7
       onValueChange = { input = it }
8
)

Mask webView elements

If you wish to mask any WebView element on a Web page explicitly, you can mask it by using class ‘devrev-mask’

For example:

1
<label class="devrev-mask">OTP: 12345</label>

Unmask webView elements

If you wish to explicitly un-mask any manually masked WebView element, you can un-mask it by using class ‘devrev-unmask’

For example:

1
<input type="text" placeholder="Enter Username" name="username" required class="devrev-unmask">

Timers

The DevRev SDK offers a timer mechanism to measure the time spent on specific tasks, allowing you to track events such as response time, loading time, or any other duration-based metrics.

The mechanism works using balanced start and stop methods that both accept a timer name and an optional dictionary of properties.

To start a timer, use the following method:

1
DevRev.startTimer(name: String, properties: HashMap<String, String>)

To stop a timer, use the following method:

1
DevRev.endTimer(name: String, properties: HashMap<String, String>)

For example:

1
DevRev.startTimer("response-time", properties: {"id": "task-1337"})
2
3
// Perform the task that you want to measure.
4
5
DevRev.endTimer("response-time", properties: {"id": "task-1337"})

Screen tracking

The DevRev SDK offers automatic screen tracking to help you understand how users navigate through your app. Although view controllers are automatically tracked, you can manually track screens using the following method:

1
DevRev.trackScreenName(screenName: String)

For example:

1
DevRev.trackScreenName("profile-screen")

Screen transition management

The DevRev SDK allows tracking of screen transitions to understand user navigation within your app. You can check if a screen transition is in progress and manually update the state using the following methods:

Check if the screen is transitioning

1
val isTransitioning = DevRev.isInScreenTransitioning

Set screen transitioning state

1
DevRev.setInScreenTransitioning(true) // start transition
2
DevRev.setInScreenTransitioning(false) // stop transition

Push notifications

You can configure your app to receive push notifications from the DevRev SDK. The SDK is designed to handle push notifications and execute actions based on the notification’s content.

The DevRev backend sends push notifications to your app to notify users about new messages in the PLuG support chat.

Register for push notifications

The DevRev SDK offers a method to register your device for receiving push notifications. You can register for push notifications using the following method:

1
DevRev.registerDeviceToken(
2
  context: Context,
3
  deviceId: String,
4
  deviceToken: String
5
)

The method requires a device identifier that persists across device restarts and app launches. This could be a Firebase installation ID, Android ID, or a unique system identifier. To obtain the device token for Firebase Cloud Messaging, follow these steps:

1. Use the FirebaseMessaging object.
2. Call the firebaseMessaging.token.await() method.

This method will generate and return the device token.

1
val firebaseMessaging = FirebaseMessaging.getInstance()
2
val token = firebaseMessaging.token.await()
3
// Use the token as needed

Unregister from push notifications

If your app no longer needs to receive push notifications, you can unregister the device.

Use the following method to unregister the device:

The method requires the device identifier, which should be the same as the one used when registering the device.

1
DevRev.unregisterDevice(
2
  context: Context, 
3
  deviceId: String
4
)

The method requires the device identifier, which should be the same as the one used when registering the device.

Handle push notifications

The DevRev SDK currently does not support automatic handling of push notifications. To open the PLuG chat and manage navigation internally, you must pass the message payload received in the notification to the SDK.

1
DevRev.processPushNotification(
2
    context: Context,
3
    userInfo: String
4
)

To extract the notification payload, do the following:

1. In Firebase Cloud Messaging (FCM), when a push notification is received, it triggers the onMessageReceived function in your FirebaseMessagingService class.
2. This function receives a RemoteMessage object as a parameter, which contains the notification data.
3. The RemoteMessage object has a data property, which is a map containing key-value pairs of the notification payload.
4. To extract a specific piece of data from the payload, use the key to access the value in the data map.
5. To retrieve the “message” from the payload:

1
val message = remoteMessage.data["message"]

For example:

1
class MyFirebaseMessagingService: FirebaseMessagingService {
2
    // ...
3
  
4
    override fun onMessageReceived(remoteMessage: RemoteMessage) {
5
        // ...
6
        val messageData = remoteMessage.data["message"]
7
        DevRev.processPushNotification(messageData)
8
    }
9
}