Public Constructors
 LmsApi
Constructor |
Initializes a new instance of the LmsApi2 class. |
Public Properties
 Enabled |
Enables or disables JavaScript returns from LmsApi GetJs methods (e.g., GetJsApiLocate). |
| ScormVersion |
Specifies whether to use SCORM version 1.2 or 1.3 (also known as version 2004). |
Public Methods
 GetDevPropertiesCount |
Returns the number of properties that have been set for an LmsApi object using the SetDevProperty method. |
| GetDevPropertiesList |
Returns a zero-based, one-dimensional string array of the property names (one property name per cell) that have been set for an LmsApi object using the SetDevProperty method. |
| GetDevPropertiesTable |
Returns a hashtable of all LmsApi properties that were set with the SetDevProperty method. The property names are the keys and the property values are the values of the hashtable. |
| GetDevProperty |
Returns the value of an LmsApi property that was previously set using the SetDevProperty method. |
| GetJsApiLocate |
Overloaded. Returns JavaScript that locates the SCORM API object. |
| GetJsCommit |
Overloaded. Returns JavaScript that calls the SCORM function Commit (1.3) or LMSCommit (1.2). |
| GetJsFinish |
Overloaded. Returns JavaScript that calls the SCORM function LMSFinish (1.2) or Terminate (1.3). |
| GetJsForLogoff |
Returns JavaScript to handle various logoff options depending on parameter values. The returned JavaScript may include SCORM calls to both LMSCommit and LMSFinish (1.2), Commit and Terminate (1.3), and a command to close the SCO window. Calls may be placed inside a JavaScript function. |
| GetJsGetDiagnostic |
Returns JavaScript that calls the SCORM function LMSGetDiagnostic (1.2) or GetDiagnostic (1.3). |
| GetJsGetErrorString |
Overloaded. Returns JavaScript that calls the SCORM function LMSGetErrorString (1.2) or GetErrorString (1.3). |
| GetJsGetLastError |
Overloaded. Returns JavaScript that calls the SCORM function LMSGetLastError (1.2) or GetLastError (1.3). |
| GetJsGetLessonLocationAndChangeInFrame |
Returns JavaScript to call the appropriate SCORM GetValue function to get the cmi.core.lesson_location (1.2) or cmi.location (1.3) value, and then changes the location of the specified frame to that value. |
| GetJsGetValue |
Overloaded. Returns JavaScript that calls the SCORM function LMSGetValue (1.2) or GetValue (1.3). |
| GetJsInitialize |
Overloaded. Returns JavaScript that calls the SCORM function LMSInitialize (1.2) or Initialize (1.3), or returns 0 if GetJsInitialize has already been called during the current session. |
| GetJsSetValue |
Overloaded. Returns JavaScript that calls the SCORM function LMSSetValue (1.2) or SetValue (1.3). |
| GetJsTerminate |
Overloaded. Returns JavaScript that calls the SCORM function Terminate (1.3) or LmsFinish (1.2). |
| RemoveDevProperty |
Removes an LmsApi session property. |
| ResetApi |
Resets the LmsApi2. |
| SetDevProperty |
Sets a property of an LmsApi object. |