ly.count.sdk.java

Class Countly

java.lang.Object

ly.count.sdk.java.Cly

ly.count.sdk.java.CountlyLifecycle

ly.count.sdk.java.Countly

All Implemented Interfaces:

Usage

public class Countly
extends CountlyLifecycle

Main Countly SDK API class.

• Initialize Countly SDK using #init(Application, Config).
• Stop Countly SDK with CountlyLifecycle.stop(boolean) if needed.
• Use session() to get a Session instance.
• Use login(String) & logout() when user logs in & logs out.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Countly	cly
static Device	device A class responsible for storage of device information sent to Countly server.
protected SDK	sdk

Fields inherited from class ly.count.sdk.java.CountlyLifecycle

L

Fields inherited from class ly.count.sdk.java.Cly

ctx, sdkInterface

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Countly(SDK sdk, CtxImpl ctx)

Method Summary

Modifier and Type	Method and Description
static Usage	api() Alternative to getSession() & session() method for accessing Countly SDK API.
Usage	changeDeviceIdWithMerge(java.lang.String id) Change device id with merging profiles on server, just set device id to new one.
Usage	changeDeviceIdWithoutMerge(java.lang.String id) Change device id without merging profiles on server, just set device id to new one.
java.lang.String	getDeviceId() This method returns the Device ID that is currently used by the SDK.
static Session	getSession() Deprecated. This method deprecated, please use session() instead.
Usage	login(java.lang.String id) Login function to set device (user) id on Countly server to the string specified here.
Usage	logout() Logout function to make current user anonymous (that is with random id according to ConfigCore.deviceIdStrategy and such).
static void	onConsent(Config.Feature... features) Consent function which enables corresponding features of SDK with respect to GDPR.
static void	onConsentRemoval(Config.Feature... features) Consent function which disables corresponding features of SDK with respect to GDPR.
Usage	resetDeviceId(java.lang.String id)
static Session	session() Returns active Session if any or creates new Session instance.

Methods inherited from class ly.count.sdk.java.CountlyLifecycle

init, isInitialized, isTracking, stop

Methods inherited from class ly.count.sdk.java.Cly

addCrashReport, addCrashReport, addLocation, addParam, event, session, timedEvent, user, view, view

Methods inherited from class java.lang.Object

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

Field Detail

device

public static Device device

A class responsible for storage of device information sent to Countly server. Call respective setters (i.e. Device.setAppVersion(String) prior to initializing the SDK to make sure data is reported.

cly

protected static Countly cly

sdk

protected SDK sdk

Constructor Detail

Countly

protected Countly(SDK sdk,
                  CtxImpl ctx)

Method Detail

session

public static Session session()

Returns active Session if any or creates new Session instance. NOTE: Session instances can expire, for example when ConfigCore.DID changes. Session also holds application context. So either do not store Session instances in any static variables and use this method or getSession() every time you need it, or check Session.isActive() before using it.

Returns:

active Session instance

getSession

public static Session getSession()

Deprecated. This method deprecated, please

use session() instead.

api

public static Usage api()

Alternative to getSession() & session() method for accessing Countly SDK API.

Returns:

Usage instance

login

public Usage login(java.lang.String id)

Description copied from interface: Usage

Login function to set device (user) id on Countly server to the string specified here. Closes current session, then starts new one automatically if ConfigCore.autoSessionsTracking is on, acquires device id.

Parameters:

id - new user / device id string, cannot be empty

logout

public Usage logout()

Description copied from interface: Usage

Logout function to make current user anonymous (that is with random id according to ConfigCore.deviceIdStrategy and such). Obviously makes sense only after a call to Usage.login(String), so it throws error or does nothing (depending on ConfigCore.testMode) if current id wasn't set using Usage.login(String). Closes current session.

getDeviceId

public java.lang.String getDeviceId()

Description copied from interface: Usage

This method returns the Device ID that is currently used by the SDK.

resetDeviceId

public Usage resetDeviceId(java.lang.String id)

changeDeviceIdWithMerge

public Usage changeDeviceIdWithMerge(java.lang.String id)

Description copied from interface: Usage

Change device id with merging profiles on server, just set device id to new one.

Parameters:

id - new user / device id string, cannot be empty

changeDeviceIdWithoutMerge

public Usage changeDeviceIdWithoutMerge(java.lang.String id)

Description copied from interface: Usage

Change device id without merging profiles on server, just set device id to new one.

Parameters:

id - new user / device id string, cannot be empty

onConsent

public static void onConsent(Config.Feature... features)

Consent function which enables corresponding features of SDK with respect to GDPR. Activates corresponding SDK features. Works only when Config.setRequiresConsent(boolean) is true.

Parameters:

features - features to turn on

onConsentRemoval

public static void onConsentRemoval(Config.Feature... features)

Consent function which disables corresponding features of SDK with respect to GDPR. Gracefully deactivates corresponding SDK features. Closes session if needed. Works only when Config.setRequiresConsent(boolean) is true.

Parameters:

features - features to turn offf