Aller au contenu principal

unsubscribeByMarker

Se désabonner des événements liés aux produits. 🔐 Cette méthode nécessite une autorisation.

Description

Cette méthode désabonne l'utilisateur autorisé d'une souscription à un événement sur un produit spécifique. Elle renvoie une Promise qui se résout à true si la souscription a été supprimée, ou à un objet IError s'il y a eu un problème.

⚠️ Avec le paramètre par défaut errors.isShell: true, une requête rejetée est retournée plutôt que lancée : cette méthode se résout à un objet IError, jamais à false. Vérifiez result === true - un objet d'erreur est considéré comme vrai, donc if (result) traiterait un échec comme un succès.

Événements.unsubscribeByMarker(

marker*, productId*, langCode, threshold

);

Schéma des paramètres

Schéma

marker:* string
Marqueur d'événement
exemple : test_event

productId:* string
Identifiant du produit
exemple : 14

langCode: string
Code de langue
exemple : en_US

threshold: number
Valeur seuil pour comparer des valeurs numériques
exemple : 0

Exemples

Exemple minimal

const response = await Events.unsubscribeByMarker('test_event', 1);

Exemple avec des attributs

const response = await Events.unsubscribeByMarker('test_event', 1, 'en_US', 0);

Ne renvoie rien si le désabonnement a réussi.