Unity-SCORM Integration Kit  1.0
Integrate Unity3d Projects with your LMS via SCORM
Classes | Public Types | Properties | List of all members
StudentRecord Class Reference

Stores the SCORM data returned from the LMS. More...

Classes

class  CommentsFromLearner
 cmi.comments_from_learner.X datatype More...
 
class  CommentsFromLMS
 cmi.comments_from_lms.X datatype More...
 
class  LearnerInteractionCorrectResponse
 cmi.interactions.n.correct_responses.n.X datatype More...
 
class  LearnerInteractionObjective
 cmi.interactions.n.objectives.X datatype More...
 
class  LearnerInteractionRecord
 cmi.interactions.n.X datatype More...
 
class  LearnerPreference
 cmi.learner_preference.X datatype More...
 
class  LearnerScore
 cmi.score.X datatype More...
 
class  Objectives
 cmi.objectives.n.X datatype More...
 

Public Types

enum  CompletionStatusType {
  CompletionStatusType.completed, CompletionStatusType.incomplete, CompletionStatusType.not_attempted, CompletionStatusType.unknown,
  CompletionStatusType.not_set
}
 cmi.completion_status datatype More...
 
enum  CreditType { CreditType.credit, CreditType.no_credit, CreditType.not_set }
 cmi.credit datatype More...
 
enum  EntryType { EntryType.start, EntryType.resume, EntryType.not_set }
 cmi.entry datatype More...
 
enum  ExitType { ExitType.timeout, ExitType.suspend, ExitType.normal }
 cmi.exit datatype More...
 
enum  InteractionType {
  InteractionType.true_false, InteractionType.choice, InteractionType.fill_in, InteractionType.long_fill_in,
  InteractionType.likert, InteractionType.matching, InteractionType.performance, InteractionType.sequencing,
  InteractionType.numeric, InteractionType.other, InteractionType.not_set
}
 cmi.interactions.n.type datatype More...
 
enum  ModeType { ModeType.browse, ModeType.normal, ModeType.review, ModeType.not_set }
 cmi.mode datatype More...
 
enum  ResultType {
  ResultType.correct, ResultType.incorrect, ResultType.unanticipated, ResultType.neutral,
  ResultType.estimate, ResultType.not_set
}
 cmi.interactions.n.result datatype More...
 
enum  SuccessStatusType { SuccessStatusType.passed, SuccessStatusType.failed, SuccessStatusType.unknown, SuccessStatusType.not_set }
 cmi.success_status and cmi.objectives.n.success_status datatype More...
 
enum  TimeLimitActionType {
  TimeLimitActionType.exit_message, TimeLimitActionType.continue_message, TimeLimitActionType.exit_no_message, TimeLimitActionType.continue_no_message,
  TimeLimitActionType.not_set
}
 cmi.time_limit_action datatype More...
 

Properties

string version [get, set]
 cmi._version More...
 
List< CommentsFromLearnercommentsFromLearner [get, set]
 cmi.comments_from_learner.X More...
 
List< CommentsFromLMScommentsFromLMS [get, set]
 cmi.comments_from_lms.X More...
 
CompletionStatusType completionStatus [get, set]
 cmi.completion_status More...
 
float completionThreshold [get, set]
 cmi.completion_threshold More...
 
CreditType credit [get, set]
 cmi.credit More...
 
EntryType entry [get, set]
 cmi.entry More...
 
List< LearnerInteractionRecordinteractions [get, set]
 cmi.cmi.interactions.n.X More...
 
string launchData [get, set]
 cmi.launch_data More...
 
string learnerID [get, set]
 cmi.learner_id More...
 
string learnerName [get, set]
 cmi.learner_name More...
 
LearnerPreference learnerPreference [get, set]
 cmi.learner_preference.X More...
 
LearnerScore learnerScore [get, set]
 cmi.score. More...
 
string location [get, set]
 cmi.location More...
 
List< Objectivesobjectives [get, set]
 cmi.objectives.n.X More...
 
float maxTimeAllowed [get, set]
 cmi.max_time_allowed More...
 
ModeType mode [get, set]
 cmi.mode More...
 
float progressMeasure [get, set]
 cmi.progress_measure More...
 
float scaledPassingScore [get, set]
 cmi.scaled_passing_score More...
 
SuccessStatusType successStatus [get, set]
 cmi.success_status More...
 
string suspendData [get, set]
 cmi.suspend_data More...
 
TimeLimitActionType timeLimitAction [get, set]
 cmi.time_limit_action More...
 
float totalTime [get, set]
 cmi.total_time More...
 

Detailed Description

Stores the SCORM data returned from the LMS.

Only used to define the properties to reflect the SCORM data model. No methods are defined.

Member Enumeration Documentation

cmi.completion_status datatype

Enumerator
completed 
incomplete 
not_attempted 
unknown 
not_set 

cmi.credit datatype

Enumerator
credit 
no_credit 
not_set 

cmi.entry datatype

Enumerator
start 
resume 
not_set 

cmi.exit datatype

Enumerator
timeout 
suspend 
normal 

cmi.interactions.n.type datatype

Enumerator
true_false 
choice 
fill_in 
long_fill_in 
likert 
matching 
performance 
sequencing 
numeric 
other 
not_set 

cmi.mode datatype

Enumerator
browse 
normal 
review 
not_set 

cmi.interactions.n.result datatype

The 'estimate' value is set when the result is a real number that reflects a judgment on the correctness of the result. If a value of 'estimate' is set, then the 'estimate' float value stored in the LearnerInteractionRecord is sent to the LMS as the result

LearnerInteractionRecord

Enumerator
correct 
incorrect 
unanticipated 
neutral 
estimate 
not_set 

cmi.success_status and cmi.objectives.n.success_status datatype

Enumerator
passed 
failed 
unknown 
not_set 

cmi.time_limit_action datatype

Enumerator
exit_message 
continue_message 
exit_no_message 
continue_no_message 
not_set 

Property Documentation

List<CommentsFromLearner> StudentRecord.commentsFromLearner
getset

cmi.comments_from_learner.X

The collection of comments made by the learner.

List<CommentsFromLMS> StudentRecord.commentsFromLMS
getset

cmi.comments_from_lms.X

The collection of comments from the LMS for this SCO.

CompletionStatusType StudentRecord.completionStatus
getset

cmi.completion_status

Indicates whether the learner has completed the SCO

float StudentRecord.completionThreshold
getset

cmi.completion_threshold

Used to determine whether the SCO should be considered complete

CreditType StudentRecord.credit
getset

cmi.credit

Indicates whether the learner will be credited for performance in the SCO

EntryType StudentRecord.entry
getset

cmi.entry

Asserts whether the learner has previously accessed the SCO

List<LearnerInteractionRecord> StudentRecord.interactions
getset

cmi.cmi.interactions.n.X

The collection of interactions for this student

string StudentRecord.launchData
getset

cmi.launch_data

Data provided to a SCO after launch, initialized from the dataFromLMS manifest element

string StudentRecord.learnerID
getset

cmi.learner_id

Identifies the learner on behalf of whom the SCO was launched

string StudentRecord.learnerName
getset

cmi.learner_name

Name provided for the learner by the LMS

LearnerPreference StudentRecord.learnerPreference
getset

cmi.learner_preference.X

Aggregate object to store the learner preference items

LearnerScore StudentRecord.learnerScore
getset

cmi.score.

Aggregate object to store the learner's score for this SCO

string StudentRecord.location
getset

cmi.location

The learner’s current location in the SCO. Acts as a bookmark for when a student re-visits an incomplete SCO. Set the location, and then set the exit type to 'suspend'.

float StudentRecord.maxTimeAllowed
getset

cmi.max_time_allowed

Amount of accumulated time the learner is allowed to use a SCO

ModeType StudentRecord.mode
getset

cmi.mode

Identifies one of three possible modes in which the SCO may be presented to the learner

List<Objectives> StudentRecord.objectives
getset

cmi.objectives.n.X

The collection of objectives for this SCO

float StudentRecord.progressMeasure
getset

cmi.progress_measure

Measure of the progress the learner has made toward completing the SCO

float StudentRecord.scaledPassingScore
getset

cmi.scaled_passing_score

Scaled passing score required to master the SCO

SuccessStatusType StudentRecord.successStatus
getset

cmi.success_status

Indicates whether the learner has mastered the SCO

string StudentRecord.suspendData
getset

cmi.suspend_data

Provides space to store and retrieve data between learner sessions/remarks>

TimeLimitActionType StudentRecord.timeLimitAction
getset

cmi.time_limit_action

Indicates what the SCO should do when cmi.max_time_allowed is exceeded

float StudentRecord.totalTime
getset

cmi.total_time

Sum of all of the learner’s session times accumulated in the current learner attempt

string StudentRecord.version
getset

cmi._version

Represents the version of the data model


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