Stickers — Unlock

The LiSA Player dispatches a message when an active sticker with an activation timer is unlocked, indicating that the activation timer has completed.

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

Properties

Along with all standard Sticker message properties, an Unlock message includes the following additional properties:

Name	Type	Description
messageType	Literal Required.	lsc:sticker:unlock
stickerActivationTimerIsActive	Literal Required.	The stickerActivationTimerIsActive property indicates, whether the sticker's activation timer is currently running. In case of the Sticker Unlock message, the value is always false.
stickerActivationTimerIsCompleted	Literal Required.	The stickerActivationTimerIsCompleted property indicates, whether the sticker's activation timer is complete. In case of the Sticker Unlock message, the value is always true.
stickerIsExpired	Literal Required.	The stickerIsExpired property indicates, whether the sticker has expired. In case of the Sticker Unlock message, the value is always false.
stickerIsUnlocked	Literal Required.	The stickerIsUnlocked property indicates, whether the sticker is unlocked. Either when the activation timer is not set or has completed AND the sticker has not expired. In case of the Sticker Unlock message, the value is always true.

---

Type Definition

interface StickerUnlockMessage extends Omit<
  StickerMessage,
  | 'messageType'
  | 'stickerActivationTimerIsActive'
  | 'stickerActivationTimerIsCompleted'
  | 'stickerIsExpired'
  | 'stickerIsUnlocked'
> {
  messageType: 'lsc:sticker:unlock';
  stickerActivationTimerIsActive: false;
  stickerActivationTimerIsCompleted: true;
  stickerIsExpired: true;
  stickerIsUnlocked: true;
}

---

Examples

{
  "clockDriftInMs": 0,
  "mediaItemId": "9f333331-45cb-4289-8bcd-9023c1871111",
  "mediaItemType": "live",
  "messageType": "lsc:sticker:unlock",
  "progress": {
    "bufferedTimeInMs": 648036,
    "currentTimeInMs": 628008,
    "durationInMs": 4616000,
    "elapsedTimeInMs": 28784,
    "skipTimeInMs": 600000,
    "isLive": true,
    "visitorDwellTimeInMs": 29135,
    "isPlaying": true
  },
  "sender": "LiSA",
  "stickerActionTarget": "NEW-YEARS-DROP",
  "stickerActivationTimerDurationInSec": 300,
  "stickerActivationTimerIsActive": false,
  "stickerActivationTimerIsCompleted": true,
  "stickerActivationTimerStartedAt": "2025-01-01T19:15:00Z",
  "stickerDetails": {
    "ctaBehavior": "addToCart",
    "productBrand": "BLIZ",
    "productCurrency": "EUR",
    "productId": "ab016523-250c-49a3-b2b4-86487d9df813",
    "productReference": "f20312c0-40a2-4b20-986c-5b81ceca6eae",
    "productPrice": 89.95,
    "productTitle": "RAVE UNISEX - Ski goggles - matt black/white"
  },
  "stickerExpiryTimerDurationInSec": 900,
  "stickerExpiryTimerIsActive": true,
  "stickerExpiryTimerStartedAt": "2025-01-01T19:20:00Z",
  "stickerId": "9ffbad77-c6e8-495e-99bb-193b0d3b109f",
  "stickerIsExpired": true,
  "stickerIsUnlocked": true,
  "stickerType": "product"
}