Basic API’s

init

The init method is used for initializing SDK. This sets all required configurations and also sends system event sdk_start which allows it to record user.

Input

BlotoutAnalytics.INSTANCE.init(this,blotoutAnalyticsConfiguration);


`applicationContext`	`Object`	Application Context
`blotoutAnalyticsConfiguration`	`BlotoutAnalyticsConfiguration`	This Model contains information related to SDK initialization
`comletionHandler`	`CompletionHandler`	Return callback for sdk success and failure

BlotoutAnalyticsConfiguration


`setBlotoutSDKKey`	`String`	Required	Application token that you can get in your dashboard.
`setEndPointUrl`	`String`	Required	Url where you will be sending data.

Example

BlotoutAnalyticsConfiguration blotoutAnalyticsConfiguration = new BlotoutAnalyticsConfiguration();
blotoutAnalyticsConfiguration.setBlotoutSDKKey("EADAH5FV8B5MMVZ");
blotoutAnalyticsConfiguration.setEndPointUrl("https://stage.blotout.io/sdk/");
CompletionHandler comletionHandler = new CompletionHandler{
    @Override
    fun onSuccess() {

    }

    @Override
    fun onError() {

    }
}

BlotoutAnalytics.INSTANCE.init(this,blotoutAnalyticsConfiguration,comletionHandler);

capture

The capture method is used to record developer events. This allows you to send custom events to the server when a user is interacting with the app. For example, one custom event would be when a user adds an item to a cart.

Input

capture(eventName: String, eventInfo: HashMap<String, Any>)


`eventName`	`String`	Required	Name of the event that you are sending
`eventInfo`	`Object`	Optional	You can provide some additional data to this event. There is no limitation as this is just a key-value pair send to the server.

Example

HashMap<String,Object> eventInfo = new HashMap<>();
eventInfo.put("SKU","12345");
BlotoutAnalytics.INSTANCE.capture("custom event", eventInfo);

capturePersonal

PII (Personal Identifiable Information) events are like developer codified events that carry sensitive information related to the user. PHI ( Protected Health Information) events are like PII, but carry user’s private health information. In Blotout managed or deployed Infrastructure, PII and PHI events data is encrypted using asymmetric encryption algorithms and provides access to authenticated users only.

Input

capturePersonal(eventName: String, eventInfo: HashMap<String, Any>, isPHI: Boolean)


`eventName`	`String`	Required	Name of the event that you are sending
`eventInfo`	`Object`	Required	You can provide some additional data to this event. There is no limitation as this is just a key-value pair send to the server.
`isPHI`	`Boolean`	Optional	You can specify specific event type to an event

Example

HashMap<String,Object> PIIInfo = new HashMap<>();
eventInfo.put("emailId","developers@blotout.io");
BlotoutAnalytics.INSTANCE.capturePersonal("pii event", PIIInfo, true);

HashMap<String,Object> PHIInfo = new HashMap<>();
eventInfo.put("bloodType","A+");
BlotoutAnalytics.INSTANCE.capturePersonal("phi event", PHIInfo, true);

getUserId

The getUserId method allows you to go get Blotout user id that is linked to all data that is sent to the server.

Output

Returns user ID as string.

Example

var userId = BlotoutAnalytics.INSTANCE.getUserId()

enable

The enable method allows you to enable/disable the sending of analytics data. Enabled by default.


`enable`	`Boolean`	Required	Enable/disable SDK.

Example

BlotoutAnalytics.INSTANCE.enable(true)