Upsight logo Back to top

Basic Messages

startSession

Overview


Call this method to initiate the SDK. An apa message will be sent on first run.

Note The Enterprise SDK creates a user identifier, referred to as the sender ID. This ID can be substituted with another identifier (i.e. Your own ID). When substituting with another identifier, ensure that it is an integer, otherwise it will not pass.

Warning Using a custom sender ID instead of the one generated by the SDK can result in potential drawbacks for marketing and analytics. For further information, please contact your CSM or Upsight Support.

startSession

Overload List


Method CallParameters
void startSession(
        string apiKey, 
        bool enableTestMode )
  • apiKey
  • enableTestMode
void startSession(
        string apiKey,
        bool enableTestMode,
        string senderId )
  • apiKey
  • enableTestMode
  • senderId
void startSession(
        string apiKey,
        bool enableTestMode,
        string senderId,
        bool shouldSendAPA )
  • apiKey
  • enableTestMode
  • senderId
  • shouldSendAPA
void startSession(
        string apiKey,
        bool enableTestMode,
        string senderId,
        string fbAppID )
Depricated
  • apiKey
  • enableTestMode
  • senderId
  • fbAppID
void startSession(
        string apiKey,
        bool enableTestMode,
        string senderId,
        bool shouldSendAPA,
        string apiKeyForTimezone,
        string apiKeyTimezoneOffset,
        string customID )
Depricated
  • apiKey
  • enableTestMode
  • senderId
  • shouldSendAPA
  • apiKeyForTimezone
  • apiKeyTimezoneOffset
  • customID
void startSession(
        string apiKey,
        bool enableTestMode,
        string senderId,
        bool shouldSendAPA,
        string apiKeyForTimezone,
        string apiKeyTimezoneOffset,
        string customID,
        string fbAppID )
Depricated
  • apiKey
  • enableTestMode
  • senderId
  • shouldSendAPA
  • apiKeyForTimezone
  • apiKeyTimezoneOffset
  • customID
  • fbAppID
void startSession(
        string apiKey,
        bool enableTestMode,
        string senderId,
        bool shouldSendAPA,
        string apiKeyForTimezone,
        string apiKeyTimezoneOffset,
        string customID,
        string fbAppID,
        bool enableAcquisitionTracking )
  • apiKey
  • enableTestMode
  • senderId
  • shouldSendAPA
  • apiKeyForTimezone
  • apiKeyTimezoneOffset
  • customID
  • fbAppID
  • enableAcquisitionTracking

startSession

Parameters


ParameterTypeDescription
apiKeystringThe API Key of your application. This key is automatically generated when you set up your application in your Dashboard.
enableTestModebooleanDetermines whether you send data to Upsight Analytics Test or Production servers. For Production, set this parameter to false. For Test, set this parameter to true. Default is false.
senderIdstringA unique, unsigned 64-bit integer in the form of a String. This parameter denotes the unique identifier of the application user. If your application creates user IDs larger than 64-bits, you must convert the user ID to an unsigned 64-bit integer to send to Upsight Analytics. For more information click here.
shouldSendAPAbooleanDetermines whether to send an application added message automatically on the first install. Default is true if the method doesn't require it.
fbAppIDstringDepricated Your unique app ID if you have a Facebook App associated with your app. Can be set to null.
apiKeyForTimezonestringDepricated This should always be set to null.
apiKeyTimezoneOffsetstringDepricated This should always be set to null.
customIDstringCustomer specified ID which will be a part of su tag for apa messages.
enableAcquisitionTrackingbooleanThis should be set to true if you would like to enable Acquisition Tracking.

startSession

Code Example


string apiKey = "abcdefg12345678";
string apiKey = "gfedcba87654321";
bool isTestMode = true;

KontagentBinding.startSession(apiKey, isTestMode);

stopSession

Overview


Call this method to close the session. No parameters are required.

stopSession

Overload List


Method CallParameters
void stopSession()
 

stopSession

Parameters


No parameters are required.

stopSession

Code Example


KontagentBinding.stopSession();

sendDeviceInformation

Overview


This method gathers manufacturer, model, OS version, and carrier on launch of the application. You should call this method upon every launch.

sendDeviceInformation

Overload List


Method CallParameters
void sendDeviceInformation( Dictionary<string, string> optionalParams )
  • optionalParams

sendDeviceInformation

Parameters


ParameterTypeDescription
optionalParamsDictionary<string, string>A Dictionary with that can hold extra information. The keys that you can use and the value they should represent are listed in the Optional Parameters section below.

sendDeviceInformation

Optional Parameters


DescriptionParameterInput Description
Version Informationv_majString representing the Customer's application version numbering scheme. (Limited to 50 chars)
DatadataAdditional data, a JSON object string representing a dictionary or map of key-value pairs. It must be base64-encoded. Click here for more information.

sendDeviceInformation

Code Example


Dictionary<string, string> optionalParams = new Dictionary<string, string>();

optionalParams.Add("v_maj", "1.2.3");

KontagentBinding.sendDeviceInformation(optionalParams);