App — Message Acknowledge

The Acknowledge message acknowledges the receipt of a distinct message by the LiSA Player.

This is particularly important for messages that require confirmation to ensure they are reliably received and not lost.

This message is sent by the LiSA Player to the host app / environment.

Properties

Along with all standard Message properties, a Message Acknowledge message includes the following additional properties:

Name
Type
Description

messageId

String

Required.

The messageId property is used to specify the distinct identifier of the message being acknowledged.

messageType

Literal

Required.

lsc:app:message:acknowledge


Type Definition

interface AppMessageAcknowledgeMessage extends Omit<
  Message,
  'messageId' | 'messageType' | 'sender'
> {
  messageId: string;
  messageType: 'lsc:app:message:acknowledge';
  sender: 'LiSA';
}

Examples

{
  "clockDriftInMs": 0,
  "messageId": "a84eccd0-8834-4e70-b011-de0472c40681",
  "messageType": "lsc:app:message:acknowledge",
  "sender": "LiSA"
}

Last updated