Player — Deeplink Parameters

The Deeplink Parameter message allows the host app or environment to provide parameters that the player will append to URLs used for social sharing and calendar events.

Please ensure the host app / environment awaits the App Listen message to ensure the LiSA Player is ready to accept visitor related messages.

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

Properties

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

Name	Type	Description
deeplinkParameters	DeeplinkParameters	The deeplinkParameters property is an object containing extra parameters that the player will append to URLs used for social sharing and calendar events. Please refer to DeeplinkParameters for detailed information.

---

Type Definition

interface PlayerDeeplinkParametersMessage extends Omit<
  Message,
  'messageType' | 'recipient'
> {
  deeplinkParameters: DeeplinkParameters;
  messageType: 'lsc:player:deeplink:parameters';
  recipient: 'LiSA';
}

---

DeeplinkParameters

The DeeplinkParameters object lets you include custom parameters that the player will append to URLs used for social sharing and calendar events.

Please note: Any value of type other than number or string will be ignored.

interface DeeplinkParameters {
  [key: string]: number | string;
}

Example

window.postMessage({
  messageType: 'lsc:player:deeplink:parameters',
  recipient: 'LiSA',
  sender: 'Sender',
  deeplinkParameters: {
    utm_campaign: 'spring-sale',
    utm_content: 'social-sharing',
    utm_source: 'lisa-social-commerce',
  },
});