1.1.1 • Published 2 years ago
digified-subscriptions-tmp v1.1.1
This API has its own database, so Digified provide a secure way to subscribe the changes.
createConnection
const { createConnection } = require('digified-subscriptions')
createConnection({
username: 'username',
password: 'password',
subs_url: 'https://db2.digified.io',
callback: (data) => console.log('received:', JSON.stringify(data, null, 4)),
}).then(({ unsubscribe }) => {
// You can use unsubscribe function any time to close the connection.
})This method uses the webhook protocol if it's available, otherwise it will use the websocket protocol automatically.
createConnection Parameters
| parameter | type | protocol | description | default | |
|---|---|---|---|---|---|
username | String | required | any | Your dashboard username | |
password | String | required | any | Your dashboard password | |
subs_url | String | required | any | The subscription host url | |
callback | Function | required | any (except external webhook) | The callback function that will called if any change happend | |
only | Array or Undefined | optional | any | The list of the models that you want to subscribe, elements can take one value of 'client' | 'session' | 'ocr' | 'face' | 'live' | 'name' | 'regDBEntry' | undefined means subscribe all |
webhook_host | String or Undefined | optional | webhook | The public IP of the machine | undefined means try to extract the machine ip |
port | String or Number | optional | internal webhook | The port that the webhook will listen on | 5555 |
secret | String | optional | webhook | A secret string to generate secure token between the db host and the webhook | 'secret' |
subscribeWebhook
const { subscribeWebhook } = require('digified-subscriptions')
subscribeWebhook({
username: 'username',
password: 'password',
subs_url: 'https://db2.digified.io',
}).then(({ unsubscribe }) => {
// If the connection is internal, you can use unsubscribe function any time to close the connection.
})subscribeWebhook Parameters
| parameter | type | protocol | description | default | |
|---|---|---|---|---|---|
username | String | required | internal and external webhook | Your dashboard username | |
password | String | required | internal and external webhook | Your dashboard password | |
subs_url | String | required | internal and external webhook | The subscription host url | |
callback | Function | required | internal webhook | The callback function that will called if internal and external webhook change happend | |
only | Array or Undefined | optional | internal and external webhook | The list of the models that you want to subscribe, elements can take one value of 'client' | 'session' | 'ocr' | 'face' | 'live' | 'name' | 'regDBEntry' | undefined means subscribe all |
external_webhook | Boolean | optional | register using an external webhook | false | |
webhook_host | String or Undefined | optional | internal and external webhook | The public IP of the machine | undefined means try to extract the machine ip |
port | String or Number | optional | internal webhook | The port that the webhook will listen on | 5555 |
secret | String | optional | internal and external webhook | A secret string to generate secure token between the db host and the webhook | 'secret' |
unsubscribeWebhook
const { unsubscribeWebhook } = require('digified-subscriptions')
unsubscribeWebhook({
username: 'username',
password: 'password',
subs_url: 'https://db2.digified.io',
})unsubscribeWebhook Parameters
| parameter | type | description | default | |
|---|---|---|---|---|
username | String | required | Your dashboard username | |
password | String | required | Your dashboard password | |
subs_url | String | required | The subscription host url |
subscribeWebsocket
const { subscribeWebsocket } = require('digified-subscriptions')
subscribeWebsocket({
username: 'username',
password: 'password',
subs_url: 'https://db2.digified.io',
callback: (data) => console.log('received:', JSON.stringify(data, null, 4)),
}).then(({ unsubscribe }) => {
// If the connection is internal, you can use unsubscribe function any time to close the connection.
})subscribeWebsocket Parameters
| parameter | type | description | default | |
|---|---|---|---|---|
username | String | required | Your dashboard username | |
password | String | required | Your dashboard password | |
subs_url | String | required | The subscription host url | |
callback | Function | required | The callback function that will called if any change happend | |
only | Array or Undefined | optional | The list of the models that you want to subscribe, elements can take one value of 'client' | 'session' | 'ocr' | 'face' | 'live' | 'name' | 'regDBEntry' | undefined means subscribe all |