OpenVeo Manage AngularJS back end

API Docs for: 1.0.0-alpha.0
Show:

ManageManageableFactory

Defined in: app/client/admin/js/ovManage/ManageableFactory.js:5
Module: ov.manage

Summary

Defines a factory to manage manageables.

Methods

addHistoric

Defined in app/client/admin/js/ovManage/ManageableFactory.js:101

Syntax

addHistoric

(
  • manageable
  • historic
)

Summary

Adds a manageable historic.

Parameters:

  • manageable Object

    The manageable

  • historic Object

    The historic to add

addSchedule

Defined in app/client/admin/js/ovManage/ManageableFactory.js:161

Syntax

addSchedule

(
  • manageable
  • schedule
)

Summary

Adds a manageable schedule.

Parameters:

  • manageable Object

    The manageable

  • schedule Object

    The schedule

addSchedule

Defined in app/client/admin/js/ovManage/ManageableDetailController.js:161

Syntax

addSchedule

()

Summary

Adds a new schedule.

addToAcceptedDevices

Defined in app/client/admin/js/ovManage/ManageableController.js:398

Syntax

addToAcceptedDevices

(
  • device
)

Summary

Adds pending/refused device to the accepted list of devices.

Parameters:

  • device Object

    The device to accept

addToRefusedDevices

Defined in app/client/admin/js/ovManage/ManageableController.js:414

Syntax

addToRefusedDevices

(
  • device
)

Summary

Adds the new device to the refused list of devices.

Parameters:

  • device Object

    The device object

checkSchedulesConflict

Defined in app/client/admin/js/ovManage/ManageableFactory.js:13

Syntax

checkSchedulesConflict

(
  • schedule1
  • schedule2
)
Boolean private

Summary

Checks if two schedules are in conflict.

Parameters:

  • schedule1 Object

    Schedule object with :

    • Date beginDate : The begin date of the schedule
    • Date duration : The schedule duration
    • Boolean recurrent : true is this is a daily schedule, false otherwise
  • schedule2 Object

    Schedule object with :

    • Date beginDate : The begin date of the schedule
    • Date duration : The schedule duration
    • Boolean recurrent : true is this is a daily schedule, false otherwise

Returns:

Boolean:

true if there are in conflict, false otherwise

closeDetail

Defined in app/client/admin/js/ovManage/ManageableDetailController.js:104

Syntax

closeDetail

()

Summary

Closes the details panel.

displayErrors

Defined in app/client/admin/js/ovManage/ManageableDetailController.js:87

Syntax

displayErrors

(
  • errors
  • message
)
private

Summary

Displays an error message for each given errors.

Parameters:

  • errors Array

    The list of errors

  • message String

    The message to display for each error

displayNameForm

Defined in app/client/admin/js/ovManage/ManageableDetailController.js:126

Syntax

displayNameForm

()

Summary

Displays the input to update the manageable's name.

getPreset

Defined in app/client/admin/js/ovManage/ManageableFactory.js:207

Syntax

getPreset

(
  • manageable
  • presetId
)
Object | Null

Summary

Gets a manageable's preset.

Parameters:

  • manageable Object

    The manageable

  • presetId String

    The manageable's preset to look for

Returns:

Object | Null:

The preset's configuration or null if not found

getPresetName

Defined in app/client/admin/js/ovManage/ManageableDetailController.js:291

Syntax

getPresetName

(
  • id
)
String | Null

Summary

Gets selected manageable's preset's name.

Parameters:

Returns:

String | Null:

The preset name or null if not found

isValidSchedule

Defined in app/client/admin/js/ovManage/ManageableFactory.js:226

Syntax

isValidSchedule

(
  • schedule
  • schedules
)
Error | Null

Summary

Checks if a schedule is not in collision with other schedules.

Parameters:

  • schedule Object

    The schedule to validate

  • schedules Array

    The list of schedules

Returns:

Error | Null:

The error if validation failed, null otherwise

openRemoveModal

Defined in app/client/admin/js/ovManage/ManageableDetailController.js:449

