apiNG-plugin-flickr is a Flickr API plugin for apiNG.
Information
- Supported apiNG models:
social
,image
- This plugin supports the
get-native-data
parameter - Used promise library: angular-flickr-api-factory (included in distribution files)
Documentation
- INSTALLATION
- Get file
- Include file
- Add dependency
- Add plugin
- USAGE
- Models
- Requests
- Rate limit
1. INSTALLATION
I. Get file
Install via either bower, npm, CDN (jsDelivr) or downloaded files:
bower install apiNG-plugin-flickr --save
npm install aping-plugin-flickr --save
- use CDN file
- download apiNG-plugin-flickr.zip
II. Include file
Include aping-plugin-flickr.min.js
in your apiNG application
<!-- when using bower --> <!-- when using npm --> <!-- when using cdn file --> <!-- when using downloaded files -->
III. Add dependency
Add the module jtt_aping_flickr
as a dependency to your app module:
angular;
IV. Add the plugin
Add the plugin's directive aping-flickr="[]"
to your apiNG directive and configure your requests
2. USAGE
I. Models
Supported apiNG models
model | content | support | max items per request |
(native) default items per request |
---|---|---|---|---|
social |
images | full | 20 |
20 |
image |
images | full | 20 |
20 |
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 |
67221971@N06 |
A single user ID (Username converter) | no | |
items |
10 |
20 |
Items per request (0 -20 ) |
yes |
language |
de-de |
The display language for the feed. Valid values: de-de , en-us , es-us , fr-fr , it-it , ko-kr , pt-br , zh-hk |
yes |
Sample requests:
[{'userId':'67221971@N06'}, {'userId':'74103707@N02'}]
[{'userId':'125053471@N07', 'items':10}]
Requests by Tags
parameter | sample | default | description | optional |
---|---|---|---|---|
tags |
wood,forest |
A comma delimited list of tags to filter the feed by | no | |
tagmode |
any |
all |
Control whether items must have ALL the tags, or ANY of the tags | yes |
items |
10 |
20 |
Items per request (0 -20 ) |
yes |
language |
de-de |
The display language for the feed. Valid values: de-de , en-us , es-us , fr-fr , it-it , ko-kr , pt-br , zh-hk |
yes |
Sample requests:
[{'tags':'fcbayern'}, {'tags':'readmadrid'}]
[{'tags':'ocean,sea', 'tagmode':'any', 'items':10}]
III. Rate limit
Visit the official Flickr API documentation
Licence
MIT