Skip to content

Latest commit

 

History

History
146 lines (106 loc) · 3.35 KB

containers.md

File metadata and controls

146 lines (106 loc) · 3.35 KB
Raw

Device Containers

Overview

The resources responsible for installing and managing device containers

Available Resources

  1. netField.devices.containers.getAll(deviceId, [options], [callback])

  2. netField.devices.containers.delete(containerId, deviceId, [callback])

  3. netField.devices.containers.create(containerId, deviceId, params, [callback])

  4. netField.devices.containers.update(containerId, deviceId, params, [options], [callback])

  5. netField.devices.containers.properties(containerId, deviceId, [callback])

  6. netField.devices.containers.getInstalled(deviceId, [options], [callback])

  7. netField.devices.containers.get(deviceId, containerId, [callback])

  8. netField.devices.containers.getDeployable(deviceId, [options], [callback])

  9. netField.devices.containers.deleteAll(deviceId, [callback])

Resource Usage

getAll

Get list of installed and deployable containers to device

/**
 * @param {string} deviceId
 * @param {any} options optional
 * @param {function} callback optional
*/
netField.devices.containers.getAll(deviceId, [options], [callback])

delete

Delete device container

/**
 * @param {string} containerId
 * @param {string} deviceId
 * @param {function} callback optional
*/
netField.devices.containers.delete(containerId, deviceId, [callback])

create

Install device container

/**
 * @param {string} containerId
 * @param {string} deviceId
 * @param {any} params
 * @param {function} callback optional
*/
netField.devices.containers.create(containerId, deviceId, params, [callback])

update

Update device container

/**
 * @param {string} containerId
 * @param {string} deviceId
 * @param {any} params
 * @param {any} options optional
 * @param {function} callback optional
*/
netField.devices.containers.update(containerId, deviceId, params, [options], [callback])

properties

Get device container properties

/**
 * @param {string} containerId
 * @param {string} deviceId
 * @param {function} callback optional
*/
netField.devices.containers.properties(containerId, deviceId, [callback])

getInstalled

Get list of installed containers to device

/**
 * @param {string} deviceId
 * @param {any} options optional
 * @param {function} callback optional
*/
netField.devices.containers.getInstalled(deviceId, [options], [callback])

getdevicecontainer

Get a single installed container to a device

/**
 * @param {string} deviceId
 * @param {string} containerId
 * @param {function} callback optional
*/
netField.devices.containers.get(deviceId, containerId, [callback])

getDeployable

Get list of deployable containers to device

/**
 * @param {string} deviceId
 * @param {any} options optional
 * @param {function} callback optional
*/
netField.devices.containers.getDeployable(deviceId, [options], [callback])

deleteAll

Delete all device containers

/**
 * @param {string} deviceId
 * @param {function} callback optional
*/
netField.devices.containers.delete(deviceId, [callback])