aping-plugin-dailymotion
v0.7.10
Published
Dailymotion plugin for apiNG
Downloads
9
Maintainers
Readme
apiNG-plugin-dailymotion is a Dailymotion Data API plugin for apiNG.
Information
- Supported apiNG models:
social
,video
- This plugin supports the
get-native-data
parameter - Used promise library: angular-dailymotion-api-factory (included in distribution files)
Documentation
- INSTALLATION
- Get file
- Include file
- Add dependency
- Add plugin
- USAGE
- Models
- Requests
1. INSTALLATION
I. Get file
Install via either bower, npm, CDN (jsDelivr) or downloaded files:
bower install apiNG-plugin-dailymotion --save
npm install aping-plugin-dailymotion --save
- use CDN file
- download apiNG-plugin-dailymotion.zip
II. Include file
Include aping-plugin-dailymotion.min.js
in your apiNG application
<!-- when using bower -->
<script src="bower_components/apiNG-plugin-dailymotion/dist/aping-plugin-dailymotion.min.js"></script>
<!-- when using npm -->
<script src="node_modules/aping-plugin-dailymotion/dist/aping-plugin-dailymotion.min.js"></script>
<!-- when using cdn file -->
<script src="//cdn.jsdelivr.net/aping.plugin-dailymotion/latest/aping-plugin-dailymotion.min.js"></script>
<!-- when using downloaded files -->
<script src="aping-plugin-dailymotion.min.js"></script>
III. Add dependency
Add the module jtt_aping_dailymotion
as a dependency to your app module:
angular.module('app', ['jtt_aping', 'jtt_aping_dailymotion']);
IV. Add the plugin
Add the plugin's directive aping-dailymotion="[]"
to your apiNG directive and configure your requests
<aping
template-url="templates/social.html"
model="social"
items="20"
aping-dailymotion="[{'search':'eminem'}]">
</aping>
2. USAGE
I. Models
Supported apiNG models
| model | content | support | max itemsper request | (native) default itemsper request |
|----------|---------|---------|--------|---------|
| social
| videos | full | 100
| 10
|
| video
| videos | full | 100
| 10
|
support:
- full: the source platform provides a full list with usable results
- partly: the source platfrom provides just partly usable results
II. Requests
Every apiNG plugin expects an array of requests as html attribute.
Requests by User
| parameter | sample | default | description | optional |
|----------|---------|---------|---------|---------|
| userId
| brtvofficial
| | User ID | no |
| search
| eminem
| | Limit the result set to this full text search | yes |
| tags
| hiphop,rap
| | Limit the result set to this full text search of video tags | yes |
| channelId
| music
| | Limit the result set to this channel (Browse channels) | yes |
| items
| 25
| 10
| Items per request (0
-100
) | yes |
| protocol
| https
| | Use https
or http
to force the protocol. Leave it blank to for dynamic choice. Works only for model video
| yes |
Sample requests:
[{'userId':'lolaflips'}, {'userId':'thepetcollective'}]
[{'userId':'FailArmy', 'items':30, 'search':'2015'}]
Requests by Channel
| parameter | sample | default | description | optional |
|----------|---------|---------|---------|---------|
| channelId
| music
| | Limit the result set to this channel (Browse channels) | no |
| search
| eminem
| | Limit the result set to this full text search | yes |
| tags
| hiphop,rap
| | Limit the result set to this full text search of video tags | yes |
| items
| 25
| 10
| Items per request (0
-100
) | yes |
| protocol
| https
| | Use https
or http
to force the protocol. Leave it blank to for dynamic choice. Works only for model video
| yes |
Sample requests:
[{'channelId':'music'}]
Requests by Playlist
| parameter | sample | default | description | optional |
|----------|---------|---------|---------|---------|
| playlistId
| x439f7_brtvofficial_br-highlights-september
| | Limit the result set to this playlist | no |
| search
| eminem
| | Limit the result set to this full text search | yes |
| tags
| hiphop,rap
| | Limit the result set to this full text search of video tags | yes |
| items
| 25
| 10
| Items per request (0
-100
) | yes |
| protocol
| https
| | Use https
or http
to force the protocol. Leave it blank to for dynamic choice. Works only for model video
| yes |
Sample requests:
[{'playlistId':'x439f7_brtvofficial_br-highlights-september'}]
Requests by Search
| parameter | sample | default | description | optional |
|----------|---------|---------|---------|---------|
| search
| eminem
| | Limit the result set to this full text search | no |
| tags
| hiphop,rap
| | Limit the result set to this full text search of video tags | yes |
| genre
| comedy
| | Limit the result set to this genre of videos | yes |
| country
| us
| | Limit the result set to this country (declarative) | yes |
| language
| en
| | Limit the result set to this language | yes |
| items
| 25
| 10
| Items per request (0
-100
) | yes |
| protocol
| https
| | Use https
or http
to force the protocol. Leave it blank to for dynamic choice. Works only for model video
| yes |
Sample requests:
[{'search':'adele'}]
[{'search':'Louis C K', 'language':'en', 'items':5}]
Requests by Tags
| parameter | sample | default | description | optional |
|----------|---------|---------|---------|---------|
| tags
| hiphop,rap
| | Limit the result set to this full text search of video tags | no |
| search
| eminem
| | Limit the result set to this full text search | yes |
| genre
| comedy
| | Limit the result set to this genre of videos | yes |
| country
| us
| | Limit the result set to this country (declarative) | yes |
| language
| en
| | Limit the result set to this language | yes |
| items
| 25
| 10
| Items per request (0
-100
) | yes |
| protocol
| https
| | Use https
or http
to force the protocol. Leave it blank to for dynamic choice. Works only for model video
| yes |
Sample requests:
[{'tags':'soccer'}]
[{'tags':'fcbayern,müller', 'language':'de', 'items':5}]
Licence
MIT