usage.md

Example Usage

Grab a reference

const CleverTap = require('clevertap-react-native');

User Profiles

Update User Profile(Push Profile)

CleverTap.profileSet({"Identity":11102008, "Name":"React-Test Profile","Email":"[email protected]","Gender":"Male","DOB":"1995-10-14", "custom":1.73});

Set Multi Values For Key

CleverTap.profileSetMultiValuesForKey(['a', 'b', 'c'], 'letters');

Remove Multi Value For Key

CleverTap.profileRemoveMultiValueForKey('b', 'letters');

Add Multi Value For Key

CleverTap.profileAddMultiValueForKey('d', 'letters');

Create a User profile when user logs in (On User Login)

CleverTap.onUserLogin({'Name': 'React-Test', 'Identity': '11102008', 'Email': '[email protected]', 'custom1': 43});

Get CleverTap Reference id

CleverTap.profileGetCleverTapID((err, res) => {
         console.log('CleverTapID', res, err);
});

Set Location to User Profile

CleverTap.setLocation(34.15, -118.20);

Increment a User Profile property

CleverTap.profileIncrementValueForKey(1, "score");

Decrement a User Profile property

CleverTap.profileDecrementValueForKey(1, "score");

---

Integrate Custom Proxy Domain

The custom proxy domain feature allows to proxy all events raised from the CleverTap SDK through your required domain, ideal for handling or relaying CleverTap events and Push Impression events with your application server. Refer following steps to configure the custom proxy domain(s) in the manifest file:

[Android Platform] Configure Custom Proxy Domain(s) using Manifest file

1. Add your CleverTap Account credentials in the Manifest file against the CLEVERTAP_ACCOUNT_ID and CLEVERTAP_TOKEN keys.
2. Add the CLEVERTAP_PROXY_DOMAIN key with the proxy domain value for handling events through the custom proxy domain.
3. Add the CLEVERTAP_SPIKY_PROXY_DOMAIN key with proxy domain value for handling push impression events.

        <meta-data
            android:name="CLEVERTAP_ACCOUNT_ID"
            android:value="YOUR ACCOUNT ID" />
        <meta-data
            android:name="CLEVERTAP_TOKEN"
            android:value="YOUR ACCOUNT TOKEN" />
        <meta-data
            android:name="CLEVERTAP_PROXY_DOMAIN"
            android:value="YOUR PROXY DOMAIN"/>  <!-- e.g., analytics.sdktesting.xyz -->
        <meta-data
            android:name="CLEVERTAP_SPIKY_PROXY_DOMAIN"
            android:value="YOUR SPIKY PROXY DOMAIN"/>  <!-- e.g., spiky-analytics.sdktesting.xyz -->

[iOS Platform] Configure Custom Proxy Domain(s) using CleverTap.autoIntegrate() API

1. Add your CleverTap Account credentials in the Info.plist file against the CleverTapAccountID and CleverTapToken keys.
2. Add the CleverTapProxyDomain key with the proxy domain value for handling events through the custom proxy domain e.g., analytics.sdktesting.xyz.
3. Add the CleverTapSpikyProxyDomain key with proxy domain value for handling push impression events e.g., spiky-analytics.sdktesting.xyz.
4. Import the CleverTap SDK in your AppDelegate file and call the following method in the didFinishLaunchingWithOptions: method.

     CleverTap.autoIntegrate()

---

User Events

Record an event

CleverTap.recordEvent('testEvent');

Record an event with event Properties

CleverTap.recordEvent('Product Viewed', {'Product Name': 'Dairy Milk','Category': 'Chocolate','Amount': 20.00});

Record Charged event

CleverTap.recordChargedEvent({'totalValue': 20, 'category': 'books'}, [{'title': 'book1'}, {'title': 'book2'}, {'title': 'book3'}]);

---

Encryption of PII data

PII data is stored across the SDK and could be sensitive information. From CleverTap SDK v5.2.0 onwards, you can enable encryption for PII data wiz. Email, Identity, Name and Phone.

