Home

Awesome

apiNG

Join the chat at https://gitter.im/JohnnyTheTank/apiNG npm version Bower version

apiNG-plugin-flickr is a Flickr API plugin for apiNG.

Information

Documentation

  1. INSTALLATION
    1. Get file
    2. Include file
    3. Add dependency
    4. Add plugin
  2. USAGE
    1. Models
    2. Requests
    3. Rate limit

1. INSTALLATION

I. Get file

Install via either bower, npm, CDN (jsDelivr) or downloaded files:

II. Include file

Include aping-plugin-flickr.min.js in your apiNG application

<!-- when using bower -->
<script src="bower_components/apiNG-plugin-flickr/dist/aping-plugin-flickr.min.js"></script>

<!-- when using npm -->
<script src="node_modules/aping-plugin-flickr/dist/aping-plugin-flickr.min.js"></script>

<!-- when using cdn file -->
<script src="//cdn.jsdelivr.net/npm/aping-plugin-flickr@latest/dist/aping-plugin-flickr.min.js"></script>

<!-- when using downloaded files -->
<script src="aping-plugin-flickr.min.js"></script>

III. Add dependency

Add the module jtt_aping_flickr as a dependency to your app module:

angular.module('app', ['jtt_aping', 'jtt_aping_flickr']);

IV. Add the plugin

Add the plugin's directive aping-flickr="[]" to your apiNG directive and configure your requests

<aping
    template-url="templates/social.html"
    model="social"
    items="20"
    aping-flickr="[{'tags':'berlin'}]">
</aping>

2. USAGE

I. Models

Supported apiNG models

modelcontentsupportmax items<br>per request(native) default items<br>per request
socialimagesfull2020
imageimagesfull2020

support:

II. Requests

Every apiNG plugin expects an array of requests as html attribute.

Requests by User

parametersampledefaultdescriptionoptional
userId67221971@N06A single user ID (Username converter)no
items1020Items per request (0-20)yes
languagede-deThe display language for the feed. Valid values: de-de, en-us, es-us, fr-fr, it-it, ko-kr, pt-br, zh-hkyes

Sample requests:

Requests by Tags

parametersampledefaultdescriptionoptional
tagswood,forestA comma delimited list of tags to filter the feed byno
tagmodeanyallControl whether items must have ALL the tags, or ANY of the tagsyes
items1020Items per request (0-20)yes
languagede-deThe display language for the feed. Valid values: de-de, en-us, es-us, fr-fr, it-it, ko-kr, pt-br, zh-hkyes

Sample requests:

III. Rate limit

Visit the official Flickr API documentation

Licence

MIT