Skip to main content

​
getPredictions

Récupère la liste des prédictions sur la chaîne. 
const predictions = await ctx.twitch.predictions.getPredictions()
Arguments
​
pagination
ForwardPagination
La pagination pour récupérer les prédictions suivantes.
Type de retour La méthode retourne un objet contenant les données des prédictions et un curseur de pagination.

​
getPredictionsByIds

Récupère les prédictions par ID. 
const predictionIds = ["prediction_id_1", "prediction_id_2"]
const predictions =
  await ctx.twitch.predictions.getPredictionsByIds(predictionIds)
Arguments
​
ids
string[]
Un tableau d’identifiants de prédictions.
Type de retour La méthode retourne un tableau d’objets Prediction.

​
getPredictionById

Récupère une prédiction par ID. 
const predictionId = "prediction_id"
const prediction = await ctx.twitch.predictions.getPredictionById(predictionId)
Arguments
​
id
string
L’ID de la prédiction à récupérer.
Type de retour La méthode retourne un objet Prediction.

​
createPrediction

Crée une nouvelle prédiction sur la chaîne. 
const data = {
  title: "Titre de la prédiction",
  outcomes: ["Option 1", "Option 2"],
}
const prediction = await ctx.twitch.predictions.createPrediction(data)
Arguments
​
data
CreatePredictionData
Les données de la prédiction à créer.
Type de retour La méthode retourne un objet Prediction.

​
lockPrediction

Verrouille une prédiction existante. 
const predictionId = "prediction_id"
const lockedPrediction =
  await ctx.twitch.predictions.lockPrediction(predictionId)
Arguments
​
id
string
L’ID de la prédiction à verrouiller.
Type de retour La méthode retourne un objet Prediction.

​
resolvePrediction

Résout une prédiction existante. 
const predictionId = "prediction_id"
const outcomeId = "outcome_id"
const resolvedPrediction = await ctx.twitch.predictions.resolvePrediction(
  predictionId,
  outcomeId,
)
Arguments
​
id
string
L’ID de la prédiction à résoudre.
​
outcomeId
string
L’ID de l’issue à déclarer comme gagnante.
Type de retour La méthode retourne un objet Prediction.

​
cancelPrediction

Annule une prédiction existante. 
const predictionId = "prediction_id"
const canceledPrediction =
  await ctx.twitch.predictions.cancelPrediction(predictionId)
Arguments
​
id
string
L’ID de la prédiction à annuler.
Type de retour La méthode retourne un objet Prediction.

​
Types

Liste des types de retour des méthodes de l’objet Predictions.

​
Prediction

​
id
string
L’identifiant de la prédiction.
​
title
string
Le titre de la prédiction.
​
status
string
Le statut de la prédiction.
​
autoLockAfter
number
Le temps en secondes après lequel la prédiction sera automatiquement verrouillée.
​
createdAt
Date
La date de création de la prédiction.
​
endedAt
Date
La date de fin de la prédiction.
​
lockedAt
Date
La date de verrouillage de la prédiction.
​
outcomes
PredictionOutcome[]
Un tableau d’objets PredictionOutcome représentant les résultats possibles de la prédiction.
​
winningOutcome
PredictionOutcome | null
L’issue gagnante de la prédiction, si résolue.
​
winningOutcomeId
string | null
L’ID de l’issue gagnante de la prédiction, si résolue.

​
PredictionOutcome

​
color
string
La couleur associée à l’issue de la prédiction.
​
id
string
L’identifiant de l’issue de la prédiction.
​
title
string
Le titre de l’issue de la prédiction.
​
topPredictors
TopPredictor[]
Un tableau d’objets TopPredictor représentant les principaux prédicteurs de cette issue.
​
totalChannelPoints
number
Le nombre total de points de chaîne pariant sur cette issue.
​
users
number
Le nombre total d’utilisateurs ayant parié sur cette issue.

​
TopPredictor

​
userId
string
L’identifiant de l’utilisateur principal parieur.
​
userName
string
Le nom d’utilisateur de l’utilisateur principal parieur.
​
userDisplayName
string
Le nom d’affichage de l’utilisateur principal parieur.
​
channelPointsUsed
number
Le nombre de points de chaîne utilisés par l’utilisateur principal parieur.
​
channelPointsWon
number
Le nombre de points de chaîne gagnés par l’utilisateur principal parieur.
⌘I