The URL target view is used to embed an interactive app into an OpenLearning page or activity.

configure is accessed to embed an app's configuration panel in OpenLearning.

automark is a worker script target, called to automatically mark OpenLearning activities.

Code Example:

response.writeText( OpenLearning.test( ) );

writes the version number of the API being used

JSON data object for the given user profile name

e.g.

{
    fullName: 'Harry Potter',
    profileName: 'harry.potter',
    standardAvatar: 'http://.../harry.png'
}

Code Example:

response.writeJSON( OpenLearning.getUser( request.user ) );

For apps which are used on OpenLearning pages, the following API can be used:

OpenLearning.page.methodName

returns a list of permissions that the user of the given profile has on a page.

e.g.

["read", "write", "admin"]

Code Example:

if ( OpenLearning.page.getPermissions( request.user ).indexOf( "admin" ) != -1 ) {
   response.writeText( "You are an admin" );
}

returns data stored by apps on this page

Code Example:

var allData = OpenLearning.page.getData( null ).data;
var dataProtectedByUser = OpenLearning.page.getData( request.user ).data;

properties .data and .url (for the page's OpenLearning url) are available

returns whether data is stored on this page successfully.

.url property is also available

e.g.

{
    success: true,
}

Code Example:

OpenLearning.page.setData( { myData: 'hello' } );
OpenLearning.page.setData( { myData: 'only store this if user is allowed' }, request.user );

returns a JSON Object stored at the given key (string), in relation to the App's page.

Code Example: var userData = getUserData( 'tom.riddle', 'horcrux' );

returns whether user data is stored at the given key, with this page successfully

value must be a JSON Object (i.e. { 'hello': 'world' })

returns page contents and metadata of a sub-page

Code Example: var pageData = OpenLearning.page.readSubpage( '/MySubpage' );

see getSubmission/saveSubmission for the data format

For apps which are used as OpenLearning activities, the following API can be used:

OpenLearning.activity.methodName

Returns true if (and only if) this app is deployed as an OpenLearning activity.

Takes a key-value store of profile name to data object, and stores this marking data for each of the given users.

Code Example:

OpenLearning.activity.setMarks( {
   "hermoine.granger": {
      completed: true,
      score: 100
   },
   "ron.weasley": {
      completed: false,
      score: 42
   }
} );

Return an object with keys as each user, and value of a marks object.

Returns the best mark for each user.

Returns the latest mark for a user.

templateMarkup is optional.

Set the default page type for new submissions. pageType is one of: 'content' 'file' 'multi-file'

Create a page which is exhibited instead of the submission e.g. createSubmissionExhibit( 'harry.potter', 'file', 'Foo', { file: { filename: 'foo.txt', data: 'hello world' } } )

Supported pageTypes: 'content': text/html content 'file' 'multi-file'

Sets the total number of marks (score/grade) for this activity

e.g.

OpenLearning.activity.setTotalMarks( 100 );

A shortcut to set the 'isEmbedded' attribute on an activity page. If this is set to true, the app will display the view target embedded within the activity page.

A shortcut to set the 'isFullWidth' attribute on an activity page. If this is set to true, the app will take up the full page width.

Submit the user's submission for marking.

Returns 'incomplete', 'pending' or 'completed' according to whether the given user's submission is not yet submitted (or marked incorrect), submitted but not yet marked, or has been marked correct (respectively).

Returns a user's submission to this activity. This will be the files, metadata or page content of the submission.

Saves a user's submission to this activity. The format of the submission object depends on the page type specified when the submission is first saved.

pageType is optional, and is used to override the default page type set by the activity.

'content' page type:
{
  'content': { object which contains the document's layout },
  'markup': 'The Creole markup for this page',
  'metadata': { object storing extra data for the app, not displayed on a page }
}

'file' page type:
{
  'filename': 'file.txt',
  'data': 'hello world',
  'markup': 'The Creole markup for a caption'
}

'multi-file' page type:

{
  'files': [
    {
      'filename': 'file1.txt',
      'data': 'hello world'
    },

    {
      'filename': 'file2.txt',
      'data': 'dlrow olleh'
    }
  ]
}