getMeshDeviceId(params: Object)

Requires:
DeviceKit≥2.4.0@ray-js/ray≥0.6.23
Platforms:
iOSAndroid
import { device } from '@ray-js/ray';

const { getMeshDeviceId } = device;

// Promise usage
try {
  const res = await getMeshDeviceId({ ...params });
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

Description

Get a sub-device's device ID by nodeId; on success, the success callback returns DeviceResult containing the sub-device deviceId

Parameters

PropertyTypeRequiredDescription
nodeIdstringYesMesh sub-device nodeId (getMeshDeviceId uses plain format, getMeshDeviceIdHex uses Hex format)
deviceIdstringYesdeviceId (gateway ID)
complete() => voidNoCompletion callback (executed on both success and failure)
success(params: Object) => voidNoCallback on successful API call
fail(params: Object) => voidNoFailure callback
success callback parameters
PropertyTypeDescriptionDeviceKit Since
deviceIdstringThe queried Mesh sub-device deviceIdv3.3.0
fail callback parameters
PropertyTypeDescription
errorMsgstringError message
errorCodestring | numberError code
Error extension

Return Value

None

Examples

import { device } from '@ray-js/ray'

device.getMeshDeviceId({
  nodeId: "xx",
  deviceId: "xx",
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});