ly.count.sdk.java.internal

Interface Module

All Known Implementing Classes:

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

public interface Module

Module of Countly SDK. Contract:

• Module instances must provide empty constructor with no parameters.
• Module instance can be accessed only through this interface (static methods allowed for encapsulation).
• Module instance encapsulates all module-specific logic inside.
• Module cannot acquire instance or call another Module.

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getFeature()
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 init(InternalConfig) and haven't been stopped yet by 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.

Method Detail

init

void init(InternalConfig config)
   throws java.lang.IllegalArgumentException,
          java.lang.IllegalStateException

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.

Parameters:

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

Throws:

java.lang.IllegalArgumentException - in case supplied InternalConfig is not consistent.

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

stop

void stop(CtxCore ctx,
          boolean clear)

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

Parameters:

ctx - CtxCore to run in

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

isActive

boolean isActive()

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

Returns:

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

onContextAcquired

void onContextAcquired(CtxCore ctx)

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

Parameters:

ctx - CtxCore with application instance

onLimitedContextAcquired

void onLimitedContextAcquired(CtxCore ctx)

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

Parameters:

ctx - CtxCore with application context instance

onDeviceId

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

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.

Parameters:

ctx - Ctx to run in

deviceId - deviceId valid from now on

oldDeviceId - deviceId valid previously if any

onActivityCreated

void onActivityCreated(CtxCore ctx)

Activity is being created.

Parameters:

ctx - CtxCore with activity set

onActivityStarted

void onActivityStarted(CtxCore ctx)

Activity is being launched.

Parameters:

ctx - CtxCore with activity set

onActivityResumed

void onActivityResumed(CtxCore ctx)

Activity is being resumed.

Parameters:

ctx - CtxCore with activity set

onActivityPaused

void onActivityPaused(CtxCore ctx)

Activity is being paused.

Parameters:

ctx - CtxCore with activity set

onActivityStopped

void onActivityStopped(CtxCore ctx)

Activity is being stopped.

Parameters:

ctx - CtxCore with activity set

onActivitySaveInstanceState

void onActivitySaveInstanceState(CtxCore ctx)

Activity is saving state.

Parameters:

ctx - CtxCore with activity set

onActivityDestroyed

void onActivityDestroyed(CtxCore ctx)

Activity is being destroyed.

Parameters:

ctx - CtxCore with activity set

onSessionBegan

void onSessionBegan(Session session,
                    CtxCore ctx)

Session is started.

Parameters:

session - session which began

onSessionEnded

void onSessionEnded(Session session,
                    CtxCore ctx)

Session is ended.

Parameters:

session - session which ended

onUserChanged

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.

Parameters:

ctx -

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

java.lang.Boolean onRequest(Request request)

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.

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

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

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

onConfigurationChanged

void onConfigurationChanged(CtxCore ctx)

Called when android.content.res.Configuration changes.

Parameters:

ctx - CtxCore with only context set

getFeature

java.lang.Integer getFeature()

Returns:

Module feature index if any