Skip to main content

createPoll

Crée un sondage sur votre chaîne.
const poll = await ctx.twitch.polls.createPoll({
  title: "Qui va gagner ?",
  choices: ["Team A", "Team B"],
  duration: 60,
  channelPointsPerVote: 100,
})
Arguments
title
string
Le titre de la prédiction.
choices
string[]
Une liste des choix de la prédiction.
duration
number
La durée de la prédiction en secondes. (Enntre 15 et 1800)
channelPointsPerVote
number | null
Le nombre de points de chaine que le spectateur doit dépenser pour lancer un vote supplémentaire. Le minimum est 1 et le maximum est 1,000,000.Si rien n’est spécifié, les votes supplémentaires sont désactivés.
Type de retour La methode retourne un objet Poll.

endPoll

Termine un sondage en court.
await ctx.twitch.polls.endPoll(poll.id)
Arguments
pollId
string
L’identifiant du sondage.
showpoll
boolean
Si true, le résultat du sondage sera affiché sur le chat.
Type de retour La methode retourne un objet Poll.

getPollById

Récupère un sondage par son identifiant.
const poll = await ctx.twitch.polls.getPollById("pollId")
La methode retourne un objet Poll.

getPolls

Récupère tout les sondages en court sur votre chaîne.
const polls = await ctx.twitch.polls.getPolls()
La methode retourne un tabaleau d’objet Poll.

Types

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

Poll

{
  id: string // L'identifiant du sondage.
  title: string // Le titre du sondage.
  isChannelPointsVotingEnabled: boolean // Si les votes par points de chaine sont activés.
  channelPointsPerVote: number | null // Le nombre de points de chaine que le spectateur doit dépenser pour lancer un vote supplémentaire.

  status: "ACTIVE" | "ARCHIVED" | "TERMINATED" // Le status du sondage.

  durationInSeconds: number // La durée du sondage en secondes.
  startDate: string // La date de début du sondage.
  endDate: string // La date de fin du sondage.

  choices: PollChoice[] // Les choix du sondage.
}

PollChoice

{
  id: string // L'identifiant du choix.
  title: string // Le titre du choix.
  totalVotes: number // Le nombre total de votes.
  channelPointsVotes: number // Le nombre de votes par points de chaine.
}
I