com.infantium.android.sdk

Class InfantiumSDK

Object

InfantiumSDK

All Implemented Interfaces:

ISDK

public class InfantiumSDK
extends Object
implements ISDK

Field Summary

Fields

Modifier and Type	Field and Description
static String	version

Method Summary

Methods

Modifier and Type	Method and Description
InfantiumResponse	addDynamicField(DynamicField d_field) Add new DynamicField to the dynamic field List.
InfantiumResponse	addDynamicFields(List<DynamicField> d_fields) Add a List of DynamicFields that will appear in the Gameplay.
InfantiumResponse	addElement(Element element) Add new Element to the element List.
InfantiumResponse	addElements(List<Element> elements) Add a List of Elements that will appear in the Gameplay.
InfantiumResponse	addEvent(Event event) Add an Event to the current Rawdata.
InfantiumResponse	addEvents(List<Event> events) Add a list of Events to the current Rawdata.
InfantiumResponse	addGoal(Goal goal) Add a Goal to the current Rawdata.
InfantiumResponse	addGoals(List<Goal> goals) Add a list of Goals to the current Rawdata.
void	clearReceivers() Very specific method to be called only by Apps that cannot overwrite the onPause and onResume Android methods.
InfantiumResponse	closeGameplay() End of the gameplay (Ebook or Game).
InfantiumResponse	createGameplay() Creates a new Gameplay obtaining the gameplay_id and the gameplay_uuid.
InfantiumResponse	createGameplay(String subcontent_uuid) Creates a new Gameplay obtaining the gameplay_id and the gameplay_uuid.
static InfantiumSDK	getInfantiumSDK(Context context) This function exposes the unique instance whereby InfantiumSDK can be accessed.
static InfantiumSDK	getInfantiumSDK(Context context, String server, Boolean debug) This function exposes the unique instance whereby InfantiumSDK can be accessed.
void	getPlayerUUIDFromApp() Called by OnResume to get the player from the App
InfantiumResponse	newBasicInteraction(String t, String goal_type) Adds an interaction with the screen.
InfantiumResponse	newBasicInteraction(String t, String object_type, String goal_type) Adds an interaction with the screen.
InfantiumResponse	newBasicInteraction(String t, String object_type, String goal_type, Integer lifetime) Adds an interaction with the screen.
InfantiumResponse	newBasicInteraction(String t, String object_type, String goal_type, Integer n_concurrent_oks, Integer n_concurrent_kos) Adds an interaction with the screen.
InfantiumResponse	newBasicInteraction(String t, String object_type, String goal_type, Integer lifetime, Integer n_concurrent_oks, Integer n_concurrent_kos) Adds an interaction with the screen.
void	onPauseInfantium() Method to be called when overwriting the onPause method of Android
void	onResumeInfantium() Method to be called when overwriting the onResume method of Android
void	restartRawdata() Restarts and cleans all the data in the Rawdata
Boolean	returnToInfantiumApp(Activity activ) Returns the user interaction to the Infantium App
void	sendEbookRawData(int num_page, boolean text, boolean read_to_me) Send the EBook Rawdata.
void	sendGameRawData() Send the Game Rawdata.
void	sendVideoRawdata(int view_time, int pause, int rewind, int forward, int replay) Set the rawdata of the Video.
InfantiumResponse	setContentAppUUID(String contentapp_uuid) Set Contentapp_uuid from the game or ebook.
InfantiumResponse	setContentUUID(String content_uuid) Set the content_uuid from the video or ebook
void	setDeveloperCredentials(String api_user, String api_key) Set the developer's credentials in order to contact with the API.
void	setDeveloperHandler(InfantiumAsyncResponseHandler handler) In this function the developer defines a InfantiumAsyncResponseHandler where all the asyncronous communications will be received.
void	setDeviceInfo(int heightPixels, int widthPixels) Set the device dimensions
InfantiumResponse	setPlayerUUID(String player_uuid) Obtain the information from the player and his related tutor.
static void	setResumeAndPauseDeactivated(Boolean resumeAndPause)
InfantiumResponse	setSubContentUUID(String subcontent_uuid) Set the subContentapp_uuid from the game.
InfantiumResponse	startPlaying() Restarts the Rawdata timestamp.
InfantiumResponse	triggerExistingEvent(String event_id) Adds the triggering of an existing event
InfantiumResponse	triggerExistingEvent(String event_id, String triggered_by) Adds the triggering of an existing event

