handbid v0.0.77
#Handbid-Js
I am the Handbid
library. I work in both nodejs && in the browser. I rely on chai
for my tests. To be honest, I've never run any unit tests in the browser, someone should figure out how to do that. =)
##Lifecycle Connecting to an auction in Handbid is a multi-step process. It's pretty simple though, here is a breakdown:
- Instantiate new Handbid instance:
var hb = new Handbid()
- Connect to the
main
server by invoking:hb.connect();
- Connect to any auction by key by invoking:
hb.connectToAuction('any-auction-key');
- Listen for auction connection:
hb.on('did-connect-to-auction', function (e) { console.log(e.get('auction')); });
You can invoke connectToAuction()
immediately after connect()
(you don't have to wait for the main connection to be established).
##Examples Here are some code samples to get you started!
###Nodejs
$npm install handbid
var Handbid = require('handbid'),
hb = new Handbid();
hb.connect();
hb.connectToAuction('auction key');
//from this point it's exactly the same as the browser examples.
###Browser
<script type='text/javascript' src='https://handbid-js-handbid.netdna-ssl.com/handbid.js'></script>
<script type="text/javascript">
/**
* From the browser, a few operations are automatically performed for you. They are as follows:
*
* window.handbid = new Handbid();
* window.handbid.connect();
*
* So, automatically, you will be connected to the main Handbid server. But, you will not be able to listen in on any
* fancy update events. For
*/
handbid.connectToAuction('handbid-demo-auction');
handbid.on('did-connect-to-auction', function (e) {
var auction = e.get('auction');
auction.on('did-update-item', function (e) {
var itemKey = e.get('key'),
changes = e.get('changes');
console.log('the following was changed:', changes, 'on item with key:', itemKey);
});
auction.on('did-update', function (e) {
console.log(e);
});
});
</script>
###Authentication
##Events Under each event name is a description of the data passed with the event. This event is the single object passed to a listener of any event.
hb.on('did-connect-to-server', function (e) {
console.log(e.data); //will output everything in the event
console.log(e.get('url')); //use this rather than e.data.url because get() allows for a default value
if(e.get('anything', false)) {
}
});
Handbid
did-connect-to-server
: when a server connection is made after invokinghb.connect()
handbid
: instance that dispatched the eventurl
: the url we connected to
did-connect-to-auction
: dispatched afterhb.connectToAuction('auction-key')
handbid
: instance that dispatched the eventauction
: the auction we connected to
did-receive-message
: whenever the current user gets a messagemessage
: text of message that was sent
error
: anytime any error occurs
##Handbid API
- `
##Connect Button Throwing in a connect button is wicked easy!
<a href="#" data-handbid-connect data-handbid-pass="http://mywebsite.com/where/on/success" data-handbid-fail="http://mywebsite.com/where/on/fail">
<img src="assets/btn-hb-blue-big.png" />
</a>
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago