Conteneurs et messages
Toute intégration Livstick manipule exactement deux objets : un conteneur, que vous créez, et un message, qui vient s’y déposer. Bien distinguer les deux est le moyen le plus rapide de comprendre le reste de l’API.
Un conteneur est un emplacement, pas un contenu
Un conteneur ne contient en lui-même ni vidéo, ni photo, ni aucun média particulier. C’est un emplacement adressable — un lieu destiné à en recevoir un, qui attend d’être rempli. Vous le créez avant que quoi que ce soit ait été enregistré, souvent avant même que le destinataire sache qu’il existe.
- Vous créez le conteneur avec votre propre référence métier (le crid) — un identifiant de commande, un identifiant de carte, un code imprimé sur un emballage.
- Le conteneur conserve les paramètres de remise : expéditeur, destinataire, langue et groupe de codes auquel il appartient.
- Il porte l’état actuel de l’enregistrement (si un message a déjà été mis à disposition ou non) et, via `mode`, le nombre de messages qu’il peut contenir.
Un message, c’est ce qui arrive
Un message est ce que votre destinataire enregistre réellement : une vidéo, rattachée au conteneur dans lequel elle a été enregistrée. Il a son propre identifiant, son propre état et ses propres données — distincts des champs du conteneur.
Un conteneur, un ou plusieurs messages
Un conteneur en mode single porte exactement un message : celui qui est enregistré, mis à disposition puis remis. Un conteneur en mode gallery peut en porter plusieurs — une collection qui s’enrichit de contributions au fil du temps, toutes accessibles depuis le même conteneur.
Pourquoi ce modèle rend les widgets évidents
Une fois cette distinction acquise, les deux widgets Livstick correspondent simplement aux deux usages qui en découlent : le Recorder écrit un message dans un conteneur, et le Viewer lit le message d’un conteneur. Rien d’autre n’a besoin d’être expliqué au préalable.
- Le Recorder reçoit un conteneur (via son urid) et y produit un message.
- Le Viewer reçoit un conteneur et affiche ce qui y a été déposé : le message, ou les messages en mode gallery.
- Aucun des deux widgets n’a besoin de connaître votre référence métier : cette correspondance reste de votre côté, via le crid.
Associer un cas d’usage à un mode
Le mode choisi à la création détermine combien de messages un conteneur accepte. La page consacrée aux modes de conteneur détaille la règle — voici où se rangent les cas d’usage courants.
| Cas d’usage | Mode |
|---|---|
| Message cadeau e-commerce | single |
| Carte cadeau | single |
| Cadeau collectif | gallery |
| Stories | gallery |
| Collecte d’avis | gallery |
| Activation en magasin à partir d’un code pré-imprimé | single |
Pour aller plus loin
Cette page ne fait que présenter la distinction. Chacune des pages suivantes en détaille un aspect.
- Identifiants
- Comment le crid, l’urid et l’editKey se rattachent à un conteneur.
- Modes de conteneur
- La règle complète des modes single et gallery.
- États des conteneurs et des messages
- Les états possibles d’un conteneur et d’un message, et quand chacun s’applique.
- Choisir un mode d’intégration
- Comment le Recorder s’insère dans votre propre parcours d’enregistrement.
- Widget Viewer
- Comment le Viewer relit le message d’un conteneur.