retsly-js-backbone
v1.0.2
Published
Backbone integration of Retsly-js-sdk
Downloads
7
Readme
retsly-js-backbone
Use Retsly with Backbone.
Install with npm
npm install --save retsly-js-backboneInstall directly from github
git clone https://github.com/Retsly/retsly-js-backbone.git
cd retsly-js-backbone
npm install # this will also build the javascriptUsage
Get a collection of listings
/**
* Main.js
*/
var RetslyBackbone = require('retsly-js-backbone')
// Enter your credentials
RetslyBackbone.create(<clientId>, <browserToken>);
var collection = new RetslyBackbone.Collections.Listings({vendorID: <vendorID>});
// Fetch collection
collection.fetch({success: function (response) {
// response is a collection of listing models
// do something with response
// Optional step - Fetch a specific model
var firstListing = response.models[0];
// Option 1: Enter an ID
var listing = new RetslyBackbone.Models.Listing({_id: firstListing.get('id'), vendorID: <vendorID>});
listing.fetch({success: function (item) {
// do something with listing
console.log(item);
}});
// Option 2: Call fetch directly on the model
firstListing.fetch({success: function (item) {
// do something with listing
console.log(item);
}});
}});To run in your browser:
browserify main.js -o <srcName>.jsInclude the the script in your header
<head>
<script src="<srcName>.js"></script>
</head>API
Retsly.create( clientId, browserToken )
Example
Retsly.create('asdfkjhgkl', '1234876590abc');- {String} clientId
- {String} browserToken
Retsly.Collections.#RESOURCE( { vendorID: vendorID } )
Example
var collection = new Retsly.Collections.Listings({vendorID: 'test'});#RESOURCE:
Listings
Agents
Offices
OpenHouses
Vendors
Parcels
Assessments
Transactions
{String} vendorID Sets the user tokens and ids
More info regarding Resources can be found in the Retsly Documentation
To get listings is the same as the Backbone fetch commands.
- collection.fetch(cb)
More info regarding backbone can be found in the Backbone Documentation
Repo Owner
License
(The MIT License)
Copyright (c) 2013 Retsly Software Inc [email protected]
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.