Bower component packaging modules to interact with api v6.
You can git clone this repo with the following methods:
git clone git@gitlab.snowite.fr:nathand/angular-sw-modules.git
git clone http://gitlab.snowite.fr/nathand/angular-sw-modules.git
You can also add this project as a dependency in your nodejs project by editing the bower.json
file as follow:
{
"dependencies": {
"angular-sw-modules": "git@gitlab.snowite.fr:nathand/angular-sw-modules.git",
"angular-sw-modules": "http://gitlab.snowite.fr/nathand/angular-sw-modules.git",
}
}
Run grunt
for building.
Running grunt test
will run the unit tests with karma.
Add sw.modules
in your Angular module dependencies.
- Albums
- Articles
- Artists
- Auth
- Browse
-
Cordova
- SDK
- Player
-
Offline
- Set an album
- Set a tracklist
- Set favorite tracks
- Get albums
- Get tracklists
- Get favorite tracks
- Get an album
- Get a tracklist
- Purge all
- Purge an album
- Purge a tracklist
- Purge favorite tracks
- Check album offline
- Check tracklist offline
- Check favorite tracks offline
- Check tracks offline
- Get cover
- Get disk used
- Sync album
- Sync tracklist
- Sync favorite tracks
- Events
- Helpers
- Lists
- Products
- Search
-
Users
- Tracklists
- Favorites
- Notifications
Service: AlbumsSrv
- @desc Get album from its id
- @param {Number} id
- @return {Promise}
- @desc Get album's tracks from its id
- @param {Number} id
- @param {Object} options <Optional>
- @param {Number} offset
- @param {Number} limit
- @param {Promise} timeout
- @return {Iterator}
Service: ArticlesSrv
- @desc Get article info from its id
- @param {Number} id
- @return {Promise}
- @desc Get articles' types
- @return {Promise}
- @desc Get content of an article's type
- @param {Number} id
- @return {Promise}
Service: ArtistsSrv
- @desc Get artist info from its id
- @param {Number} id
- @return {Promise}
- @desc Get artist's albums
- @param {Number} id
- @param {Object} options <Optional>
- @param {Number} offset
- @param {Number} limit
- @param {Promise} timeout
- @return {Iterator}
- @desc Get top tracks relative to an artist id
- @param {Number} id
- @param {Promise} timeout
- @return {Promise}
- @desc Get artists similars to a specific artist
- @param {Number} id
- @param {Object} options <Optional>
- @param {Number} offset
- @param {Number} limit
- @param {Promise} timeout
- @return {Iterator}
Service: AuthSrv
- @desc Register a new user
- @param {String} email
- @param {String} login
- @param {String} password
- @return {Promise}
- @desc Sign in a user + cache the JWT for logged calls
- @param {String} login
- @param {String} password
- @return {Promise}
- @desc Refresh the token from the one stored in the cache
- @return {Promise}
- @desc Log out the user (i.e. remove token from cache)
- @return {Promise}
Service: BrowseSrv
- @desc Get music genres
- @return {Promise}
- @desc Get top albums
- @param {Object} options <Optional>
- @param {Number} offset
- @param {Number} limit
- @param {Promise} timeout
- @return {Iterator}
- @desc Get top albums by genre
- @param {Number} id
- @param {Object} options <Optional>
- @param {Number} offset
- @param {Number} limit
- @param {Promise} timeout
- @return {Iterator}
- @desc Get top tracks
- @param {Object} options <Optional>
- @param {Number} offset
- @param {Number} limit
- @param {Promise} timeout
- @return {Iterator}
- @desc Get top tracks by genre
- @param {Number} id
- @param {Object} options <Optional>
- @param {Number} offset
- @param {Number} limit
- @param {Promise} timeout
- @return {Iterator}
- @desc Get new releases albums
- @param {Object} options <Optional>
- @param {Number} offset
- @param {Number} limit
- @param {Promise} timeout
- @return {Iterator}
- @desc Get new releases albums by genre
- @param {Number} id
- @param {Object} options <Optional>
- @param {Number} offset
- @param {Number} limit
- @param {Promise} timeout
- @return {Iterator}
Service: SdkSrv
- @desc Init native SDK
- @return {Promise}
- @desc Set offline sync only in wifi
- @param {Boolean} wifi
- @return {Promise}
- @desc Force offline only
- @param {Boolean} offline
- @return {Promise}
- @desc Check if it's wifi only for offline
- @return {Promise}
- @desc Check if it's offline only
- @return {Promise}
- @desc Set files format for downloading
- @param {String} format => low/medium/high
- @return {Promise}
- @desc Get offline download format
- @return {Promise}
- @desc Sign in a user
- @param {String} login
- @param {String} password
- @return {Promise}
- @desc Sign out a user
- @return {Promise}
- @desc Refresh a token
- @return {Promise}
- @desc Encrypt a string
- @param {String} str
- @return {Promise}
- @desc Decrypt a string
- @param {String} str
- @return {Promise}
- @desc Register device push token
- @param {String} pushToken
- @return {Promise}
- @desc Listen sdk events
- @param {String} evt
- @event tokenExpired
- @event tokenHasBeenRefreshed
- @event subscriptionExpired
- @param {Function} fn
Service: PlayerSrv
- @desc Play
- @param {String} playId
- @param {Number} trackId
- @return {Promise}
- @desc Pause
- @return {Promise}
- @desc Resume
- @return {Promise}
- @desc Seek to a specific time
- @param {Number} time
- @return {Promise}
- @desc Set volume
- @param {Number} value => [0, 1]
- @return {Promise}
- @desc Get volume
- @return {Promise}
- @desc Launch airplay
- @return {Promise}
- @desc Check if airplay is enabled by the system
- @return {Promise}
- @desc Listen play events
- @param {String} evt
- @event time track time elapsed
- @event end end of track
- @event volume
- @event pause
- @event previous
- @event next
- @event airplay
- @event error play error
- @param {Function} fn
Service: OfflineSrv
- @desc Set an album offline
- @param {Number} id
- @return {Promise}
- @desc Set a tracklist offline
- @param {Number} id
- @return {Promise}
- @desc Set all favorite tracks offline
- @return {Promise}
- @desc Get albums offline
- @param {Object} options
- @param {Number} limit for iterator's creating
- @return {Promise}
- @desc Get tracklists offline
- @param {Object} options
- @param {Number} limit for iterator's creating
- @return {Promise}
- @desc Get favorite tracks offline
- @param {Object} options
- @param {Number} limit for iterator's creating
- @return {Promise}
- @desc Get album offline
- @param {Number} id
- @param {Object} options
- @param {Number} limit for iterator's creating
- @return {Promise}
- @desc Get tracklist offline
- @param {Number} id
- @param {Object} options
- @param {Number} limit for iterator's creating
- @return {Promise}
- @desc Purge all contents
- @return {Promise}
- @desc Purge album offline
- @param {Number} id
- @return {Promise}
- @desc Purge tracklist offline
- @param {Number} id
- @return {Promise}
- @desc Purge favorite tracks offline
- @return {Promise}
- @desc Check if an album is offline
- @param {Number} id
- @return {Promise}
- @desc Check if a tracklist is offline
- @param {Number} id
- @return {Promise}
- @desc Check if favorite tracks are offline
- @return {Promise}
- @desc Check if tracks are offline
- @param {Array} ids
- @return {Promise}
- @desc Get cover
- @param {String} url
- @return {Promise}
- @desc Get data disk size used for offline
- @return {Promise}
- @desc Sync offline album
- @param {Number} id
- @return {Promise}
- @desc Sync offline tracklist
- @param {Number} id
- @return {Promise}
- @desc Sync offline favorite tracks
- @return {Promise}
- @desc Listen play events
- @param {String} evt
- @event download percentage downloaded
- @event error offline error
- @param {Function} fn
Service: HelpersSrv
- @desc Add an album to a list
- @param {Number} listId
- @param {Number} albumId
- @return {Promise}
- @desc Add a tracklist to a list
- @param {Number} listId
- @param {Number} albumId
- @return {Promise}
Service: ListsSrv
- @desc Get lists' types
- @return {Promise}
- @desc Get
- @param {Number} id
- @return {Promise}
- @desc Get tracks from a list id
- @param {Number} id
- @param {Object} options <Optional>
- @param {Number} offset
- @param {Number} limit
- @param {Promise} timeout
- @return {Iterator}
- @desc Create a list
- @param {String} type
- @param {String} title
- @param {Boolean} isPublic
- @param {Number} lifetime
- @return {Promise}
- @desc Update list info
- @param {Number} id
- @param {Object} update
- @return {Promise}
- @desc Add an item in a list
- @param {Number} id
- @param {Array} items
- @return {Promise}
- @desc Replace an item in a list
- @param {Number} id
- @param {Array} items
- @return {Promise}
- @desc Delete a list
- @param {Number} id
- @return {Promise}
- @desc Add tags in a list
- @param {Number} id
- @param {Array} tags
- @return {Promise}
- @desc Add a tag in a list
- @param {Number} id
- @param {Array} tags
- @return {Promise}
Service: ProductsSrv
- @desc Get all products
- @return {Promise}
- @desc Get product
- @param {Number} id
- @return {Promise}
- @desc Get product's prices
- @param {Number} id
- @return {Promise}
- @desc Set product's prices
- @param {Number} id
- @param {Object} priceObject
- @return {Promise}
Service: SearchSrv
- @desc Global search (i.e. lists + artists + albums + tracks + articles)
- @param {String} term
- @param {Object} options <Optional>
- @param {Number} offset
- @param {Number} limit
- @return {Promise}
- @desc Lists search
- @param {String} term
- @param {Object} options <Optional>
- @param {Number} offset
- @param {Number} limit
- @param {Promise} timeout
- @return {Iterator}
- @desc Artists search
- @param {String} term
- @param {Object} options <Optional>
- @param {Number} offset
- @param {Number} limit
- @param {Promise} timeout
- @return {Iterator}
- @desc Albums search
- @param {String} term
- @param {Object} options <Optional>
- @param {Number} offset
- @param {Number} limit
- @param {Promise} timeout
- @return {Iterator}
- @desc Tracks search
- @param {String} term
- @param {Object} options <Optional>
- @param {Number} offset
- @param {Number} limit
- @param {Promise} timeout
- @return {Iterator}
- @desc Articles search
- @param {String} term
- @param {Object} options <Optional>
- @param {Number} offset
- @param {Number} limit
- @param {Promise} timeout
- @return {Iterator}
- @desc Save a term in the search history
- @param {String} term
- @return {Promise}
- @desc Get history
- @return {Promise}
- @desc Purge an item or all history
- @param {String} term <Optional>
- @return {Promise}
Service: UsersSrv
- @desc Create a tracklist
- @param {String} title
- @param {Boolean} isPublic
- @return {Promise}
- @desc Get a tracklist from its id
- @param {Number} id
- @param {Object} options <Optional>
- @param {Number} limit
- @return {Promise}
- @desc Get all tracklists
- @param {Object} options <Optional>
- @param {Number} offset
- @param {Number} limit
- @param {Promise} timeout
- @return {Iterator}
- @desc Update tracklist's info
- @param {Number} id
- @param {Object} update
- @return {Promise}
- @desc Delete tracklist
- @param {Number} id
- @return {Promise}
- @desc Add tracks to a tracklist
- @param {Number} id
- @param {Array | Number} tracks
- @return {Promise}
- @desc Replace tracks to a tracklist
- @param {Number} id
- @param {Array} tracks
- @return {Promise}
- @desc Delete tracks to a tracklist
- @param {Number} id
- @param {Array | Number} tracks
- @return {Promise}
- @desc Get user's favorites
- @param {String} type ie 'artists' || 'albums' || 'tracks'
- @param {Object} options <Optional>
- @param {Number} offset
- @param {Number} limit
- @param {Promise} timeout
- @return {Iterator}
- @desc Add favorites to the user's profile
- @param {String} type ie 'artists' || 'albums' || 'tracks'
- @param {Array | Number} items
- @return {Promise}
- @desc Check if favorites exist in the user's profile
- @param {String} type ie 'artists' || 'albums' || 'tracks'
- @param {Array | Number} items
- @return {Promise}
- @desc Reorder user's favorites
- @param {String} type ie 'artists' || 'albums' || 'tracks'
- @param {Array | Number} items
- @return {Promise}
- @desc Delete user's favorites
- @param {String} type ie 'artists' || 'albums' || 'tracks'
- @param {Array | Number} items
- @return {Promise}
- @desc Get user's notifications
- @param {String} language
- @param {Boolean} read
- @return {Promise}
- @desc Update user's notifications
- @param {Number} id
- @param {Boolean} read
- @return {Promise}