# Class: SCORMAdapter

## adapters SCORMAdapter

Base classs for SCORM adapters

#### <abstract> new SCORMAdapter()

  Base class for SCORM adapters,basede on pipwerks.

### Extends

- jsbeam.BaseAdapter

### Members

#### <readonly> bookmark

  Current bookamrk

  ##### Properties:

  Type | Description
  --- | ---
  string |

  Inherited From:
    - jsbeam.BaseAdapter#bookmark
  Default Value:
    - ''

#### <readonly> completed

  Indicates if course is completed

  ##### Properties:

  Type | Description
  --- | ---
  boolean |

  Inherited From:
    - jsbeam.BaseAdapter#completed
  Default Value:
    - false

#### <readonly> dispatcher

  Dispatcher to recieve signals from adapter

  ##### Properties:

  Type | Description
  --- | ---
  coreutils.Signal |

  Inherited From:
    - jsbeam.BaseAdapter#dispatcher
  Default Value:
    - null

#### <readonly> isConnected

  Indicates if adapter is connected

  ##### Properties:

  Type | Description
  --- | ---
  boolean |

  Inherited From:
    - jsbeam.BaseAdapter#isConnected
  Default Value:
    - false

#### <readonly> language

  Current language

  ##### Properties:

  Type | Description
  --- | ---
  string |

  Inherited From:
    - jsbeam.BaseAdapter#language
  Default Value:
    - ''

#### <readonly> userID

  Current user id

  ##### Properties:

  Type | Description
  --- | ---
  string |

  Inherited From:
    - jsbeam.BaseAdapter#userID
  Default Value:
    - ''

#### <readonly> userName

  Current user name

  ##### Properties:

  Type | Description
  --- | ---
  string |

  Inherited From:
    - jsbeam.BaseAdapter#userName
  Default Value:
    - ''

### Methods

#### <abstract, protected> _getBookmark()

  Get saved bookmark
  Inherited From:
    - jsbeam.BaseAdapter#_getBookmark

  ##### Returns:

  bookmark
  Type
    string | null

#### <protected> _getConfigProperty(id)

  Get property from adapter config.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `id` | string |

  Inherited From:
    - jsbeam.BaseAdapter#_getConfigProperty

  ##### Returns:

  value
  Type
    string | null

#### <abstract, protected> _getCourseCompleted()

  Check if the current course is completed
  Inherited From:
    - jsbeam.BaseAdapter#_getCourseCompleted

  ##### Returns:

  completed
  Type
    boolean

#### <abstract, protected> _getLanguage()

  Get current language from url
  Inherited From:
    - jsbeam.BaseAdapter#_getLanguage

  ##### Returns:

  current language
  Type
    string

#### <protected> _getObjectiveIndexByID(id)

  Get tracked item index

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `id` | string | tracked id

  Inherited From:
    - jsbeam.BaseAdapter#_getObjectiveIndexByID

  ##### Returns:

  index
  Type
    number | null

#### <abstract, protected> _getObjectivesCount()

  Get total count of objectives
  Inherited From:
    - jsbeam.BaseAdapter#_getObjectivesCount

  ##### Returns:

  count
  Type
    number

#### <abstract, protected> _getUserID()

  Get user id from server
  Inherited From:
    - jsbeam.BaseAdapter#_getUserID

  ##### Returns:

  user id
  Type
    string | null

#### <abstract, protected> _getUserName()

  Get user name from server
  Inherited From:
    - jsbeam.BaseAdapter#_getUserName

  ##### Returns:

  user name
  Type
    string | null

#### <protected> _initData()

  Init adapter data on connect
  Inherited From:
    - jsbeam.BaseAdapter#_initData

#### <protected> _initIndexes(objectives)

  Init tracked items indexes

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `objectives` | array.<string> |

  Inherited From:
    - jsbeam.BaseAdapter#_initIndexes

#### <abstract, protected> _registerObjectives(objectives)

  Register objectives on SCORM server

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `objectives` | array |

  Inherited From:
    - jsbeam.BaseAdapter#_registerObjectives

#### addConfig(config)

  Add adapter config

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `config` | object |

  Inherited From:
    - jsbeam.BaseAdapter#addConfig

#### <abstract> connect()

  Init function of adpater that connects adapter to API, if not connected.
  Inherited From:
    - jsbeam.BaseAdapter#connect

#### destroy()

  Destroy adapter and clean resources
  Inherited From:
    - jsbeam.BaseAdapter#destroy

#### <abstract> disconnect()

  Disconnect adapter from server, if connected
  Inherited From:
    - jsbeam.BaseAdapter#disconnect

#### <abstract> getProperty(id)

  Get course property for current course

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `id` | string | key of property

  Inherited From:
    - jsbeam.BaseAdapter#getProperty

  ##### Returns:

  proeprty value or null
  Type
    string | null

#### <abstract> initObjectives(objectives)

  Register objectives on server if there are none

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `objectives` | array | objectives list

  Inherited From:
    - jsbeam.BaseAdapter#initObjectives
  Overrides:
    - jsbeam.BaseAdapter#initObjectives

#### <abstract> saveProperty(id, proeprty)

  Set course property for current course and commit to server

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `id` | string | key of property
  `proeprty` | string | value

  Inherited From:
    - jsbeam.BaseAdapter#saveProperty

  ##### Returns:

  success
  Type
    boolean

#### <abstract> setBookmark(site)

  Save bookamrk

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `site` | string | current bookamrk

  Inherited From:
    - jsbeam.BaseAdapter#setBookmark

  ##### Returns:

  success
  Type
    boolean

#### <abstract> setCourseCompleted()

  Set current course status as completed
  Inherited From:
    - jsbeam.BaseAdapter#setCourseCompleted

#### <abstract> setMaxScore(score)

  Set maximal score of the course

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `score` | number | maximal score

  Inherited From:
    - jsbeam.BaseAdapter#setMaxScore

#### <abstract> setMinScore(score)

  Set minimal score of the course

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `score` | number | minimal score

  Inherited From:
    - jsbeam.BaseAdapter#setMinScore

#### <abstract> setObjectiveCompleted(id, index)

  Set objective in current course as completed

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `id` | string | objective id
  `index` | number | objective index in objectives list

  Inherited From:
    - jsbeam.BaseAdapter#setObjectiveCompleted

  ##### Returns:

  success
  Type
    boolean

#### <abstract> setObjectiveIncomplete(id, index)

  Set objective in current course as incompleted

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `id` | string | objective id
  `index` | number | objective index in objectives list

  Inherited From:
    - jsbeam.BaseAdapter#setObjectiveIncomplete

  ##### Returns:

  success
  Type
    boolean

#### <abstract> setScore(score)

  Set score of the course

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `score` | number | current score

  Inherited From:
    - jsbeam.BaseAdapter#setScore

#### Search results