ly.count.sdk.java

Interface Usage

All Known Subinterfaces:

Session

All Known Implementing Classes:

Cly, Countly, CountlyLifecycle, SessionImpl

public interface Usage

This interface represents session concept, that is one indivisible usage occasion of your application. Any data sent to Countly server is processed in a context of Session. Only one session can send requests at a time, so even if you create 2 parallel sessions, they will be made consequent automatically at the time of Countly SDK choice with no correctness guarantees, so please avoid having parallel sessions.

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.
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.
Event	event(java.lang.String key) Create event object, don't record it yet.
java.lang.String	getDeviceId() This method returns the Device ID that is currently used by the SDK.
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).
Usage	resetDeviceId(java.lang.String id) Deprecated. This method is no longer acceptable to change device id. Use changeDeviceIdWithoutMerge(String) or changeDeviceIdWithMerge(String)
Event	timedEvent(java.lang.String key) Get existing or create new timed event object, don't record it.
User	user() Get current User Profile.
View	view(java.lang.String name) Identical to 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.

Method Detail

event

Event event(java.lang.String key)

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

Parameters:

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

Returns:

Event instance.

See Also:

Event.record()

timedEvent

Event timedEvent(java.lang.String key)

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

Parameters:

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

Returns:

timed Event instance.

See Also:

to end timed event

user

User user()

Get current User Profile. Note that data is not downloaded from server. Only properties set in current app installation are returned in User object. Note that even when the CoreFeature.UserProfiles is disabled, this method still returns an object, yet any modifications to it won't result in any data stored or sent to the server/ //@ee Feature is not available in Countly Community Edition

Returns:

current User instance

addParam

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

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

Parameters:

key - name of parameter

value - value of parameter

Returns:

this instance for method chaining.

addCrashReport

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

Send Crash Report to the server.

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

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.

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

Usage addLocation(double latitude,
                  double longitude)

Send location information to the server.

Parameters:

latitude - geographical latitude of the user

longitude - geographical longitude of the user

Returns:

this instance for method chaining.

view

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

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.

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

View view(java.lang.String name)

Identical to 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.

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)

login

Usage login(java.lang.String id)

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

Usage logout()

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 login(String), so it throws error or does nothing (depending on ConfigCore.testMode) if current id wasn't set using login(String). Closes current session.

getDeviceId

java.lang.String getDeviceId()

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

resetDeviceId

Usage resetDeviceId(java.lang.String id)

Deprecated. This method is no longer acceptable to change device id.

Use changeDeviceIdWithoutMerge(String) or changeDeviceIdWithMerge(String)

changeDeviceIdWithMerge

Usage changeDeviceIdWithMerge(java.lang.String id)

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

Usage changeDeviceIdWithoutMerge(java.lang.String id)

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