Methods inherited from class Object

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

Field Detail

version

public static final String version

See Also:

Constant Field Values

Method Detail

getInfantiumSDK

public static InfantiumSDK getInfantiumSDK(Context context)

This function exposes the unique instance whereby InfantiumSDK can be accessed.

Parameters:

context -

Returns:

the SDK object

getInfantiumSDK

public static InfantiumSDK getInfantiumSDK(Context context,
                           String server,
                           Boolean debug)

This function exposes the unique instance whereby InfantiumSDK can be accessed.

Parameters:

context -

server -

debug -

Returns:

the SDK object

setResumeAndPauseDeactivated

public static void setResumeAndPauseDeactivated(Boolean resumeAndPause)

Parameters:

resumeAndPause -

getPlayerUUIDFromApp

public void getPlayerUUIDFromApp()

Called by OnResume to get the player from the App

returnToInfantiumApp

public Boolean returnToInfantiumApp(Activity activ)

Returns the user interaction to the Infantium App

Specified by:

returnToInfantiumApp in interface ISDK

Parameters:

activ - The current activity (this) of the app including the SDK

setDeviceInfo

public void setDeviceInfo(int heightPixels,
                 int widthPixels)

Set the device dimensions

Specified by:

setDeviceInfo in interface ISDK

Parameters:

widthPixels - Width of the device.

heightPixels - Height of the device.

Throws:

IllegalArgumentException.

setDeveloperCredentials

public void setDeveloperCredentials(String api_user,
                           String api_key)

Set the developer's credentials in order to contact with the API.

Specified by:

setDeveloperCredentials in interface ISDK

Parameters:

api_user - The developer's personal user.

api_key - The developer's personal key.

setDeveloperHandler

public void setDeveloperHandler(InfantiumAsyncResponseHandler handler)

In this function the developer defines a InfantiumAsyncResponseHandler where all the asyncronous communications will be received.

Specified by:

setDeveloperHandler in interface ISDK

Parameters:

handler - The asyncronous handler instance.

setContentAppUUID

public InfantiumResponse setContentAppUUID(String contentapp_uuid)

Set Contentapp_uuid from the game or ebook.

Specified by:

setContentAppUUID in interface ISDK

Parameters:

contentapp_uuid - - The uuid of the contentapp.

setContentUUID

public InfantiumResponse setContentUUID(String content_uuid)

Set the content_uuid from the video or ebook

Specified by:

setContentUUID in interface ISDK

Parameters:

content_uuid - - The UUID of the content.

setSubContentUUID

public InfantiumResponse setSubContentUUID(String subcontent_uuid)

Set the subContentapp_uuid from the game.

Specified by:

setSubContentUUID in interface ISDK

Parameters:

subcontent_uuid - - The UUID of the subcontentapp.

setPlayerUUID

public InfantiumResponse setPlayerUUID(String player_uuid)

Obtain the information from the player and his related tutor. Useful for sending rawdatas without do login or creating anonymous player.

Specified by:

setPlayerUUID in interface ISDK

Parameters:

player_uuid - - The UUID of the player.

See Also:

setContentAppUUID(String)

createGameplay

public InfantiumResponse createGameplay(String subcontent_uuid)

Creates a new Gameplay obtaining the gameplay_id and the gameplay_uuid.

Specified by:

createGameplay in interface ISDK

Parameters:

subcontent_uuid - - The UUID of the subcontent.

createGameplay

public InfantiumResponse createGameplay()

Creates a new Gameplay obtaining the gameplay_id and the gameplay_uuid. Use this function when creating an Ebook Gameplay.

Specified by:

createGameplay in interface ISDK

See Also:

setContentUUID(String)

closeGameplay

public InfantiumResponse closeGameplay()