Currently 2 levels of encryption are supported i.e None(0) and Medium(1). Encryption level is None by default. None - All stored data is in plaintext Medium - PII data is encrypted completely.

Android

Add encryption level in the AndroidManifest.xml as following:

<meta-data
    android:name="CLEVERTAP_ENCRYPTION_LEVEL"
    android:value="1" />

iOS

Add the CleverTapEncryptionLevel String key to info.plist file where value 1 means Medium and 0 means None. Encryption Level will be None if any other value is provided.

---

App Inbox

Initialize the CleverTap App Inbox Method

CleverTap.initializeInbox();

Show the App Inbox

CleverTap.showInbox({'tabs':['Offers','Promotions'],'navBarTitle':'My App Inbox','navBarTitleColor':'#FF0000','navBarColor':'#FFFFFF','inboxBackgroundColor':'#AED6F1','backButtonColor':'#00FF00'
                                ,'unselectedTabColor':'#0000FF','selectedTabColor':'#FF0000','selectedTabIndicatorColor':'#000000',
                                'noMessageText':'No message(s)','noMessageTextColor':'#FF0000','firstTabTitle':'First Tab' });

App Inbox Item Click Callback

CleverTap.addListener(CleverTap.CleverTapInboxMessageTapped, (event) => {
    console.log("App Inbox item: ", event.data);
    //following contentPageIndex and buttonIndex fields are available from CleverTap React Native SDK v0.9.6 onwards and below v1.0.0 
    console.log("Content Page index: " + event.contentPageIndex);
    console.log("Button index: " + event.buttonIndex);
});

App Inbox Button Click Callback

CleverTap.addListener(CleverTap.CleverTapInboxMessageButtonTapped, (event) => {/*consume the payload*/});

Dismiss the App Inbox

CleverTap.dismissInbox();

Mark read all inbox messages by array of messageIds

CleverTap.markReadInboxMessagesForIDs(['1', '2', '3']);	

Delete all inbox messages by array of messageIds

CleverTap.deleteInboxMessagesForIDs(['1', '2', '3']);	

Get Total message count

CleverTap.getInboxMessageCount((err, res) => {
	console.log('Total Messages: ', res, err);
});	

Get Total message count

CleverTap.getInboxMessageUnreadCount((err, res) => {
	console.log('Unread Messages: ', res, err);
});	

Get All Inbox Messages

CleverTap.getAllInboxMessages((err, res) => {
	console.log('All Inbox Messages: ', res, err);
});	

Get all Inbox unread messages

CleverTap.getUnreadInboxMessages((err, res) => {
	console.log('Unread Inbox Messages: ', res, err);
});	

Get inbox Id

CleverTap.getInboxMessageForId('Message Id',(err, res) => {
        console.log("marking message read = "+res);
});			

Delete message with id

CleverTap.deleteInboxMessageForId('Message Id');		

Mark a message as Read for inbox Id

CleverTap.markReadInboxMessageForId('Message Id');		

pushInbox Notification Viewed Event For Id

CleverTap.pushInboxNotificationViewedEventForId('Message Id');		

push Inbox Notification Clicked Event For Id

CleverTap.pushInboxNotificationClickedEventForId('Message Id');			

---

Push primer for notification Permission (Android and iOS)

Follow the Push Primer integration doc.

---

Push Notifications

Creating Notification Channel

CleverTap.createNotificationChannel("CtRNS", "Clever Tap React Native Testing", "CT React Native Testing", 1, true);			

Default Notification Channel

Starting from CleverTap React Native SDK v1.2.0, we have introduced a new feature that allows developers to define a default notification channel for their app. This feature provides flexibility in handling push notifications. Please note that this is only supported for clevertap core notifications. Support for push templates will be released soon. To specify the default notification channel ID, you can add the following metadata in your app's manifest file:

<meta-data android:name="CLEVERTAP_DEFAULT_CHANNEL_ID" android:value="your_default_channel_id" />

