OpenVeo Manage AngularJS back end

API Docs for: 1.0.0-alpha.0
Show:

ManageFactory

Summary

Defines a factory to manage communications with the server.

Methods

addDeviceToGroup

Syntax

addDeviceToGroup

(
  • deviceId
  • groupId
)
Promise

Summary

Adds a device to a group.

Parameters:

  • deviceId String

    The id of the device to add to the group

  • groupId String

    The id of group

Returns:

Promise:

Promise resolving when device has been added

addSchedule

Syntax

addSchedule

(
  • id
  • schedule
  • type
)
Promise

Summary

Adds a manageable's schedule.

Parameters:

  • id String

    The manageable id

  • schedule Object

    The schedule to add

  • type String

    The manageable type

Returns:

Promise:

Promise resolving when schedule has been added

askForDevicesSettings

Syntax

askForDevicesSettings

(
  • ids
)
Promise

Summary

Asks server for devices' settings.

Parameters:

  • ids Array

    The devices' ids

Returns:

Promise:

Promise resolving when request to devices have been sent

createGroup

Syntax

createGroup

() Promise

Summary

Creates a new group.

Returns:

Promise:

Promise resolving with the new created group

getConfiguration

Syntax

getConfiguration

() Promise

Summary

Gets Manage plugin configuration.

Returns:

Promise:

A promise resolving with manage's configuration

getDevices

Syntax

getDevices

() Promise

Summary

Gets all devices from server.

Returns:

Promise:

A promise resolving with the list of devices categorized by state (either "pending", "accepted" or "refused")

getGroups

Syntax

getGroups

() Promise

Summary

Gets all groups devices from server.

Returns:

Promise:

A promise resolving with the list of groups

remove

Syntax

remove

(
  • id
  • type
)
Promise

Summary

Removes a manageable.

Parameters:

  • id String

    The manageable id

  • type String

    The manageable type

Returns:

Promise:

Promise resolving when the manageable has been removed

removeDeviceFromGroup

Syntax

removeDeviceFromGroup

(
  • id
)
Promise

Summary

Removes a device from its group.

Parameters:

  • id String

    The id of the device to remove from its group

Returns:

Promise:

Promise resolving when device has been removed from its group

removeHistoric

Syntax

removeHistoric

(
  • id
  • historicId
  • type
)
Promise

Summary

Removes a manageable's historic.

Parameters:

  • id String

    The manageable id

  • historicId String

    The historic id

  • type String

    The manageable type

Returns:

Promise:

Promise resolving when historic has been removed

removeHistory

Syntax

removeHistory

(
  • id
  • type
)
Promise

Summary

Removes the whole manageable's history.

Parameters:

  • id String

    The manageable id

  • type String

    The manageable type

Returns:

Promise:

Promise resolving when history has been removed

removeSchedule

Syntax

removeSchedule

(
  • id
  • scheduleId
  • type
)
Promise

Summary

Removes a manageable's schedule.

Parameters:

  • id String

    The manageable id

  • scheduleId String

    The schedule id

  • type String

    The manageable type

Returns:

Promise:

Promise resolving when schedule has been removed

startRecord

Syntax

startRecord

(
  • ids
  • presetId
)
Promise

Summary

Starts a new record session on devices.

Parameters:

  • ids Array

    The list of devices' ids

  • presetId String

    The record session preset id

Returns:

Promise:

Promise resolving when a start request has been sent to devices

stopRecord

Syntax

stopRecord

(
  • ids
)
Promise

Summary

Stops a recording session on devices.

Parameters:

  • ids Array

    The list of devices' ids

Returns:

Promise:

Promise resolving when a stop request has been sent to devices

tagRecord

Syntax

tagRecord

(
  • ids
)
Promise

Summary

Tags a recording session on devices.

Parameters:

  • ids Array

    The list of devices' ids

Returns:

Promise:

Promise resolving when a tag request has been sent to devices

updateDeviceState

Syntax

updateDeviceState

(
  • id
  • state
)
Promise

Summary

Updates the state of a device.

Parameters:

Returns:

Promise:

Promise resolving when state has been changed

updateName

Syntax

updateName

(
  • id
  • name
  • type
)
Promise

Summary

Updates a manageable's name.

Parameters:

  • id String

    The manageable id

  • name String

    The manageable name

  • type String

    The manageable type

Returns:

Promise:

Promise resolving when name has been updated