The takeOff method initializes the Sprinklr Messenger Client SDK. This step prepares Live Chat to work based on the type of user using your app. It can be used to initialize the SDK for the following type of users:

• Anonymous users

• Authenticated users

• Authenticated custom users

This diagram illustrates how to initialize and present Sprinklr Live Chat:

Initialize for Anonymous Users

For anonymous users (unauthenticated users), you can initialize the messenger using the takeOff method without specifying any user details. Behind the scenes, an anonymous user is automatically created for the messenger and the flow for anonymous user is initialized.

Syntax

import MessengerClient from '@sprinklrjs/chat-native-client'  MessengerClient.takeOff({  appId: '<SPR_APP_ID>', // This will be provided by Sprinklr ​ environment: '<SPR_ENVIRONMENT>', // This will be provided by Sprinklr  pushAppId: '<SPR_PUSH_APP_ID>', // Should be Unique id, if not sure pass same as device ID ​ deviceId: '<UNIQUE_DEVICE_ID>',  ​skin: 'MODERN', // default value is MODERN, options: CLASSIC | MODERN ​ locale: '<SPR_LOCALE>', // default value is en ​ themeMode: 'DEFAULT' // default value is DEFAULT, options DEFAULT | DARK })

Parameters

Initialize for Authenticated Users

For authenticated users, initialize the messenger using the takeOff method with user details. The takeOff method will consider the provided user details for the messenger and initialize the flow accordingly.

Syntax

import MessengerClient from '@sprinklrjs/chat-native-client' 
 
MessengerClient.takeOff({ 
 appId: '<SPR_APP_ID>', // This will be provided by sprinklr 
​
 environment: '<SPR_ENVIRONMENT>', // This will be provided by sprinklr 
 pushAppId: '<SPR_PUSH_APP_ID>', // Should be Unique id, if not sure pass same as device ID 
​
 deviceId: '<UNIQUE_DEVICE_ID>', 
​
 locale: '<SPR_LOCALE>', // default value is en 
​
skin: 'MODERN', // default value is MODERN, options: CLASSIC | MODERN 
​
themeMode: 'DEFAULT', // default value is DEFAULT, options: DEFAULT | DARK 
 user: { 
   userId: '12345', 
   firstName: 'John', 
   lastName: 'Doe', 
   phoneNo: '9876543210', 
   email: 'John.Doe@example.com', 
   profileImageUrl: 'https://example.com/profilePic.jpg', 
   hash: 'f30c3b0835ecd378a134c74bce8cea866df8c5b6e12a8c219c9bb288f7270e22' 
 } 
}) 

Parameters

User Object

Initialize for Custom Authenticated Users

You can create a custom user with custom parameters and pass them to the takeOff method. 

​

Syntax

import MessengerClient from '@sprinklrjs/chat-native-client'   MessengerClient.takeOff({   appId: '<SPR_APP_ID>', // This will be provided by sprinklr  ​ environment: '<SPR_ENVIRONMENT>', // This will be provided by sprinklr   pushAppId: '<SPR_PUSH_APP_ID>',  // Should be Unique id, if not sure pass same as device ID ​ deviceId: '<UNIQUE_DEVICE_ID>',  ​ locale: '<SPR_LOCALE>', // default value is en  ​ skin: 'MODERN', // default value is MODERN, options: CLASSIC | MODERN  ​themeMode: 'DEFAULT', // default value is DEFAULT, options: DEFAULT | DARK  customUser: {     customAttribute1: 'value1', //Add your custom attribute     customAttribute2: ‘value2’, //Add your custom attribute     hash: 'f30c3b0835ecd378a134c74bce8cea866df8c5b6e12a8c219c9bb288f7270e22'   }  }) 

Parameters

Custom User Object

Next Step

Launch Live Chat Application

Additional Resources

See All Integration Steps