Functions - SendSessionEvent()
SendSessionEvent()
SendSessionEvent(TinCan.Statement) : Boolean
The SendSessionEvent function is how you send any data to Apex during a session.
It:
- Constructs an xAPI statement from provided session data.
- Sends an event with xAPI statement data.
- Returns false if there is no logged in user, if JoinSession has not been called to start a session, or if eventStatement is null.
OnSendEventSuccess is called when the event has been sent successfully.
OnSendEventFailed is called when the session was not started, contains invalid information or when the server is not able to be reached.
- eventStatement:TinCan.Statement The object that provides all the necessary data to generate the xAPI statement.
TinCan
TinCan is a 3rd party software package that helps to build and enforce xAPI standards. The Apex SDK documentation should provide enough context for you to effectively use our implementation of the package, but if you want to dig deeper, the full documentation is available here
