registerMetadata #

Add properties definition to the metadata field of the devices collection.

registerMetadata (mappings: JSONObject, options: JSONObject);

Arguments	Type	Description
`mappings`	JSONObject	Mappings definiton of the `metadata` property
`options`	JSONObject	Additional options

options #

Properties	Type	Description
`group`	string	Name of the group for which the mappings should apply. If unspecified, mappings will apply to every group who does not have specific definition.

Usage #

import { DeviceManagerPlugin } from 'kuzzle-plugin-device-manager';

const deviceManagerPlugin = new DeviceManagerPlugin();

deviceManagerPlugin.devices.registerMetadata({
    serial: {
    type: 'keyword',
    fields: {
      text: { type: 'text' } }
  }
}, { group: 'water_management' });

Edit this page on Github