io.customerly

Class Customerly

java.lang.Object

io.customerly.Customerly

public class Customerly
extends java.lang.Object

The singleton representing the Customerly SDK

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Customerly.Callback
class	Customerly.RegisterUserTask
class	Customerly.SetAttributesTask
class	Customerly.SetCompanyTask
static interface	Customerly.Task
class	Customerly.UpdateTask

Method Summary

Modifier and Type	Method and Description
static void	configure(android.app.Application pApplication, java.lang.String pCustomerlyAppID) Call this method to configure the SDK indicating the Customerly App ID before accessing it.
static void	configure(android.app.Application pApplication, java.lang.String pCustomerlyAppID, int pWidgetColor) Call this method to configure the SDK indicating the Customerly App ID before accessing it.
static Customerly	get() Call this method to obtain the reference to the Customerly SDK
void	logoutUser() Call this method to close the user's Customerly session.
void	openSupport(android.app.Activity activity) Call this method to open the Support Activity.
Customerly.RegisterUserTask	registerUser(java.lang.String email) Call this method to link your app user to the Customerly session.
Customerly.SetAttributesTask	setAttributes(java.util.HashMap<java.lang.String,java.lang.Object> pAttributes) Call this method to add new custom attributes to the user.
Customerly.SetCompanyTask	setCompany(java.util.HashMap<java.lang.String,java.lang.Object> pCompany) Call this method to add company attributes to the user.
void	setVerboseLogging(boolean pVerboseLogging) Call this method to enable error logging in the Console.
void	trackEvent(java.lang.String pEventName) Call this method to keep track of custom labelled events.
Customerly.UpdateTask	update()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

get

@NonNull
public static Customerly get()

Call this method to obtain the reference to the Customerly SDK

Returns:

The Customerly SDK instance reference

configure

public static void configure(@NonNull
                             android.app.Application pApplication,
                             @NonNull
                             java.lang.String pCustomerlyAppID)

Call this method to configure the SDK indicating the Customerly App ID before accessing it.
Call this from your custom Application Application.onCreate()

Parameters:

pApplication - The application class reference

pCustomerlyAppID - The Customerly App ID found in your Customerly console

configure

public static void configure(@NonNull
                             android.app.Application pApplication,
                             @NonNull
                             java.lang.String pCustomerlyAppID,
                             int pWidgetColor)

Call this method to configure the SDK indicating the Customerly App ID before accessing it.
Call this from your custom Application Application.onCreate()

You can choose to ignore the widget_color provided by the Customerly web console for the action bar styling in support activities and use an app-local widget_color instead.

Parameters:

pCustomerlyAppID - The Customerly App ID found in your Customerly console

pWidgetColor - The custom widget_color. If Color.TRANSPARENT, it will be ignored

setVerboseLogging

public void setVerboseLogging(boolean pVerboseLogging)

Call this method to enable error logging in the Console. Avoid to enable it in release app versions, the suggestion is to pass your.application.package.BuildConfig.DEBUG as parameter

Parameters:

pVerboseLogging - true for enable logging, please pass your.application.package.BuildConfig.DEBUG

update

@CheckResult
 @NonNull
public Customerly.UpdateTask update()

registerUser

@CheckResult
 @NonNull
public Customerly.RegisterUserTask registerUser(@NonNull
                                                                       java.lang.String email)

Call this method to link your app user to the Customerly session.
This method returns a Customerly.RegisterUserTask that has to be started with his method Customerly.__Task.start()
You have to configure the Customerly SDK before using this method with configure(Application,String)

Parameters:

email - The mail address of the user

setAttributes

@CheckResult
 @NonNull
public Customerly.SetAttributesTask setAttributes(@NonNull
                                                                         java.util.HashMap<java.lang.String,java.lang.Object> pAttributes)
                                                                  throws java.lang.IllegalArgumentException

Call this method to add new custom attributes to the user.

You have to configure the Customerly SDK before using this method with configure(Application,String)

Parameters:

pAttributes - Optional attributes for the user. Can contain only String, char, int, long, float or double values

Throws:

java.lang.IllegalArgumentException - is thrown if the attributes check fails

setCompany

@CheckResult
 @NonNull
public Customerly.SetCompanyTask setCompany(@NonNull
                                                                   java.util.HashMap<java.lang.String,java.lang.Object> pCompany)
                                                            throws java.lang.IllegalArgumentException

Call this method to add company attributes to the user.
The map must contain a String value with key "company_id" containing to the Company ID and a String value with key "name" containing the Company name

You have to configure the Customerly SDK before using this method with configure(Application,String)

Parameters:

pCompany - Optional company for the user. The map must contain a String value with key "company_id" containing to the Company ID and a String value with key "name" containing the Company name

Throws:

java.lang.IllegalArgumentException - is thrown if company map check fails

openSupport

public void openSupport(@NonNull
                        android.app.Activity activity)

Call this method to open the Support Activity.

You have to configure the Customerly SDK before using this method with configure(Application,String)

Parameters:

activity - The current activity

logoutUser

public void logoutUser()

Call this method to close the user's Customerly session.

You have to configure the Customerly SDK before using this method with configure(Application,String)

trackEvent

public void trackEvent(@NonNull
                       java.lang.String pEventName)

Call this method to keep track of custom labelled events.

You have to configure the Customerly SDK before using this method with configure(Application,String)

Parameters:

pEventName - The event custom label