@scrbbl/scribblelive-toolkit-poll

v0.0.17

Published

2 years ago

Poll module for Scribblelive Toolkit

Downloads

0High
0Medium
0Low

scrbbl

Scribblelive Toolkit Poll

This package allows developers to easily use Scribblelive Poll post types.

Installation

To install the package run npm i @scrbbl/scribblelive-toolkit-poll within the project that contains the Scribblelive Toolkit Core.

Prerequisites

Scribblelive Toolkit Core
Scribblelive authentication token

Poll Example

This example assumes the use of npm and a module bundler such as webpack.

const Polls = require('@scrbbl/scribblelive-toolkit-poll');
 
const token = 'my-token';
 
const PollModule = new Polls({token});
const streamId = 123;
const pollId = 456;
const selectionId = 789;

PollModule.vote({streamId, pollId, selectionId}).then(
    res => console.log('res', res),
    err => console.log('err', err)
  );

let cancel = null;

const cb = (err, res) => {
  console.log(err, res);
};

// PollId is being listened to for changes with a given callback. 
PollModule.listen({ pollId, interval: 2000, cb })
  .then(cancelFn => cancel = cancelFn);

// In 10 seconds it will cancel the polling for the Poll 
setTimeout(() => {
  cancel();
}, 10000)

Poll Example (non-npm)

This is assuming a use of the Scribblelive Core as it has the pre-compiled SLToolkit.js

index.html

<html>
<head>
  <script src="SLToolkit.js"></script>
</head>
<body>
  <button onclick="voteClick(123456, 123)">
      vote
  </button>
  <script src="app.js"></script>
</body>
</html>

app.js


var token = 'my-token';

var Core = new SLToolkit({token});
var streamId = 123;
var pollId = 123456;

// Function to call when vote is clicked
function voteClick(pollId, selectionId) {
  Core.Poll.vote({streamId, pollId, selectionId}).then(
    res => console.log('res', res),
    err => console.log('err', err)
  );
};

function callback(err, res) {
  console.log(err, res);
  // Update poll if needed
}

Core.Poll.listen({pollId, interval: 2000, callback})
    .then(cancelFn => cancel = cancelFn);

setTimeout(() => {
  cancel();
}, 10000)

Poll Methods

string baseUrl()

This function will return the baseUrl which the will be used for polling for new data.

int pollInterval()

This function will return the interval which is being used when polling for new data.

Promise vote({int streamId, int pollId, int selectionId })

This function will return a promise that when completed has voted for the selection provided of the specified pollId within the specified stream.

Promise getPoll(int pollId)

This function will return a promise that when resolved will return poll data for the specified pollId.

Promise listen({ int pollId, int interval [default=pollInterval], function callback})

This function will return a promise that when resolved will return a function that can be called to cancel it. It will return the new Poll data to the callback function.

Boolean hasVoted({ int streamId, int pollId })

This function will return whether the current user has voted on the specified poll.

Made with :heart: at ScribbleLive