By including this metadata, you can define a specific notification channel that CleverTap will use if the channel provided in push payload is not registered by your app. This ensures that push notifications are displayed consistently even if the app's notification channels are not set up.

In case the SDK does not find the default channel ID specified in the manifest, it will automatically fallback to using a default channel called "Miscellaneous". This ensures that push notifications are still delivered, even if no specific default channel is specified in the manifest.

This enhancement provides developers with greater control over the default notification channel used by CleverTap for push notifications, ensuring a seamless and customizable user experience.

Delete Notification Channel

CleverTap.deleteNotificationChannel("RNTesting");		

Creating a group notification channel

CleverTap.createNotificationChannelGroup(String groupId, String groupName);		

Delete a group notification channel

CleverTap.deleteNotificationChannelGroup(String groupId);			

Registering Fcm Token

CleverTap.setPushToken("<Replace with FCM Token value>", CleverTap.FCM);

---

Native Display

Get Display Unit for Id

CleverTap.getDisplayUnitForId('Unit Id', (err, res) => {
        console.log('Get Display Unit for Id:', res, err);
});

Get All Display Units

CleverTap.getAllDisplayUnits((err, res) => {
        console.log('All Display Units: ', res, err);
});

---

Product Config

Set Product Configuration to default

CleverTap.setDefaultsMap({'text_color': 'red', 'msg_count': 100, 'price': 100.50, 'is_shown': true, 'json': '{"key":"val"}'});

Fetching product configs

CleverTap.fetch();

Activate the most recently fetched product config

CleverTap.activate();

Fetch And Activate product config

CleverTap.fetchAndActivate();

Fetch Minimum Time Interval

CleverTap.fetchWithMinimumIntervalInSeconds(60);

Set Minimum Time Interval for Fetch

CleverTap.setMinimumFetchIntervalInSeconds(60);

Get Boolean key

CleverTap.getProductConfigBoolean('is_shown', (err, res) => {
	console.log('PC is_shown val in boolean :', res, err);
});

Get Long

CleverTap.getNumber('msg_count', (err, res) => {
	console.log('PC is_shown val in number(long)  :', res, err);
});

Get Double

CleverTap.getNumber('price', (err, res) => {
	console.log('PC price val in number :', res, err);
});		

Get String

CleverTap.getProductConfigString('text_color', (err, res) => {
        console.log('PC text_color val in string :', res, err);
});	

Get String (JSON)

CleverTap.getProductConfigString('json', (err, res) => {
	console.log('PC json val in string :', res, err);
});	

Delete all activated, fetched and defaults configs

CleverTap.resetProductConfig();

Get last fetched timestamp in millis

CleverTap.getLastFetchTimeStampInMillis((err, res) => {
        console.log('LastFetchTimeStampInMillis in string: ', res, err);
});		

Feature Flag

Get Feature Flag

CleverTap.getFeatureFlag('is_dark_mode', false, (err, res) => {
	console.log('FF is_dark_mode val in boolean :', res, err);
});

CleverTap ID

Get CleverTap ID

CleverTap.getCleverTapID((err, res) => {
        console.log('CleverTapID', res, err);
});

---

App Personalisation

Enable Personalization

CleverTap.enablePersonalization();		

Disable Personalization

CleverTap.disablePersonalization();

Get Profile Name

CleverTap.profileGetProperty('Name', (err, res) => {
	console.log('CleverTap Profile Name: ', res, err);
});

---

Debugging

CleverTap.setDebugLevel(3);

Attributions

Get CleverTap Attribution Identifier

CleverTap.profileGetCleverTapAttributionIdentifier((err, res) => {
         console.log('CleverTapAttributionIdentifier', res, err);
});

---

InApp Notification Controls

Suspend InApp Notifications

CleverTap.suspendInAppNotifications();

Discard InApp Notifications

CleverTap.discardInAppNotifications();

Resume InApp Notifications

CleverTap.resumeInAppNotifications();

For more information,

• See included Example Application
• See CleverTap JS interface
• See CleverTap TS interface