Telll core SDK

The SDK is a collection of classes and helpers to communicate with telll TWS (REST and Websockets services) and implement the widgets used in telll webapp.

License: GPLAffero 3.0 https://github.com/Telll/SDK/blob/master/LICENSE
Terms of Service: https://github.com/Telll/telll.github.io/wiki/Telll-Terms-of-Service
Download telllSDK.js stable
TWS docs: http://telll.github.io/tws/
SDK jsdoc: http://telll.github.io/SDK/telllSDK
Clone and develop: https://github.com/Telll/SDK

Example implementation:

App

http://webapp.telll.me/

XDK project

https://github.com/Telll/webapp

Important classes:

Telll Facade class for telll commands
Tws Facade class for API helpers
Auth Authentication class
TagPlayer View implementing the telll scheduling, sincronizes with a MockPlayer object.
MockPlayer A simple iPlayer implementation for video tags. Syncs with a TagPlayer object.

interfaces

iView Widgets and UI

iPlayer Sync tool with a video tag

iData Model interface for API data

Helpers:

Tws.getMovie()
Tws.getPhotolink()
Tws.getPhotolinksOfMovie()
Tws.moviesList()
Tws.readUserPhotolinks()
Tws.saveUser(data, id)
Tws.self()
Tws.sendPhotolink()
Tws.user()

UI:

Telll.wsAuth(data)
Telll.login(data)
Telll.logout(data)
telll.showMoviePage(movie, cb) → {MoviePage}
telll.showTagPlayer(player)
telll.showTelllBtn(trkm)
telll.syncPlayer(tagPlayer, moviePlayer)
Telll.sendPhotolink(data)
Telll.showClickbox(data)
Telll.showMockPlayer()

Integrations

Technology: multimedia inline links

telllSDK is a library to manage multimedia inline links.

telllSDK can be very easy to use to integrate, manage and control non intrusive advertising in mobile application.

javascript

The fulll javascript version is the file telllSDK.js that contains:

jQuery
Browserify
Mustache
TV4
The telll SDK framework

1. Download and compile

Requirements:

node.js
npm
perl 5.10 or superior

Use the commands bellow in a terminal (Linux, OSX, CygWin)

git clone https://github.com/Telll/SDK.git
cd SDK/telllSDK/src/js
npm build

You can also launch a local development server:

npm start

You have a working copy under build/js:

cd -
ls SDK/telllSDK/build/js

Copy it to your web server and begin using telll

2. Setup and configuration

/* Basic telll load with jQuery*/
/* Example */
function exampleImplementation (){
console.log('Loading example implementation ...');

myAdTest = new telllSDK.Telll();
console.info('telll: ', myAdTest);
// We may do it for a simplest aproach
// myAdTest.start();

// Detect if local machine is off line each 3600 seconds
setInterval( function(){
 $.ajax({
   type: "GET",
   cache: null,
   url: "http://"+myAdTest.conf.host+"/ws"
 }).fail( function() {
   alert('Connection seems down! Please check your Internet.');
 });
},3600000);



// After login create the buttons
myAdTest.login(null, function(){
    // define the instance player
    var myPlayer = {"error":"Player not loaded!!!"};
    // create buttons
    $('<input type="button" value="Dashboard">').appendTo('body').on('click', function(){myAdTest.showDashboard()});
    $('<input type="button" value="Clickbox">').appendTo('body').on('click', function(){myAdTest.showClickbox()});
    $('<input type="button" value="Movies List">').appendTo('body').on('click', 
        function(){
            // showMoviesList runs the callback after a movie is selected
            myAdTest.showMoviesList(function(m){
                        console.log("Movie selected: "+m.getTitle());
                        console.log(m);
                    })
        });
   $('<input type="button" value="Mock Player">').appendTo('body').on('click', 
       function(){
            // showMockPlayer runs the callback after load
           myAdTest.showMockPlayer( function(m){
                       myPlayer = m;       
               console.log(m); 
           })
       });
    $('<input type="button" value="Telll Movie Player">').appendTo('body').on('click', function(){myAdTest.showMoviePlayer()});
    $('<input type="button" value="Youtube Player">').appendTo('body').on('click', function(){myAdTest.showYoutubePlayer()});
    $('<input type="button" value="Tag Player">').appendTo('body').on('click', 
       function(){
            // showTagPlayer runs the callback after load
               myAdTest.showTagPlayer( myPlayer, function(tp){ 
                           console.log(tp);
               }) 
       });
    $('<input type="button" value="Photolinks List">').appendTo('body').on('click', function(){
        var list = myAdTest.showPhotolinksList();
        setTimeout(function(){
        console.log(list);
        list.on("open", function(pl){
            console.log("PL :", pl);
        });},200);
    });
    $('<input type="button" value="Telll Button">').appendTo('body').on('click', function(){myAdTest.showTelllBtn()});

});