devicehive v2.1.0

DeviceHive-javascript

DeviceHive-javascript is promise-based library for using DeviceHive.

Installation Instructions

For Node.js use case (Node v4.x on Mac, Linux, or Windows on a x86 or x64 processor), DeviceHive-javascript will install nice and easy with:

npm install devicehive

Generation bundle for browser usage

In case you want to use DeviceHive-javascript in the browser: 1. Clone repo; 2. Inside repo folder run npm install; 3. Inside repo folder run npm run build; 4. Get devicehive.js/devicehive.min.js in dist folder.

Usage

During development you can use this library with Promises, and Async/Await functions.

Connecting to DeviceHive

Using HTTP/HTTPS

Note: Using HTTP/HTTPS you need to pass 3 different service URL`s: mainServiceURL, authServiceURL and pluginServiceURL.

const DeviceHive = require('devicehive');
const httpDeviceHive = new DeviceHive({
    login: 'login',
    password: 'password',
    mainServiceURL: 'http://<host>:<port>/<path>',
    authServiceURL: 'http://<host>:<port>/<path>',
    pluginServiceURL: 'http://<host>:<port>/<path>'
});
httpDeviceHive.connect();

Using WebSocket

Note: Using WebSocket you need to pass only one service URL: mainServiceURL.

const DeviceHive = require('devicehive');
const wsDeviceHive= new DeviceHive({
    login: 'login',
    password: 'password',
    mainServiceURL: 'ws://<host>:<port>/<path>'
});
wsDeviceHive.connect();

Using Models

You can use models described in DeviceHive.models

// Getting Device model
const Device = DeviceHive.models.Device;

// Getting Device list query model
const DeviceListQuery = DeviceHive.models.query.DeviceListQuery;

Full Example and using API

You can use API described in DeviceHive.command, DeviceHive.configuration, DeviceHive.device, DeviceHive.deviceType, DeviceHive.info, DeviceHive.notification, DeviceHive.network, DeviceHive.plugin, DeviceHive.token, DeviceHive.user.

Here is example of how you can use DeviceHive-javascript:

const DeviceHive = require('devicehive');

// Getting Device model
const Device = DeviceHive.models.Device
// Getting Device list query model
const DeviceListQuery = DeviceHive.models.query.DeviceListQuery;

// Configurating DeviceHive
const myDeviceHive = new DeviceHive({
    login: 'login',
    password: 'password',
    mainServiceURL: 'ws://<host>:<port>/<path>'
});

// Configurating Device model
const device = new Device({
    id: 'myTestId',
    name: 'myTestName',
    networkId: 1,
    deviceTypeId: 1,
    blocked: false
});

// Configurating Device List query
const myDeviceListQuery = new DeviceListQuery({
    networkId: 1
});

// Push message handler
myDeviceHive.on(DeviceHive.MESSAGE_EVENT, (message) => {
    console.log(message);
});

// Error handler
myDeviceHive.on(DeviceHive.ERROR_EVENT, (error) => {
    console.error(error);
});

// Connecting and usin API
myDeviceHive.connect()
    .then(() => myDeviceHive.device.list(myDeviceListQuery))
    .then(data => console.log(data))
    .then(() => myDeviceHive.device.add(device))
    .then(data => console.log(data))
    .then(() => myDeviceHive.device.list(myDeviceListQuery))
    .then(data => console.log(data))
    .then(() => myDeviceHive.device.delete(device.id))
    .then(data => console.log(data))
    .then(() => myDeviceHive.device.list(myDeviceListQuery))
    .then(data => console.log(data))
    .catch(error => console.warn(error));

API Reference

DeviceHive

DeviceHive module

• DeviceHive
  • new DeviceHive(options)
  • instance
    • .connect()
  • static
    • .models : Object

new DeviceHive(options)

DeviceHive module

deviceHive.connect({ accessToken, refreshToken, login, password, reconnectionAttempts, reconnectionInterval })

Connect and authorize

Params: | Param | Type | Description | | --- | --- | --- | | options.accessToken | string | Access token (default DeviceHive constructor configuration) (optional) | | options.refreshToken | string | Refresh token (default DeviceHive constructor configuration) (optional) | | options.login | string | Login (default DeviceHive constructor configuration) (optional) | | options.password | string | Password (default DeviceHive constructor configuration) (optional) | | options.reconnectionAttempts | number | Reconnection attempts (default infinity (-1)) (optional) | | options.reconnectionInterval | number | Reconnection interval in ms (default 5000) (optional) |

DeviceHive.models : Object

Returns DeviceHive models

• Command
• Configuration
• DeviceType
• Network
• Notification
• UserToken
• PluginToken
• User
• query
  • CommandListQuery
  • CommandPollManyQuery
  • CommandPollQuery
  • CommandWaitQuery
  • DeviceCountQuery
  • DeviceListQuery
  • DeviceTypeCountQuery
  • DeviceTypeListQuery
  • DeviceTypeDeleteQuery
  • PluginUpdateQuery
  • NetworkCountQuery
  • NetworkListQuery
  • NetworkDeleteQuery
  • NotificationListQuery
  • NotificationPollManyQuery
  • NotificationPollQuery
  • UserCountQuery
  • UserListQuery
  • PluginCountQuery
  • PluginListQuery
  • PluginRegisterQuery

DeviceHive.command: Object

Look at DeviceCommandAPI.

DeviceHive.configuration : Object

Look at ConfigurationAPI.

DeviceHive.device: Object

Look at DeviceAPI.

DeviceHive.deviceType: Object

Look at deviceTypeAPI.

DeviceHive.info: Object

Look at InfoAPI.

DeviceHive.notification: Object

Look at DeviceNotificationAPI.

DeviceHive.network: Object

Look at NetworkAPI.

DeviceHive.plugin: Object

Look at PluginAPI.

DeviceHive.token: Object

Look at TokenAPI.

DeviceHive.user: Object

Look at UserAPI.

Nested DeviceHive API

ConfigurationAPI

Returns information about the current configuration

• ConfigurationAPI
  • .get(name) ⇒ Promise
  • .put(configuration) ⇒ Promise
  • .delete(name) ⇒ Promise

configurationAPI.get(name) ⇒ Promise

Creates ConfigurationAPI

configurationAPI.put(configuration) ⇒ Promise

Updates a configuration

configurationAPI.delete(name) ⇒ Promise

Deletes an existing configuration

DeviceAPI

Returns information about the current device

• DeviceAPI
  • .get(deviceId) ⇒ Promise
  • .list(deviceListQuery) ⇒ Promise
  • .count(deviceCountQuery) ⇒ Promise
  • .add(device) ⇒ Promise
  • .delete(deviceId) ⇒ Promise

deviceAPI.get(deviceId) ⇒ Promise

Creates DeviceAPI

deviceAPI.list(deviceListQuery) ⇒ Promise

Return a list of devices

deviceAPI.count(deviceCountQuery) ⇒ Promise

Returns count of devices

deviceAPI.add(device) ⇒ Promise

Registers or updates a device

deviceAPI.delete(deviceId) ⇒ Promise

Deletes an existing device

DeviceCommandAPI

Returns information about the current command

• DeviceCommandAPI
  • .get(deviceId, commandId) ⇒ Promise
  • .list(commandListQuery) ⇒ Promise
  • .insert(deviceId, command) ⇒ Promise
  • .update(command) ⇒ Promise
  • .poll(commandPollQuery) ⇒ Promise
  • .pollMany(commandPollManyQuery) ⇒ Promise
  • .wait(deviceId, commandId) ⇒ Promise
  • .subscribe(commandPollQuery) ⇒ Promise
  • .unsubscribe(subscriptionId) ⇒ Promise

deviceCommandAPI.get(deviceId, commandId) ⇒ Promise

Creates DeviceCommandAPI

deviceCommandAPI.list(commandListQuery) ⇒ Promise

Return a list of commands

deviceCommandAPI.insert(deviceId, command) ⇒ Promise

Registers a command

deviceCommandAPI.update(command) ⇒ Promise

Updates a command

deviceCommandAPI.poll(commandPollQuery) ⇒ Promise

deviceCommandAPI.pollMany(commandPollManyQuery) ⇒ Promise

deviceCommandAPI.wait(deviceId, commandId) ⇒ Promise

deviceCommandAPI.subscribe(commandPollQuery) ⇒ Promise

deviceCommandAPI.unsubscribe(subscriptionId) ⇒ Promise

DeviceNotificationAPI

Returns information about the current notification

• DeviceNotificationAPI
  • .get(deviceId, notificationId) ⇒ Promise
  • .list(notificationListQuery) ⇒ Promise
  • .insert(notification) ⇒ Promise
  • .poll(notificationPollQuery) ⇒ *
  • .pollMany(notificationPollManyQuery) ⇒ *
  • .subscribe(notificationPollQuery) ⇒ Promise
  • .unsubscribe(subscriptionId) ⇒ Promise

deviceNotificationAPI.get(deviceId, notificationId) ⇒ Promise

Creates DeviceNotificationAPI

deviceNotificationAPI.list(notificationListQuery) ⇒ Promise

Return a list of notifications

deviceNotificationAPI.insert(notification) ⇒ Promise

Registers a notification

deviceNotificationAPI.poll(notificationPollQuery) ⇒ *

deviceNotificationAPI.pollMany(notificationPollManyQuery) ⇒ *

deviceNotificationAPI.subscribe(notificationPollQuery) ⇒ Promise

deviceNotificationAPI.unsubscribe(subscriptionId) ⇒ Promise

DeviceTypeAPI

Returns information about the current deviceType

• DeviceTypeAPI
  • .get(deviceTypeId) ⇒ Promise
  • .list(deviceTypeListQuery) ⇒ Promise
  • .count(deviceTypeCountQuery) ⇒ Promise
  • .insert(deviceType) ⇒ Promise
  • .update(deviceType) ⇒ Promise
  • .delete(deviceTypeDeleteQuery) ⇒ Promise

deviceTypeAPI.get(deviceTypeId) ⇒ Promise

Creates DeviceTypeAPI

deviceTypeAPI.list(deviceTypeListQuery) ⇒ Promise

Return a list of deviceTypes

deviceTypeAPI.count(deviceTypeCountQuery) ⇒ Promise

Returns count of deviceTypes

deviceTypeAPI.insert(deviceType) ⇒ Promise

Registers a deviceType

deviceTypeAPI.update(deviceType) ⇒ Promise

Updates a deviceType

deviceTypeAPI.delete(deviceTypeDeleteQuery) ⇒ Promise

Deletes an existing deviceType

NetworkAPI

Returns information about the current network

• NetworkAPI
  • .get(networkId) ⇒ Promise
  • .list(networkListQuery) ⇒ Promise
  • .count(networkCountQuery) ⇒ Promise
  • .insert(network) ⇒ Promise
  • .update(networkId, network) ⇒ Promise
  • .delete(networkDeleteQuery) ⇒ Promise

networkAPI.get(networkId) ⇒ Promise

Returns a network

networkAPI.list(networkListQuery) ⇒ Promise

Return a list of networks

networkAPI.count(networkCountQuery) ⇒ Promise

Returns count of networks

networkAPI.insert(network) ⇒ Promise

Registers a network

networkAPI.update(networkId, network) ⇒ Promise

Updates a network

networkAPI.delete(networkDeleteQuery) ⇒ Promise

Deletes an existing network

PluginAPI

Returns information about the current plugin

• PluginAPI
  • .list(pluginListQuery) ⇒ Promise
  • .count(pluginCountQuery) ⇒ Promise
  • .insert(plugin, pluginRegisterQuery) ⇒ Promise
  • .update(plugin) ⇒ Promise
  • .delete(Plugin) ⇒ Promise

pluginAPI.list(pluginListQuery) ⇒ Promise

Return a list of plugins

pluginAPI.count(pluginCountQuery) ⇒ Promise

Returns count of plugins

pluginAPI.insert(plugin, pluginRegisterQuery) ⇒ Promise

Registers a plugin

pluginAPI.update(plugin) ⇒ Promise

Updates a plugin

pluginAPI.delete(Plugin) ⇒ Promise

Deletes an existing plugin

InfoAPI

Get server info

• InfoAPI
  • .getServerInfo()
  • .getCacheInfo()
  • .getClusterInfo()

infoAPI.getServerInfo()

Creates InfoAPI

infoAPI.getCacheInfo()

Get cache info

infoAPI.getClusterInfo()

Get cluster info

TokenAPI

Authentificate using login and password

• TokenAPI
  • .login(login, password)
  • .authPlugin(token)
  • .createUserToken(userToken)
  • .createPluginToken(pluginToken)
  • .refresh(refreshToken)

tokenAPI.login(login, password)

Creates TokenAPI

tokenAPI.authPlugin(token)

Create user token

tokenAPI.createUserToken(userToken)

Create user token

tokenAPI.createPluginToken(pluginToken)

Create plugin token

tokenAPI.refresh(refreshToken)

Refresg token

UserAPI

ConfigurationAPI

Returns information about the current configuration

• ConfigurationAPI
  • .get(name) ⇒ Promise
  • .put(configuration) ⇒ Promise
  • .delete(name) ⇒ Promise

configurationAPI.get(name) ⇒ Promise

Creates ConfigurationAPI

Returns: Promise - selected configuration

configurationAPI.put(configuration) ⇒ Promise

Updates a configuration

Returns: Promise - count of configuration

configurationAPI.delete(name) ⇒ Promise

Deletes an existing configuration

DeviceAPI

Returns information about the current device

• DeviceAPI
  • .get(deviceId) ⇒ Promise
  • .list(deviceListQuery) ⇒ Promise
  • .count(deviceCountQuery) ⇒ Promise
  • .add(device) ⇒ Promise
  • .delete(deviceId) ⇒ Promise

deviceAPI.get(deviceId) ⇒ Promise

Creates DeviceAPI

Returns: Promise - selected device

deviceAPI.list(deviceListQuery) ⇒ Promise

Return a list of devices

Returns: Promise - list of devices

deviceAPI.count(deviceCountQuery) ⇒ Promise

Returns count of devices

Returns: Promise - count of devices

deviceAPI.add(device) ⇒ Promise

Registers or updates a device

Returns: Promise - count of devices

deviceAPI.delete(deviceId) ⇒ Promise

Deletes an existing device

DeviceCommandAPI

Returns information about the current command

• DeviceCommandAPI
  • .get(deviceId, commandId) ⇒ Promise
  • .list(commandListQuery) ⇒ Promise
  • .insert(deviceId, command) ⇒ Promise
  • .update(command) ⇒ Promise
  • .poll(commandPollQuery) ⇒ Promise
  • .pollMany(commandPollManyQuery) ⇒ Promise
  • .wait(deviceId, commandId) ⇒ Promise
  • .subscribe(commandPollQuery) ⇒ Promise
  • .unsubscribe(subscriptionId) ⇒ Promise

deviceCommandAPI.get(deviceId, commandId) ⇒ Promise

Creates DeviceCommandAPI

Returns: Promise - selected command

deviceCommandAPI.list(commandListQuery) ⇒ Promise

Return a list of commands

Returns: Promise - list of commands

deviceCommandAPI.insert(deviceId, command) ⇒ Promise

Registers a command

Returns: Promise - count of commands

deviceCommandAPI.update(command) ⇒ Promise

Updates a command

Returns: Promise - count of commands

deviceCommandAPI.poll(commandPollQuery) ⇒ Promise

deviceCommandAPI.pollMany(commandPollManyQuery) ⇒ Promise

deviceCommandAPI.wait(deviceId, commandId) ⇒ Promise

deviceCommandAPI.subscribe(commandPollQuery) ⇒ Promise

deviceCommandAPI.unsubscribe(subscriptionId) ⇒ Promise

DeviceNotificationAPI

Returns information about the current notification

• DeviceNotificationAPI
  • .get(deviceId, notificationId) ⇒ Promise
  • .list(notificationListQuery) ⇒ Promise
  • .insert(deviceId, notification) ⇒ Promise
  • .poll(notificationPollQuery) ⇒ *
  • .pollMany(notificationPollManyQuery) ⇒ *
  • .subscribe(notificationPollQuery) ⇒ Promise
  • .unsubscribe(subscriptionId) ⇒ Promise

deviceNotificationAPI.get(deviceId, notificationId) ⇒ Promise

Creates DeviceNotificationAPI

Returns: Promise - selected notification

deviceNotificationAPI.list(notificationListQuery) ⇒ Promise

Return a list of notifications

Returns: Promise - list of notifications

deviceNotificationAPI.insert(deviceId, notification) ⇒ Promise

Registers a notification

Returns: Promise - count of notifications

deviceNotificationAPI.poll(notificationPollQuery) ⇒ *

deviceNotificationAPI.pollMany(notificationPollManyQuery) ⇒ *

deviceNotificationAPI.subscribe(notificationPollQuery) ⇒ Promise

deviceNotificationAPI.unsubscribe(subscriptionId) ⇒ Promise

DeviceTypeAPI

Returns information about the current deviceType

• DeviceTypeAPI
  • .get(deviceTypeId) ⇒ Promise
  • .list(deviceTypeListQuery) ⇒ Promise
  • .count(deviceTypeCountQuery) ⇒ Promise
  • .insert(deviceType) ⇒ Promise
  • .update(deviceType) ⇒ Promise
  • .delete(deviceTypeDeleteQuery) ⇒ Promise

deviceTypeAPI.get(deviceTypeId) ⇒ Promise

Creates DeviceTypeAPI

Returns: Promise - selected deviceType

deviceTypeAPI.list(deviceTypeListQuery) ⇒ Promise

Return a list of deviceTypes

Returns: Promise - list of deviceTypes

deviceTypeAPI.count(deviceTypeCountQuery) ⇒ Promise

Returns count of deviceTypes

Returns: Promise - count of deviceTypes

deviceTypeAPI.insert(deviceType) ⇒ Promise

Registers a deviceType

Returns: Promise - count of deviceTypes

deviceTypeAPI.update(deviceType) ⇒ Promise

Updates a deviceType

Returns: Promise - count of deviceTypes

deviceTypeAPI.delete(deviceTypeDeleteQuery) ⇒ Promise

Deletes an existing deviceType

NetworkAPI

Returns information about the current network

• NetworkAPI
  • .get(networkId) ⇒ Promise
  • .list(networkListQuery) ⇒ Promise
  • .count(networkCountQuery) ⇒ Promise
  • .insert(network) ⇒ Promise
  • .update(network) ⇒ Promise
  • .delete(networkDeleteQuery) ⇒ Promise

networkAPI.get(networkId) ⇒ Promise

Returns a network

Returns: Promise - selected network

networkAPI.list(networkListQuery) ⇒ Promise

Return a list of networks

Returns: Promise - list of networks

networkAPI.count(networkCountQuery) ⇒ Promise

Returns count of networks

Returns: Promise - count of networks

networkAPI.insert(network) ⇒ Promise

Registers a network

Returns: Promise - Network

networkAPI.update(network) ⇒ Promise

Updates a network

Returns: Promise - Network

networkAPI.delete(networkDeleteQuery) ⇒ Promise

Deletes an existing network

Returns: Promise - Network

PluginAPI

Returns information about the current plugin

• PluginAPI
  • .list(pluginListQuery) ⇒ Promise
  • .count(pluginCountQuery) ⇒ Promise
  • .register(plugin, pluginRegisterQuery) ⇒ Promise
  • .update(pluginUpdateQuery) ⇒ Promise
  • .delete(topicName) ⇒ Promise

pluginAPI.list(pluginListQuery) ⇒ Promise

Return a list of plugins

Returns: Promise - list of plugins

pluginAPI.count(pluginCountQuery) ⇒ Promise

Returns count of plugins

Returns: Promise - count of plugins

pluginAPI.register(plugin, pluginRegisterQuery) ⇒ Promise

Registers a plugin

Returns: Promise - Plugin

pluginAPI.update(pluginUpdateQuery) ⇒ Promise

Updates a plugin

Returns: Promise - Plugin

pluginAPI.delete(topicName) ⇒ Promise

Deletes an existing plugin

Returns: Promise - Plugin

InfoAPI

Get server info

• InfoAPI
  • .getServerInfo() ⇒ Promise
  • .getCacheInfo() ⇒ Promise
  • .getClusterInfo() ⇒ Promise

infoAPI.getServerInfo() ⇒ Promise

Get server info

infoAPI.getCacheInfo() ⇒ Promise

Get cache info

infoAPI.getClusterInfo() ⇒ Promise

Get cluster info

TokenAPI

Authenticate using login and password

• TokenAPI
  • .login(login, password)
  • .authPlugin(token)
  • .createUserToken(userToken)
  • .createPluginToken(pluginToken)
  • .refresh(refreshToken)

tokenAPI.login(login, password)

Creates TokenAPI

tokenAPI.authPlugin(token)

Create user token

tokenAPI.createUserToken(userToken)

Create user token

tokenAPI.createPluginToken(pluginToken)

Create plugin token

tokenAPI.refresh(refreshToken)

Refresh token

UserAPI

Return a list of users

• UserAPI
  • .list(userListQuery) ⇒ Promise
  • .count(userCountQuery) ⇒ Promise
  • .get(userId) ⇒ Promise
  • .insert(user) ⇒ Promise
  • .update(user) ⇒ Promise
  • .delete(userId) ⇒ Promise
  • .getCurrent() ⇒ Promise
  • .updateCurrent(user) ⇒ Promise
  • .getDeviceTypes(userId) ⇒ Promise
  • .unassignAllDeviceTypes(userId) ⇒ Promise
  • .assignAllDeviceTypes(userId) ⇒ Promise
  • .unassignDeviceType(userId, deviceTypeId) ⇒ Promise
  • .getDeviceType(userId, deviceTypeId) ⇒ Promise
  • .assignDeviceType(userId, deviceTypeId) ⇒ Promise
  • .getNetwork(userId, networkId) ⇒ Promise
  • .assignNetwork(userId, networkId) ⇒ Promise
  • .unassignNetwork(userId, networkId) ⇒ Promise

userAPI.list(userListQuery) ⇒ Promise

Creates UserAPI

Returns: Promise - list of users

userAPI.count(userCountQuery) ⇒ Promise

Returns count of users

Returns: Promise - count of users

userAPI.get(userId) ⇒ Promise

Returns information about the current user

Returns: Promise - selected user

userAPI.insert(user) ⇒ Promise

Registers a user

Returns: Promise - count of users

userAPI.update(user) ⇒ Promise

Updates a user (only for administrators)

Returns: Promise - count of users

userAPI.delete(userId) ⇒ Promise

Deletes an existing user

userAPI.getCurrent() ⇒ Promise

Returns information about the current user

Returns: Promise - selected user

userAPI.updateCurrent(user) ⇒ Promise

Updates a user (only for administrators)

Returns: Promise - count of users

userAPI.getDeviceTypes(userId) ⇒ Promise

userAPI.unassignAllDeviceTypes(userId) ⇒ Promise

userAPI.assignAllDeviceTypes(userId) ⇒ Promise

userAPI.unassignDeviceType(userId, deviceTypeId) ⇒ Promise

userAPI.getDeviceType(userId, deviceTypeId) ⇒ Promise

userAPI.assignDeviceType(userId, deviceTypeId) ⇒ Promise

userAPI.getNetwork(userId, networkId) ⇒ Promise

Gets information about user/network association

userAPI.assignNetwork(userId, networkId) ⇒ Promise

Associates network with the user

userAPI.unassignNetwork(userId, networkId) ⇒ Promise

Removes association between network and user

Models

Configuration

Configuration model

• Configuration
  • new Configuration(options)
  • .toObject() ⇒ Object

new Configuration(options)

Creates new Configuration model

configuration.toObject() ⇒ Object

Returns instance as a plain JS object

Device

Device model

• Device
  • new Device(options)
  • .toObject() ⇒ Object

new Device(options)

Creates new Device model

device.toObject() ⇒ Object

Returns instance as a plain JS object

DeviceCommand

DeviceCommand model

• DeviceCommand
  • new DeviceCommand(options)
  • .toObject() ⇒ Object

new DeviceCommand(options)

Creates new DeviceCommand model

deviceCommand.toObject() ⇒ Object

Returns instance as a plain JS object

DeviceNotification

DeviceNotification model

• DeviceNotification
  • new DeviceNotification(options)
  • .toObject() ⇒ Object

new DeviceNotification(options)

Creates new DeviceNotification model

deviceNotification.toObject() ⇒ Object

Returns instance as a plain JS object

DeviceType

DeviceType model

• DeviceType
  • new DeviceType(options)
  • .toObject() ⇒ Object

new DeviceType(options)

Creates new DeviceType model

deviceType.toObject() ⇒ Object

Returns instance as a plain JS object

Network

Network model

• Network
  • new Network(options)
  • .toObject() ⇒ Object

new Network(options)

Creates new Network model

network.toObject() ⇒ Object

Returns instance as a plain JS object

Plugin

Plugin model

• Plugin
  • new Plugin(options)
  • .toObject() ⇒ Object

new Plugin(options)

Creates new Plugin model

plugin.toObject() ⇒ Object

Returns instance as a plain JS object

PluginToken

PluginToken model

• PluginToken
  • new PluginToken(options)
  • .toObject() ⇒ Object

new PluginToken(options)

Creates new PluginToken model

pluginToken.toObject() ⇒ Object

Returns instance as a plain JS object

User

User model

• User
  • new User(options)
  • .toObject() ⇒ Object

new User(options)

Creates new User model

user.toObject() ⇒ Object

Returns instance as a plain JS object

UserToken

UserToken model

• UserToken
  • new UserToken(options)
  • .toObject() ⇒ Object

new UserToken(options)

Creates new UserToken model

userToken.toObject() ⇒ Object

Returns instance as a plain JS object

Query models

CommandListQuery

CommandListQuery class

• CommandListQuery
  • new CommandListQuery(options)
  • .toObject() ⇒ Object

new CommandListQuery(options)

Creates new CommandListQuery model

commandListQuery.toObject() ⇒ Object

Returns instance as a plain JS object

CommandPollManyQuery

CommandPollManyQuery class

• CommandPollManyQuery
  • new CommandPollManyQuery(options)
  • .toObject() ⇒ Object

new CommandPollManyQuery(options)

Creates new CommandPollManyQuery model

commandPollManyQuery.toObject() ⇒ Object

Returns instance as a plain JS object

CommandPollQuery

CommandPollQuery class

• CommandPollQuery
  • new CommandPollQuery(options)
  • .toObject() ⇒ Object

new CommandPollQuery(options)

Creates new CommandPollQuery model

commandPollQuery.toObject() ⇒ Object

Returns instance as a plain JS object

CommandWaitQuery

CommandWaitQuery class

• CommandWaitQuery
  • new CommandWaitQuery(options)
  • .toObject() ⇒ Object

new CommandWaitQuery(options)

Creates new CommandWaitQuery model

commandWaitQuery.toObject() ⇒ Object

Returns instance as a plain JS object

DeviceCountQuery

DeviceCountQuery class

• DeviceCountQuery
  • new DeviceCountQuery(options)
  • .toObject() ⇒ Object

new DeviceCountQuery(options)

Creates new DeviceCountQuery model

deviceCountQuery.toObject() ⇒ Object

Returns instance as a plain JS object

DeviceListQuery

DeviceListQuery class

• DeviceListQuery
  • new DeviceListQuery(options)
  • .toObject() ⇒ Object

<a name="new_DeviceListQ