0.0.16 • Published 7 years ago

@scrbbl/scribblelive-toolkit-collection v0.0.16

Weekly downloads
882
License
ISC
Repository
-
Last release
7 years ago

Scribblelive Toolkit Collection

This package allows developers to easily load a Scribblelive Slideshow.

Note: It does not currently support other collections unless an Auth is provided.

Installation

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

Prerequisites

Collection Example

This example assumes the use of npm and a module bundler such as webpack. Note: Auth is being used here, it can be omitted if the user is getting a Scribblelive Slideshow.

const Collections = require('@scrbbl/scribblelive-toolkit-collection');

const token = 'my-token';
const auth = 'my-auth';
const collectionId = '111111-222222-333333-444444';
const CollectionModule = new Collections({ token, auth });

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

const loadCollection = (collectionId) => {
  CollectionModule.load(collectionId, callback).then(
      res => console.log('res', res),
      err => console.log('err', err)
    );
};

loadCollection(collectionId);

Poll Example (non-npm)

index.html

<html>
<head>
  <script src="SLToolkit.js"></script>
</head>
<body>
  <button onclick="loadCollection('111111-222222-333333-444444')">
      Load Collection
  </button>
  <script src="app.js"></script>
</body>
</html>

app.js

var token = 'my-token';

var Core = new SLToolkit({token});

// Function to call when wanting to load a collection
function loadCollection(collectionId) {
  Core.Collection.load(collectionId).then(
    res => console.log('res', res),
    err => console.log('err', err)
  );
};

Collection Methods

Promise load(int collectionId)

This function will return a promise that when resolved will return collection data.

Made with :heart: at ScribbleLive

0.0.16

7 years ago

0.0.15

7 years ago

0.0.14

7 years ago

0.0.13

7 years ago

0.0.12

7 years ago

0.0.11

7 years ago

0.0.10

7 years ago

0.0.9

7 years ago

0.0.8

8 years ago

0.0.7

8 years ago

0.0.6

8 years ago

0.0.5

8 years ago

0.0.4

8 years ago

0.0.3

8 years ago

0.0.2

8 years ago