Syntax

openRemoveModal

(
  • id
  • action
)

Summary

Opens a modal to remove something.

Parameters:

  • id String

    The id of the object to remove

  • action String

    The type of action to perform

removeDevice

Defined in app/client/admin/js/ovManage/ManageableDetailController.js:431

Syntax

removeDevice

(
  • id
)
private

Summary

Removes a device.

Parameters:

  • id String

    The id of the device to remove

removeHistoric

Defined in app/client/admin/js/ovManage/ManageableDetailController.js:392

Syntax

removeHistoric

(
  • historicId
)
private

Summary

Removes an historic from selected manageable.

Parameters:

  • historicId String

    The historic id

removeHistoric

Defined in app/client/admin/js/ovManage/ManageableFactory.js:128

Syntax

removeHistoric

(
  • manageable
  • historicId
)

Summary

Removes a manageable historic.

Parameters:

  • manageable Object

    The manageable

  • historicId String

    The historic id

removeHistory

Defined in app/client/admin/js/ovManage/ManageableDetailController.js:415

Syntax

removeHistory

() private

Summary

Removes the whole history.

removeHistory

Defined in app/client/admin/js/ovManage/ManageableFactory.js:150

Syntax

removeHistory

(
  • manageable
)

Summary

Removes a manageable's history.

Parameters:

  • manageable Object

    The manageable

removeSchedule

Defined in app/client/admin/js/ovManage/ManageableDetailController.js:342

Syntax

removeSchedule

(
  • scheduleId
)
private

Summary

Removes a schedule from selected manageable.

Parameters:

  • scheduleId String

    The schedule id

removeSchedule

Defined in app/client/admin/js/ovManage/ManageableFactory.js:185

Syntax

removeSchedule

(
  • manageable
  • scheduleId
)

Summary

Removes a manageable's schedule.

Parameters:

  • manageable Object

    The manageable

  • scheduleId String

    The schedule id

resetActionForm

Defined in app/client/admin/js/ovManage/ManageableDetailController.js:309

Syntax

resetActionForm

()

Summary

Resets the action form.

startRecord

Defined in app/client/admin/js/ovManage/ManageableDetailController.js:265

Syntax

startRecord

()

Summary

Creates a new tag on the recording session of the selected manageable.

startRecord

Defined in app/client/admin/js/ovManage/ManageableDetailController.js:239

Syntax

startRecord

()

Summary

Stops recording session on the selected manageable.

startRecord

Defined in app/client/admin/js/ovManage/ManageableDetailController.js:210

Syntax

startRecord

()

Summary

Starts a new recording session on the selected manageable.

updateName

Defined in app/client/admin/js/ovManage/ManageableDetailController.js:136

Syntax

updateName

(
  • name
)

Summary

Updates manageable's name.

Parameters:

  • name String

    The new manageable name

validateEndDate

Defined in app/client/admin/js/ovManage/ManageableDetailController.js:199

Syntax

validateEndDate

()

Summary

Validates the end date regarding the begin date. End date should not be inferior to begin date.

validatePreset

Defined in app/client/admin/js/ovManage/ManageableDetailController.js:492

Syntax

validatePreset

(
  • presetId
)

Summary

Validates the selected manageable's inputs regarding the given preset id.

It is not possible to start a recording session if the inputs of the selected manageable does not correspond to the preset configuration. e.g. It is not possible to start a recording session with slides extraction without a desktop input.

Parameters:

  • presetId String

    The id of the preset

validateSchedule

Defined in app/client/admin/js/ovManage/ManageableDetailController.js:50

Syntax

validateSchedule

(
  • schedule
)
Boolean private

Summary

Validates that begin and end dates of the new scheduled job are not in conflicts with the other scheduled jobs.

Parameters:

  • schedule Object

    Schedule object with :

    • Date beginDate The begin date of the schedule
    • Date endDate The end date of the schedule
    • Number duration The schedule duration in milliseconds
    • Boolean recurrent true is this is a daily schedule, false otherwise

Returns:

Boolean:

true if valid, false otherwise