ly.count.sdk.java.internal

Class ModuleBase

java.lang.Object

ly.count.sdk.java.internal.ModuleBase

All Implemented Interfaces:

Module

Direct Known Subclasses:

Log, ModuleCrash, ModuleDeviceIdCore, ModuleRatingCore, ModuleRemoteConfig, ModuleRequests, ModuleSessions, ModuleViews

public abstract class ModuleBase
extends java.lang.Object
implements Module

Created by artem on 05/01/2017.

Constructor Summary

Constructors

Constructor and Description
ModuleBase()

Method Summary

Modifier and Type	Method and Description
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	onActivityCreated(CtxCore ctx) Activity is being created.
void	onActivityDestroyed(CtxCore ctx) Activity is being destroyed.
void	onActivityPaused(CtxCore ctx) Activity is being paused.
void	onActivityResumed(CtxCore ctx) Activity is being resumed.
void	onActivitySaveInstanceState(CtxCore ctx) Activity is saving state.
void	onActivityStarted(CtxCore ctx) Activity is being launched.
void	onActivityStopped(CtxCore ctx) Activity is being stopped.
void	onConfigurationChanged(CtxCore ctx) Called when android.content.res.Configuration changes.
void	onContextAcquired(CtxCore ctx) SDK got a first context.
void	onDeviceId(CtxCore ctx, ConfigCore.DID deviceId, ConfigCore.DID oldDeviceId) Device ID has been acquired from device id provider.
void	onLimitedContextAcquired(CtxCore ctx) SDK got a first context.
java.lang.Boolean	onRequest(Request request) This method is called only on owning module only if module marks request as owned (Request.own(Class).
void	onRequestCompleted(Request request, java.lang.String response, int responseCode) Called when the request is executed.
void	onSessionBegan(Session session, CtxCore ctx) Session is started.
void	onSessionEnded(Session session, CtxCore ctx) Session is ended.
void	onUserChanged(CtxCore ctx, org.json.JSONObject changes, java.util.Set<java.lang.String> cohortsAdded, java.util.Set<java.lang.String> cohortsRemoved) User object has been changed.
void	stop(CtxCore ctx, boolean clear) App user decided to opt out from analytics or developer changed important preferences.

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.internal.Module

getFeature

Constructor Detail

ModuleBase

public ModuleBase()

Method Detail

init

public void init(InternalConfig config)

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

Parameters:

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

onDeviceId

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

Description copied from interface: Module

Device ID has been acquired from device id provider. Can be invoked multiple times throughout Module lifecycle. Parameters can be instance equal (==), meaning that id haven't changed.

Specified by:

onDeviceId in interface Module

Parameters:

ctx - Ctx to run in

deviceId - deviceId valid from now on

oldDeviceId - deviceId valid previously if any

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

Parameters:

ctx - CtxCore to run in

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

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

Returns:

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

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

Parameters:

ctx - CtxCore with application instance

onLimitedContextAcquired

public void onLimitedContextAcquired(CtxCore ctx)

Description copied from interface: Module

SDK got a first context. Called only in InternalConfig.limited mode, that is from CountlyService or android.content.BroadcastReceiver.

Specified by:

onLimitedContextAcquired in interface Module

Parameters:

ctx - CtxCore with application context instance

onActivityCreated

public void onActivityCreated(CtxCore ctx)

Description copied from interface: Module

Activity is being created.

Specified by:

onActivityCreated in interface Module

Parameters:

ctx - CtxCore with activity set

onActivityStarted

public void onActivityStarted(CtxCore ctx)

Description copied from interface: Module

Activity is being launched.

Specified by:

onActivityStarted in interface Module

Parameters:

ctx - CtxCore with activity set

onActivityResumed

public void onActivityResumed(CtxCore ctx)

Description copied from interface: Module

Activity is being resumed.

Specified by:

onActivityResumed in interface Module

Parameters:

ctx - CtxCore with activity set

onActivityPaused

public void onActivityPaused(CtxCore ctx)

Description copied from interface: Module

Activity is being paused.

Specified by:

onActivityPaused in interface Module

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

Parameters:

ctx - CtxCore with activity set

onActivitySaveInstanceState

public void onActivitySaveInstanceState(CtxCore ctx)

Description copied from interface: Module

Activity is saving state.

Specified by:

onActivitySaveInstanceState in interface Module

Parameters:

ctx - CtxCore with activity set

onActivityDestroyed

public void onActivityDestroyed(CtxCore ctx)

Description copied from interface: Module

Activity is being destroyed.

Specified by:

onActivityDestroyed in interface Module

Parameters:

ctx - CtxCore with activity set

onSessionBegan

public void onSessionBegan(Session session,
                           CtxCore ctx)

Description copied from interface: Module

Session is started.

Specified by:

onSessionBegan in interface Module

Parameters:

session - session which began

onSessionEnded

public void onSessionEnded(Session session,
                           CtxCore ctx)

Description copied from interface: Module

Session is ended.

Specified by:

onSessionEnded in interface Module

Parameters:

session - session which ended

onUserChanged

public void onUserChanged(CtxCore ctx,
                          org.json.JSONObject changes,
                          java.util.Set<java.lang.String> cohortsAdded,
                          java.util.Set<java.lang.String> cohortsRemoved)

Description copied from interface: Module

User object has been changed.

Specified by:

onUserChanged in interface Module

changes - object with all the changes going to be sent to the server

cohortsAdded - set of cohorts this user has just been added to

cohortsRemoved - set of cohorts this user has just been removed from

onRequest

public java.lang.Boolean onRequest(Request request)

Description copied from interface: Module

This method is called only on owning module only if module marks request as owned (Request.own(Class). Gives a module another chance to modify request before sending. Being run in CountlyService.

Specified by:

onRequest in interface Module

Parameters:

request - request to check

Returns:

true if ok to send now, false if not ok to (remove request from queue), null if cannot decide yet

onRequestCompleted

public void onRequestCompleted(Request request,
                               java.lang.String response,
                               int responseCode)

Description copied from interface: Module

Called when the request is executed. Gives the module the ability to respond to the response received Request identification should be done through the Request ID

Specified by:

onRequestCompleted in interface Module

onConfigurationChanged

public void onConfigurationChanged(CtxCore ctx)

Description copied from interface: Module

Called when android.content.res.Configuration changes.

Specified by:

onConfigurationChanged in interface Module

Parameters:

ctx - CtxCore with only context set