kafe.ext.flickr

Class

Version 1.1.0

Extra methods for the Flickr API.

Source: dist/ext/flickr.js

Properties

PRIVACY_FAMILY

Number

Private photos visible to family

PRIVACY_FRIENDS

Number

Private photos visible to friends

PRIVACY_FRIENDS_FAMILY

Number

Private photos visible to friends & family

PRIVACY_PRIVATE

Number

Completely private photos

PRIVACY_PUBLIC

Number

Public photos

Methods

api.photos_search

Search photos (direct call to API method flickr.photos.search)

api.photos_search
  • options
  • callback

Parameters:

  • [options] Object Optional

    Options

  • callback Function

    Callback

api.photosets_getList

Get the photosets (direct call to API method flickr.photosets.getList)

api.photosets_getList
  • options
  • callback

Parameters:

  • [options] Object Optional

    Options

  • callback Function

    Callback

api.photosets_getPhotos

Get the list of photos in a set (direct call to API method flickr.photosets.getPhotos)

api.photosets_getPhotos
  • options
  • callback

Parameters:

  • [options] Object Optional

    Options

  • callback Function

    Callback

getBgImageStyles

Get a optimized background styles for a photo

getBgImageStyles
  • photo
  • options
Object

Parameters:

  • photo Object

    Photo object from Flickr API

  • [options] Object Optional

    Options

    • [maxWidth] Number Optional

      Maximum width

    • [maxHeight] Number Optional

      Maximum height

Returns:

Object

CSS attributes to apply

getImgElement

Get a optimized tag for a photo

getImgElement
  • photo
  • options
  • attributes
String

Parameters:

  • photo Object

    Photo object from Flickr API

  • [options] Object Optional

    Options

    • [maxWidth] Number Optional

      Maximum width

    • [maxHeight] Number Optional

      Maximum height

    • [centered = false] Boolean Optional

      Center image

    • [link] Object Optional

      Link HTML attributes

  • [attributes] Object Optional

    HTML attributes to apply to <img> tag

Returns:

String

HTML markup for image

getOptimizedSize

Get optimized size (optSize) for a photo.

getOptimizedSize
  • photo
  • options
Object

Parameters:

  • photo Object

    Photo object from Flickr API

  • [options] Object Optional

    Options

    • [maxWidth] Number Optional

      Maximum width

    • [maxHeight] Number Optional

      Maximum height

    • [doResize = false] Boolean Optional

      Resize to fit

    • [asBgImg = false] Boolean Optional

      Is it to be used as a background style

Returns:

Object

A Flickr API photo object

getPhotos

Get photos.

getPhotos
  • options
  • callback
Object

Parameters:

  • [options] Object Optional

    Options

  • callback Function

    Callback

Returns:

Object

A Flickr API photo collection

getPhotosetCover

Get a photoset cover.

getPhotosetCover
  • photoset
  • callback
Object

Parameters:

  • photoset Object

    Photoset

    • id Object

      Photoset id

    • primary Object

      Primary photo id

  • callback Function

    Callback

Returns:

Object

A Flickr API photo object

getPhotosets

Get photosets for specific user.

getPhotosets
  • options
  • callback
Object

Parameters:

  • [options] Object Optional

    Options

  • callback Function

    Callback

Returns:

Object

A Flickr API photo collection

getPhotostream

Get photostream.

getPhotostream
  • options
  • callback
Object

Parameters:

  • [options] Object Optional

    Options

  • callback Function

    Callback

Returns:

Object

A Flickr API photo collection

setParams

Set default Flickr params.

setParams
  • options

Parameters:

  • options Object

    Options

    • api_key String

      API key

    • [media = 'photos'] Boolean Optional

      Media type. Possible values are all, photos, videos

    • [privacy_filter = PRIVACY_PUBLIC] Boolean Optional

      Privacy supported. Possible values are flickr.PRIVACY_*

    • [sort = 'date-posted-desc'] Boolean Optional

      Sort order. Possible values are date-posted-asc, date-posted-desc, date-taken-asc, date-taken-desc, interestingness-desc, interestingness-asc, relevance

    • [page = 1] String Optional

      Page number start

    • [per_page = 10] Function Optional

      Number of element per page

    • [extras = BASIC_FIELDS] Extra fields to fetch. More on the [Flickr API] Array(String) Optional

      (http://www.flickr.com/services/api/)