ly.count.sdk.java.internal

Class ModuleSessions

java.lang.Object

ly.count.sdk.java.internal.ModuleBase

ly.count.sdk.java.internal.ModuleSessions

All Implemented Interfaces:

Module

public class ModuleSessions
extends ModuleBase

Constructor Summary

Constructors

Constructor and Description
ModuleSessions()

Method Summary

Modifier and Type	Method and Description
void	forgetSession()
java.lang.Integer	getFeature()
SessionImpl	getSession()
void	init(InternalConfig config) All initialization must be done in this method, not constructor.
boolean	isActive() A method to be used by module itself to determine if it was initialized by Module.init(InternalConfig) and haven't been stopped yet by Module.stop(CtxCore, boolean).
void	onActivityStarted(CtxCore ctx) Activity is being launched.
void	onActivityStopped(CtxCore ctx) Activity is being stopped.
void	onContextAcquired(CtxCore ctx) SDK got a first context.
void	onDeviceId(CtxCore ctx, ConfigCore.DID deviceId, ConfigCore.DID oldDeviceId) Handles one single case of device id change with auto sessions handling, see first if here:
SessionImpl	session(CtxCore ctx, java.lang.Long id)
void	stop(CtxCore ctx, boolean clear) App user decided to opt out from analytics or developer changed important preferences.
ly.count.sdk.java.internal.TimedEvents	timedEvents()

Methods inherited from class ly.count.sdk.java.internal.ModuleBase

onActivityCreated, onActivityDestroyed, onActivityPaused, onActivityResumed, onActivitySaveInstanceState, onConfigurationChanged, onLimitedContextAcquired, onRequest, onRequestCompleted, onSessionBegan, onSessionEnded, onUserChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleSessions

public ModuleSessions()

Method Detail

getSession

public SessionImpl getSession()

session

public SessionImpl session(CtxCore ctx,
                           java.lang.Long id)

forgetSession

public void forgetSession()

getFeature

public java.lang.Integer getFeature()

Returns:

Module feature index if any

init

public void init(InternalConfig config)
          throws java.lang.IllegalStateException

Description copied from interface: Module

All initialization must be done in this method, not constructor. This method is guaranteed to be run right after constructor with no module-related actions in between.

Specified by:

init in interface Module

Overrides:

init in class ModuleBase

Parameters:

config - Countly configuration object: can be stored locally if needed.

Throws:

java.lang.IllegalStateException - if some required for this module platform feature is not available on this platform.

onContextAcquired

public void onContextAcquired(CtxCore ctx)

Description copied from interface: Module

SDK got a first context. Called only in main mode (from Application#onCreate())

Specified by:

onContextAcquired in interface Module

Overrides:

onContextAcquired in class ModuleBase

Parameters:

ctx - CtxCore with application instance

isActive

public boolean isActive()

Description copied from interface: Module

A method to be used by module itself to determine if it was initialized by Module.init(InternalConfig) and haven't been stopped yet by Module.stop(CtxCore, boolean).

Specified by:

isActive in interface Module

Overrides:

isActive in class ModuleBase

Returns:

true if module is allowed to continue to run, false otherwise

stop

public void stop(CtxCore ctx,
                 boolean clear)

Description copied from interface: Module

App user decided to opt out from analytics or developer changed important preferences. Clear all module-related data, close any resources and prepare to start from clean sheet. This method is guaranteed to be the latest method call to this module instance.

• Stop all tasks, clear all context references.
• Not a single function call can be fired from this object after the method returns.
• Remove all module-related Storable files if clear is true

Specified by:

stop in interface Module

Overrides:

stop in class ModuleBase

Parameters:

ctx - CtxCore to run in

clear - true if module must clear it's data files, false otherwise

onDeviceId

public void onDeviceId(CtxCore ctx,
                       ConfigCore.DID deviceId,
                       ConfigCore.DID oldDeviceId)

Handles one single case of device id change with auto sessions handling, see first if here:

Specified by:

onDeviceId in interface Module

Overrides:

onDeviceId in class ModuleBase

Parameters:

ctx - Ctx to run in

deviceId - deviceId valid from now on

oldDeviceId - deviceId valid previously if any

See Also:

ModuleDeviceIdCore.onDeviceId(CtxCore, ConfigCore.DID, ConfigCore.DID)

onActivityStarted

public void onActivityStarted(CtxCore ctx)

Description copied from interface: Module

Activity is being launched.

Specified by:

onActivityStarted in interface Module

Overrides:

onActivityStarted in class ModuleBase

Parameters:

ctx - CtxCore with activity set

onActivityStopped

public void onActivityStopped(CtxCore ctx)

Description copied from interface: Module

Activity is being stopped.

Specified by:

onActivityStopped in interface Module

Overrides:

onActivityStopped in class ModuleBase

Parameters:

ctx - CtxCore with activity set

timedEvents

public ly.count.sdk.java.internal.TimedEvents timedEvents()