End of the gameplay (Ebook or Game).

Specified by:

closeGameplay in interface ISDK

See Also:

createGameplay(String), createGameplay()

startPlaying

public InfantiumResponse startPlaying()

Restarts the Rawdata timestamp. Must be called at the start of the gameplay.

Specified by:

startPlaying in interface ISDK

addElement

public InfantiumResponse addElement(Element element)

Add new Element to the element List. The Element will appear in the Gameplay.

Specified by:

addElement in interface ISDK

Parameters:

element - - The element object.

Returns:

InfantiumResponse - Confirms that the request has completed successfully (Valid) or not (descriptive string of the error).

addElements

public InfantiumResponse addElements(List<Element> elements)

Add a List of Elements that will appear in the Gameplay.

Specified by:

addElements in interface ISDK

Parameters:

elements - - A list of Elements.

Returns:

InfantiumResponse - Confirms that the request has completed successfully (Valid) or not (descriptive string of the error).

addDynamicField

public InfantiumResponse addDynamicField(DynamicField d_field)

Add new DynamicField to the dynamic field List.

Specified by:

addDynamicField in interface ISDK

Parameters:

d_field - - The DynamicField object.

Returns:

InfantiumResponse - Confirms that the request has completed successfully (Valid) or not (descriptive string of the error).

addDynamicFields

public InfantiumResponse addDynamicFields(List<DynamicField> d_fields)

Add a List of DynamicFields that will appear in the Gameplay.

Specified by:

addDynamicFields in interface ISDK

Parameters:

d_fields - - A list of DynamicFields.

Returns:

InfantiumResponse - Confirms that the request has completed successfully (Valid) or not (descriptive string of the error).

sendVideoRawdata

public void sendVideoRawdata(int view_time,
                    int pause,
                    int rewind,
                    int forward,
                    int replay)

Set the rawdata of the Video.

Specified by:

sendVideoRawdata in interface ISDK

Parameters:

view_time - - View time in milliseconds.

pause - - Amount of times the video has paused

rewind - - Amount of times the video been rewinded

forward - - Amount of times the video been forwarded

replay - - Amount of times the video been replayed

See Also:

setContentUUID(String)

sendEbookRawData

public void sendEbookRawData(int num_page,
                    boolean text,
                    boolean read_to_me)

Send the EBook Rawdata.

Specified by:

sendEbookRawData in interface ISDK

Parameters:

num_page - - The page number of the book.

text - - true if the page contains text and false if not.

read_to_me - - true if the book reads to the player or false if not.

See Also:

setContentAppUUID(String), createGameplay()

sendGameRawData

public void sendGameRawData()

Send the Game Rawdata.

Specified by:

sendGameRawData in interface ISDK

See Also:

setContentAppUUID(String), createGameplay(String)

restartRawdata

public void restartRawdata()

Restarts and cleans all the data in the Rawdata

Specified by:

restartRawdata in interface ISDK

onPauseInfantium

public void onPauseInfantium()

Method to be called when overwriting the onPause method of Android

Specified by:

onPauseInfantium in interface ISDK

onResumeInfantium

public void onResumeInfantium()

Method to be called when overwriting the onResume method of Android

Specified by:

onResumeInfantium in interface ISDK

clearReceivers

public void clearReceivers()

Very specific method to be called only by Apps that cannot overwrite the onPause and onResume Android methods.

Specified by:

clearReceivers in interface ISDK

addGoal

public InfantiumResponse addGoal(Goal goal)

Add a Goal to the current Rawdata.

Specified by:

addGoal in interface ISDK

Parameters:

goal - - The Goal to add.

Returns:

InfantiumResponse - Confirms that the request has completed successfully (Valid) or not (descriptive string of the error).

addGoals

public InfantiumResponse addGoals(List<Goal> goals)

Add a list of Goals to the current Rawdata.

Specified by:

addGoals in interface ISDK

Parameters:

goals - - A list of Goals to add.

Returns:

InfantiumResponse - Confirms that the request has completed successfully (Valid) or not (descriptive string of the error).

addEvent

