CerebrumLogger.xCall Class Reference

Inheritance diagram for CerebrumLogger.xCall:

Public Member Functions
	xCall (String learner_name, String learner_id, String verb_string)
	Simplest xCall instantiation that can exist includes only a learner name, id, and verb. We can add other elements to this xCall object using the methods of this class.
	xCall (String learner_name, String learner_id, String verb_string, String url)
	Instantiation of xCall object where we want to specify a different URL.
void	SetActivity (String gameName)
	Sets the TinCan activity to the specified game. A game name is the minimum information that must be passed to SetActivity.
void	SetActivity (String gameName, String stageName)
	Sets the TinCan activity to the specified game at the specified stage.
void	SetActivity (String gameName, String stageName, String activityName)
	Sets the TinCan activity to the specified game, stage, and activity name.
void	SetActivity (String gameName, String stageName, String activityName, String option)
	Sets the TinCan activity to the specified game, stage, activity name, with specified option.
TinCan.Extensions	BuildExtensions (JObject jobj)
	Constructs a TinCan.Extensions object from a JObject.
void	SetContext (TinCan.Extensions extensions)
	Sets an xCall's context to a new context with the specified TinCan.Extensions object.
void	AddExtensionToContext (TinCan.Extensions extensions)
	Adds the specified TinCan.Extensions object to the xCall's context.
void	AddExtensionToResult (TinCan.Extensions extensions)
	Adds the specified TinCan.Extensions object to the xCall's result.
void	SetResult (bool success)
	Sets the xCall result's success attribute.
void	SetResult (bool success, int max, int min, int raw)
	Sets the xCall result's success. Also includes and sets max, min, and raw scores.
Statement	BuildStatement ()
	Turns an xCall object into a TinCan.Statement object. APIHandler.cs uses BuildStatement() with the specified xCall input to send an API call.

Properties
Agent	agent [get]
Activity	activity [get]
Verb	verb [get]
Context	context [get]
Result	result [get]
Statement	statement [get]
string	url = "http://gamestrax.com/" [get, set]

Constructor & Destructor Documentation

xCall() [1/2]

CerebrumLogger.xCall.xCall ( String  learner_name, String  learner_id, String  verb_string  )

inline

Simplest xCall instantiation that can exist includes only a learner name, id, and verb. We can add other elements to this xCall object using the methods of this class.

Parameters

learner_name
learner_id
verb_string

xCall() [2/2]

CerebrumLogger.xCall.xCall ( String  learner_name, String  learner_id, String  verb_string, String  url  )

inline

Instantiation of xCall object where we want to specify a different URL.

Parameters

learner_name
learner_id
verb_string
url

Member Function Documentation

AddExtensionToContext()

void CerebrumLogger.xCall.AddExtensionToContext ( TinCan::Extensions  extensions )

inline

Adds the specified TinCan.Extensions object to the xCall's context.

Parameters

extensions

AddExtensionToResult()

void CerebrumLogger.xCall.AddExtensionToResult ( TinCan::Extensions  extensions )

inline

Adds the specified TinCan.Extensions object to the xCall's result.

Parameters

extensions

BuildExtensions()

TinCan.Extensions CerebrumLogger.xCall.BuildExtensions ( JObject  jobj )

inline

Constructs a TinCan.Extensions object from a JObject.

Parameters

jobj

Returns

TinCan.Extensions object

BuildStatement()

Statement CerebrumLogger.xCall.BuildStatement ( )

inline

Turns an xCall object into a TinCan.Statement object. APIHandler.cs uses BuildStatement() with the specified xCall input to send an API call.

Returns

TinCan.Statement object

SetActivity() [1/4]

void CerebrumLogger.xCall.SetActivity ( String  gameName )

inline

Sets the TinCan activity to the specified game. A game name is the minimum information that must be passed to SetActivity.

Parameters

gameName

SetActivity() [2/4]

void CerebrumLogger.xCall.SetActivity ( String  gameName, String  stageName  )

inline

Sets the TinCan activity to the specified game at the specified stage.

Parameters

gameName
stageName

SetActivity() [3/4]

void CerebrumLogger.xCall.SetActivity ( String  gameName, String  stageName, String  activityName  )

inline

Sets the TinCan activity to the specified game, stage, and activity name.

Parameters

gameName
stageName
activityName

SetActivity() [4/4]

void CerebrumLogger.xCall.SetActivity ( String  gameName, String  stageName, String  activityName, String  option  )

inline

Sets the TinCan activity to the specified game, stage, activity name, with specified option.

Parameters

gameName
stageName
activityName
option

SetContext()

void CerebrumLogger.xCall.SetContext ( TinCan::Extensions  extensions )

inline

Sets an xCall's context to a new context with the specified TinCan.Extensions object.

Parameters

extensions

SetResult() [1/2]

void CerebrumLogger.xCall.SetResult ( bool  success )

inline

Sets the xCall result's success attribute.

Parameters

success

SetResult() [2/2]

void CerebrumLogger.xCall.SetResult ( bool  success, int  max, int  min, int  raw  )

inline

Sets the xCall result's success. Also includes and sets max, min, and raw scores.

Parameters

success
max
min
raw

Property Documentation

activity

Activity CerebrumLogger.xCall.activity

get

agent

Agent CerebrumLogger.xCall.agent

get

context

Context CerebrumLogger.xCall.context

get

result

Result CerebrumLogger.xCall.result

get

statement

Statement CerebrumLogger.xCall.statement

get

url

string CerebrumLogger.xCall.url = "http://gamestrax.com/"

getset

verb

Verb CerebrumLogger.xCall.verb

get

---

The documentation for this class was generated from the following file:

• D:/Documents/Git/Unity-xAPI-Wrapper/CerebrumPlugin/Src/xCall/xCall.cs