Make OPEL API Tidy (OPEL API v1.0)

[RedCarrottt]

Here is OPEL JavaScript API v0.2 currently used in OPEL Alpha 2.

OPEL JavaScript API v0.2

App API

• void onTermination(callback_function(void))

Remote UI API

• require('node/sysfw/nil')

Notification UI

• string newNotiPage makeEventPage(description)
  • Return value: string ackMessage (JSON format, {"noti":"noti", "description":description})
• string newNotiPage addEventText(oldNotiPage, text)
  • Return value: string ackMessage (JSON format, oldNotiPage + {"text":text})
• string newNotiPage addEventImg(oldNotiPage, imgPath)
  • Return value: string ackMessage (JSON format, oldNotiPage + {"img":imgPath})
• void sendEventText(notiPage)
• void sendEventTextWithNoti(notiPage)

Config UI

• newConfigPage makeConfigPage()

• newConfigPage addStrTextbox(oldConfigPage, key, description, constrain-length)

  • Parameter: int length (input string length)

• newConfigPage addNumberTextbox(oldConfigPage, key, description, constrain-range1, 2)

  • Parameter: int range (input number range)

• newConfigPage addSingleDialog(oldConfigPage, key, description, item1, item2, ... )

• newConfigPage addMultiDialog(oldConfigPage, key, description, item1, item2, ... )

• newConfigPage addDateDialog(oldConfigPage, key, description, constrain[0 or 1] )

  • Parameter: int constrain(0: no constrain, 1: after today)

• newConfigPage addTimeDialog(oldConfigPage, key, description, constrain[0 or 1] )

  • Parameter: int constrain(0: no constrain, 1: after now)

• void sendConfigPage(configPage, function(configData) )

• value getData(configData, key)

  • Return value: string value(the value corresponding the key)

    Sensor API

• require('node/OPELRecording')

• Get()

• On()

• EventRegister()

• EventUpdate()

• EventUnregister()

Camera API

• require('node/OPELRecording')

• RecordingStart()

• RecordingStop()

• SnapshotStart()

• streamingStart()

Face Detection API

• require('node/OPELFaceDetection')

• faceDetection(int count, callback(int err, int numberOfFace))

Omitted Functions

Following functions are not included in OPEL JavaScript API v0.2, since there is no demand in OPEL Alpha 2. However, they should be included in OPEL API v1.0 due to the introduction of Resource Framework.

• Remote File System
  • Included in OPEL Manager's internal code

Let's discuss on OPEL API v1.0 design.

[RedCarrottt]

Requirements of OPEL API v1.0

• Richer App Lifecycle API
• Discard duplicated or deprecated APIs

The requirements is under discussion, so it can be updated.