public InfantiumResponse addEvent(Event event)

Add an Event to the current Rawdata.

Specified by:

addEvent in interface ISDK

Parameters:

event - - The Event to add.

Returns:

InfantiumResponse - Confirms that the request has completed successfully (Valid) or not (descriptive string of the error).

addEvents

public InfantiumResponse addEvents(List<Event> events)

Add a list of Events to the current Rawdata.

Specified by:

addEvents in interface ISDK

Parameters:

events - - The list of Events to add.

Returns:

InfantiumResponse - Confirms that the request has completed successfully (Valid) or not (descriptive string of the error).

newBasicInteraction

public InfantiumResponse newBasicInteraction(String t,
                                    String goal_type)

Adds an interaction with the screen.

Specified by:

newBasicInteraction in interface ISDK

Parameters:

t - - The type of the interaction. Check the Dev Center for more info.

goal_type - - The goal which had to be achieved by this movement.

Returns:

InfantiumResponse - Confirms that the request has completed successfully (Valid) or not (descriptive string of the error).

newBasicInteraction

public InfantiumResponse newBasicInteraction(String t,
                                    String object_type,
                                    String goal_type)

Adds an interaction with the screen.

Specified by:

newBasicInteraction in interface ISDK

Parameters:

t - - The type of the interaction. Check the Dev Center for more info.

object_type - - The object/element of interaction.

goal_type - - The goal which had to be achieved by this movement.

Returns:

InfantiumResponse - Confirms that the request has completed successfully (Valid) or not (descriptive string of the error).

newBasicInteraction

public InfantiumResponse newBasicInteraction(String t,
                                    String object_type,
                                    String goal_type,
                                    Integer lifetime)

Adds an interaction with the screen.

Specified by:

newBasicInteraction in interface ISDK

Parameters:

t - - The type of the interaction. Check the Dev Center for more info.

object_type - - The object/element of interaction.

goal_type - - The goal which had to be achieved by this movement.

lifetime - - The available timespan the kid had to make this choice, in milliseconds.

Returns:

InfantiumResponse - Confirms that the request has completed successfully (Valid) or not (descriptive string of the error).

newBasicInteraction

public InfantiumResponse newBasicInteraction(String t,
                                    String object_type,
                                    String goal_type,
                                    Integer n_concurrent_oks,
                                    Integer n_concurrent_kos)

Adds an interaction with the screen.

Specified by:

newBasicInteraction in interface ISDK

Parameters:

t - - The type of the interaction. Check the Dev Center for more info.

object_type - - The object/element of interaction.

goal_type - - The goal which had to be achieved by this movement.

n_concurrent_oks - - The amount of other correct solutions

n_concurrent_kos - - The amount of other incorrect solutions

Returns:

InfantiumResponse - Confirms that the request has completed successfully (Valid) or not (descriptive string of the error).

newBasicInteraction

public InfantiumResponse newBasicInteraction(String t,
                                    String object_type,
                                    String goal_type,
                                    Integer lifetime,
                                    Integer n_concurrent_oks,
                                    Integer n_concurrent_kos)

Adds an interaction with the screen.

Specified by:

newBasicInteraction in interface ISDK

Parameters:

t - - The type of the interaction. Check the Dev Center for more info.

object_type - - The object/element of interaction.

goal_type - - The goal which had to be achieved by this movement.

lifetime - - The available timespan the kid had to make this choice, in milliseconds.

n_concurrent_oks - - The amount of other correct solutions

n_concurrent_kos - - The amount of other incorrect solutions

Returns:

InfantiumResponse - Confirms that the request has completed successfully (Valid) or not (descriptive string of the error).

triggerExistingEvent

public InfantiumResponse triggerExistingEvent(String event_id)

Adds the triggering of an existing event

Specified by:

triggerExistingEvent in interface ISDK

Parameters:

event_id - -

triggerExistingEvent

public InfantiumResponse triggerExistingEvent(String event_id,
                                     String triggered_by)

Adds the triggering of an existing event

Specified by:

triggerExistingEvent in interface ISDK

Parameters:

event_id - -

triggered_by - -