ly.count.sdk.java

Class Cly

java.lang.Object

ly.count.sdk.java.Cly

All Implemented Interfaces:

Usage

Direct Known Subclasses:

CountlyLifecycle

public abstract class Cly
extends java.lang.Object
implements Usage

Field Summary

Fields

Modifier and Type	Field and Description
protected static Cly	cly
protected CtxCore	ctx
protected SDKInterface	sdkInterface

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Cly()

Method Summary

Modifier and Type	Method and Description
Usage	addCrashReport(java.lang.Throwable t, boolean fatal) Send Crash Report to the server.
Usage	addCrashReport(java.lang.Throwable t, boolean fatal, java.lang.String name, java.util.Map<java.lang.String,java.lang.String> segments, java.lang.String... logs) Send Crash Report to the server.
Usage	addLocation(double latitude, double longitude) Send location information to the server.
Usage	addParam(java.lang.String key, java.lang.Object value) Add parameter to this session which will be sent along with next request.
Event	event(java.lang.String key) Create event object, don't record it yet.
protected static Session	getSession()
protected static Session	session(CtxCore ctx)
Event	timedEvent(java.lang.String key) Get existing or create new timed event object, don't record it.
User	user() Get current User Profile object.
View	view(java.lang.String name) Identical to Usage.view(String, boolean), but without start parameter which is determined automatically based on whether this view is first in this session.
View	view(java.lang.String name, boolean start) Start new view.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ly.count.sdk.java.Usage

changeDeviceIdWithMerge, changeDeviceIdWithoutMerge, getDeviceId, login, logout, resetDeviceId

Field Detail

cly

protected static Cly cly

ctx

protected CtxCore ctx

sdkInterface

protected SDKInterface sdkInterface

Constructor Detail

Cly

protected Cly()

Method Detail

session

protected static Session session(CtxCore ctx)

getSession

protected static Session getSession()

event

public Event event(java.lang.String key)

Description copied from interface: Usage

Create event object, don't record it yet. Creates begin request if this session hasn't yet been began.

Specified by:

event in interface Usage

Parameters:

key - key for this event, cannot be null or empty

Returns:

Event instance.

See Also:

Event.record()

timedEvent

public Event timedEvent(java.lang.String key)

Description copied from interface: Usage

Get existing or create new timed event object, don't record it. Creates begin request if this session hasn't yet been began.

Specified by:

timedEvent in interface Usage

Parameters:

key - key for this event, cannot be null or empty

Returns:

timed Event instance.

See Also:

to end timed event

user

public User user()

Get current User Profile object.

Specified by:

user in interface Usage

Returns:

current User Profile instance

See Also:

to get {@link UserEditor} object, to submit changes to the server

addParam

public Usage addParam(java.lang.String key,
                      java.lang.Object value)

Description copied from interface: Usage

Add parameter to this session which will be sent along with next request.

Specified by:

addParam in interface Usage

Parameters:

key - name of parameter

value - value of parameter

Returns:

this instance for method chaining.

addCrashReport

public Usage addCrashReport(java.lang.Throwable t,
                            boolean fatal)

Description copied from interface: Usage

Send Crash Report to the server.

Specified by:

addCrashReport in interface Usage

Parameters:

t - Throwable to log

fatal - whether this crash report should be displayed as fatal in dashboard or not

Returns:

this instance for method chaining.

addCrashReport

public Usage addCrashReport(java.lang.Throwable t,
                            boolean fatal,
                            java.lang.String name,
                            java.util.Map<java.lang.String,java.lang.String> segments,
                            java.lang.String... logs)

Description copied from interface: Usage

Send Crash Report to the server.

Specified by:

addCrashReport in interface Usage

Parameters:

t - Throwable to log

fatal - whether this crash report should be displayed as fatal in dashboard or not

name - (optional, can be null) name of the report, falls back to first line of stack trace by default

segments - (optional, can be null) additional crash segments map

logs - (optional, can be null) additional log lines (separated by \n) or comment about this crash report

Returns:

this instance for method chaining.

addLocation

public Usage addLocation(double latitude,
                         double longitude)

Description copied from interface: Usage

Send location information to the server.

Specified by:

addLocation in interface Usage

Parameters:

latitude - geographical latitude of the user

longitude - geographical longitude of the user

Returns:

this instance for method chaining.

view

public View view(java.lang.String name,
                 boolean start)

Description copied from interface: Usage

Start new view. In case previous view in this session is not ended yet, it will be ended automatically. In case session ends and last view haven't been ended yet, it will be ended automatically. Creates begin request if this session hasn't yet been began.

Specified by:

view in interface Usage

Parameters:

name - String representing name of this View

start - whether this view is first in current application launch

Returns:

new but already started View, you're responsible for its ending by calling View.stop(boolean)

view

public View view(java.lang.String name)

Description copied from interface: Usage

Identical to Usage.view(String, boolean), but without start parameter which is determined automatically based on whether this view is first in this session. Creates begin request if this session hasn't yet been began.

Specified by:

view in interface Usage

Parameters:

name - String representing name of this View

Returns:

new but already started View, you're responsible for its ending by calling View.stop(boolean)