publishLanMessage(params: Object)

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

const { publishLanMessage } = device;

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

Description

Send a message via the LAN channel

Parameters

PropertyTypeRequiredDescription
messagestringYesMessage content
deviceIdstringYesDevice ID
protocolnumberYesProtocol number
NoReserved flag for delivery logic configuration; can be extended later, for example to deliver sounds or define follow-up actions
complete() => voidNoCompletion callback (executed on both success and failure)
NoCallback on successful API call
fail(params: Object) => voidNoFailure callback
fail callback parameters
PropertyTypeDescription
errorMsgstringError message
errorCodestring | numberError code
Error extension

Return Value

None

Examples

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

device.publishLanMessage({
  message: "xx",
  deviceId: "xx",
  protocol: 1,
  options: { "xx": {} },
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});