@scrbbl/scribblelive-toolkit-collection
v0.0.16
Published
Collection module for Scribblelive Toolkit
Readme
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
- Scribblelive Toolkit Core
- Scribblelive authentication token
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