setDeviceProperty(params: Object)

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

const { setDeviceProperty } = device;

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

Description

Set device properties

Parameters

PropertyTypeRequiredDescription
deviceIdstringYesdeviceId
codestringYesAttribute key
valuestringYesAttribute value
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
deviceIdstringdeviceIdv3.3.0
resultbooleanWhether the setting succeededv3.3.0
fail callback parameters
PropertyTypeDescription
errorMsgstringError message
errorCodestring | numberError code
Error extension

Return Value

None

Examples

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

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