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(appID) method.

You can select from the following methods to identify users within your application:

Identify an anonymous user

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(userID);

Identify an unverified user

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

1
DevRev.identifyUnverifiedUser(userID, organizationID);

Identify a verified user

The verified identification method is used to identify users with an identifier unique to your system within the DevRev platform. The verification is done through a token exchange process between you and the DevRev backend.

The steps to identify a verified user are as follows:

1. Generate an AAT for your system (preferably through your backend).
2. Exchange your AAT for a session token for each user of your system.
3. Pass the user identifier and the exchanged session token to the DevRev.identifyVerifiedUser(userID, sessionToken) method.

Generate an AAT

1. Open the DevRev web app at https://app.devrev.ai and go to the Settings page.
2. Open the PLuG Tokens page.
3. Under the Application access tokens panel, click New token and copy the token that’s displayed.

Exchange your AAT for a session token

To proceed with identifying the user, you need to exchange your AAT for a session token. This step helps you identify a user of your own system within the DevRev platform.

Here is a simple example of an API request to the DevRev backend to exchange your AAT for a session token:

$
curl \
>
--location 'https://api.devrev.ai/auth-tokens.create' \
>
--header 'accept: application/json, text/plain, */*' \
>
--header 'content-type: application/json' \
>
--header 'authorization: <AAT>' \
>
--data '{
>
  "rev_info": {
>
    "user_ref": "<YOUR_USER_ID>"
>
  }
>
}'

The response of the API call contains a session token that you can use with the verified identification method in your app.

Identify the verified user

Pass the user identifier and the exchanged session token to the verified identification method:

1
DevRev.identifyVerifiedUser(userID, sessionToken);

Update the user

You can update the user’s information using the following method:

1
DevRev.updateUser(identity);

Use this property to check whether the user is identified in the current session:

1
DevRev.isUserIdentified;

Logout

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

1
DevRev.logout(deviceID);

The user is logged out by clearing their credentials, as well as unregistering the device from receiving push notifications, and stopping the session recording.

For example:

1
// Identify an anonymous user with a user identifier.
2
DevRev.identifyAnonymousUser("user@example.org");
3
4
// Identify an unverified user using their email address as the user identifier.
5
DevRev.identifyUnverifiedUser("user@example.org", "organization-1337");
6
7
// Identify a verified user using their email address as the user identifier.
8
DevRev.identifyVerifiedUser("foo@example.org", "bar-1337");
9
10
// Update the user's information.
11
DevRev.updateUser({"organizationRef": "organization-1337"});
12
13
// Logout the identified user.
14
DevRev.logout("dvc32423");

Identity model

User identity information is passed as a Map<String, dynamic> to the updateUser method. The map can contain user, organization, and account information.

Properties

The identity map can contain the following properties:

User traits

The userTraits map contains detailed information about the user:

Organization traits

The organizationTraits map contains detailed information about the organization:

Account traits

The accountTraits map contains detailed information about the account:

PLuG support chat

Once user identification is complete, you can start using the chat (conversations) dialog supported by our DevRev SDK. The support chat feature can be shown as a modal screen from the top-most screen.

1
DevRev.showSupport();

Create a new support conversation

You can initiate a new support conversation directly from your app. This method displays the support chat screen and simultaneously creates a new conversation.

1
DevRev.createSupportConversation();

In-app link handling

In certain cases, tapping links in the support chat opens them in the app instead of a browser. You can control whether the chat modal screen is dismissed after the link is opened by calling the following method:

1
DevRev.setShouldDismissModalsOnOpenLink(value);

Setting this flag to true applies the system’s default behavior for opening links, which includes dismissing any DevRev modal screens to facilitate handling your own deep links.

Dynamic theme configuration

The DevRev SDK allows you to configure the theme dynamically based on the system appearance, or use the theme configured on the DevRev portal. By default, the theme is dynamic and follows the system appearance.

1
DevRev.setPrefersSystemTheme(value: boolean);

Analytics

The DevRev SDK allows you to send custom analytic events by using a properties map. You can track these events using the following function:

1
DevRev.trackEvent(name, properties);

For example:

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

Session analytics

The DevRev SDK offers session analytics features to help you understand how users interact 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();

Session recording

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

The session recording feature includes the following methods to control the recording:

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 map of string values.

1
DevRev.addSessionProperties(properties);

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, you can mask sensitive UI elements such as text fields, text views, and web views using DevRevMask widget, as shown below.

For example:

1
DevRevMask(
2
  child: TextField(
3
    decoration: InputDecoration(labelText: "foo-bar"),
4
  ),
5
)

Unmasking sensitive data

You can also manually unmask UI elements that would otherwise be automatically masked using DevRevUnmask:

For example:

1
DevRevUnmask(
2
  child: TextField(
3
    decoration: InputDecoration(labelText: "foo-bar"),
4
    ),
5
  )

Advanced session recording control while masking

For enhanced session recording and screen transition handling, you can use DevRevMonitoredApp as a drop-in replacement for MaterialApp. This widget automatically handles screen transition states and ensures proper masking during navigation.

1
class MyApp extends StatelessWidget {
2
  const MyApp({super.key});
3
4
  @override
5
  Widget build(BuildContext context) {
6
    return DevRevMonitoredApp(
7
      title: "My App",
8
      theme: ThemeData(primarySwatch: Colors.blue),
9
      home: const HomeScreen(),
10
    );
11
  }
12
}

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 uses balanced start and stop methods, both of which accept a timer name and an optional dictionary of properties.

To start a timer, use the following method:

1
DevRev.startTimer(name, properties);

To stop a timer, use the following method:

1
DevRev.endTimer(name, properties);

For example:

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

Track screens

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

1
DevRev.trackScreenName(screenName);

For example:

1
DevRev.trackScreenName("profile-screen");

Manage screen transitions (Android only)

The DevRev SDK allows tracking of screen transitions to understand the user navigation within your app. You can manually update the state using the following methods:

1
// Mark the transition as started.
2
DevRev.setInScreenTransitioning(true);
3
4
// Mark the transition as ended.
5
DevRev.setInScreenTransitioning(false);

Push notifications

You can configure your app to receive push notifications from the DevRev SDK. The SDK is able 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.

Configuration

To receive push notifications, you need to configure your DevRev organization by following the instructions in the push notifications section.

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(deviceToken, deviceID);

On Android devices, the deviceToken should be the Firebase Cloud Messaging (FCM) token value, while on iOS devices, it should be the Apple Push Notification Service (APNs) token.

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:

1
DevRev.unregisterDevice(deviceID);

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

Handle push notifications

Android

On Android, notifications are implemented as data messages to offer flexibility. However, this means that automatic click processing isn’t available. To handle notification clicks, developers need to intercept the click event, extract the payload, and pass it to a designated method for processing. This custom approach enables tailored notification handling in Android applications.

To process the notification, use the following method:

1
DevRev.processPushNotification(payload);

iOS

On iOS devices, you must pass the received push notification payload to the DevRev SDK for processing. The SDK handles the notification and executes the necessary actions.

1
DevRev.processPushNotification(payload);