class FlickRaw::Flickr::Favorites

Public Instance Methods

add(:photo_id => 'photo_id') click to toggle source

flickr.favorites.add request.

Adds a photo to a user's favorites list.

Arguments

photo_id (required)

The id of the photo to add to the user's favorites.

Error codes

  • 1: Photo not found

    The photo id passed was not a valid photo id.

  • 2: Photo is owned by you

    The photo belongs to the user and so cannot be added to their favorites.

  • 3: Photo is already in favorites

    The photo is already in the user's list of favorites.

  • 4: User cannot see photo

    The user does not have permission to add the photo to their favorites.

  • 96: Invalid signature

    The passed signature was invalid.

  • 97: Missing signature

    The call required signing but no signature was sent.

  • 98: Login failed / Invalid auth token

    The login details or auth token passed were invalid.

  • 99: User not logged in / Insufficient permissions

    The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions.

  • 100: Invalid API Key

    The API key passed was not valid or has expired.

  • 105: Service currently unavailable

    The requested service is temporarily unavailable.

  • 106: Write operation failed

    The requested operation failed due to a temporary issue.

  • 111: Format “xxx” not found

    The requested response format was not found.

  • 112: Method “xxx” not found

    The requested method was not found.

  • 114: Invalid SOAP envelope

    The SOAP envelope send in the request could not be parsed.

  • 115: Invalid XML-RPC Method Call

    The XML-RPC request document could not be parsed.

  • 116: Bad URL found

    One or more arguments contained a URL that has been used for abuse on Flickr.

# Generated automatically from flickr api
  def add(*args)
    @flickr.call 'flickr.favorites.add', *args
  end
getContext(:photo_id => 'photo_id',:user_id => 'user_id',:num_prev => 'num_prev',:num_next => 'num_next',:extras => 'extras') click to toggle source

flickr.favorites.getContext request.

Returns next and previous favorites for a photo in a user's favorites.

Arguments

photo_id (required)

The id of the photo to fetch the context for.

user_id (required)

The user who counts the photo as a favorite.

num_prev
num_next
extras

A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: description, license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags, o_dims, views, media, path_alias, url_sq, url_t, url_s, url_m, url_z, url_l, url_o

Error codes

  • 1: Photo not found

    The photo id passed was not a valid photo id, or was the id of a photo that the calling user does not have permission to view.

  • 2: User not found

    The specified user was not found.

  • 3: Photo not a favorite

    The specified photo is not a favorite of the specified user.

  • 100: Invalid API Key

    The API key passed was not valid or has expired.

  • 105: Service currently unavailable

    The requested service is temporarily unavailable.

  • 106: Write operation failed

    The requested operation failed due to a temporary issue.

  • 111: Format “xxx” not found

    The requested response format was not found.

  • 112: Method “xxx” not found

    The requested method was not found.

  • 114: Invalid SOAP envelope

    The SOAP envelope send in the request could not be parsed.

  • 115: Invalid XML-RPC Method Call

    The XML-RPC request document could not be parsed.

  • 116: Bad URL found

    One or more arguments contained a URL that has been used for abuse on Flickr.

Returns

3
# Generated automatically from flickr api
  def getContext(*args)
    @flickr.call 'flickr.favorites.getContext', *args
  end
getList(:user_id => 'user_id',:jump_to => 'jump_to',:min_fave_date => 'min_fave_date',:max_fave_date => 'max_fave_date',:get_user_info => 'get_user_info',:extras => 'extras',:per_page => 'per_page',:page => 'page') click to toggle source

flickr.favorites.getList request.

Returns a list of the user's favorite photos. Only photos which the calling user has permission to see are returned.

Arguments

user_id

The NSID of the user to fetch the favorites list for. If this argument is omitted, the favorites list for the calling user is returned.

jump_to
min_fave_date

Minimum date that a photo was favorited on. The date should be in the form of a unix timestamp.

max_fave_date

Maximum date that a photo was favorited on. The date should be in the form of a unix timestamp.

get_user_info

Include info for the user who's favorites are being returned.

extras

A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: description, license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags, o_dims, views, media, path_alias, url_sq, url_t, url_s, url_q, url_m, url_n, url_z, url_c, url_l, url_o

per_page

Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.

page

The page of results to return. If this argument is omitted, it defaults to 1.

Error codes

  • 1: User not found

    The specified user NSID was not a valid flickr user.

  • 96: Invalid signature

    The passed signature was invalid.

  • 97: Missing signature

    The call required signing but no signature was sent.

  • 98: Login failed / Invalid auth token

    The login details or auth token passed were invalid.

  • 99: User not logged in / Insufficient permissions

    The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions.

  • 100: Invalid API Key

    The API key passed was not valid or has expired.

  • 105: Service currently unavailable

    The requested service is temporarily unavailable.

  • 106: Write operation failed

    The requested operation failed due to a temporary issue.

  • 111: Format “xxx” not found

    The requested response format was not found.

  • 112: Method “xxx” not found

    The requested method was not found.

  • 114: Invalid SOAP envelope

    The SOAP envelope send in the request could not be parsed.

  • 115: Invalid XML-RPC Method Call

    The XML-RPC request document could not be parsed.

  • 116: Bad URL found

    One or more arguments contained a URL that has been used for abuse on Flickr.

# Generated automatically from flickr api
  def getList(*args)
    @flickr.call 'flickr.favorites.getList', *args
  end
getPublicList(:user_id => 'user_id',:jump_to => 'jump_to',:min_fave_date => 'min_fave_date',:max_fave_date => 'max_fave_date',:extras => 'extras',:per_page => 'per_page',:page => 'page') click to toggle source

flickr.favorites.getPublicList request.

Returns a list of favorite public photos for the given user.

Arguments

user_id (required)

The user to fetch the favorites list for.

jump_to
min_fave_date

Minimum date that a photo was favorited on. The date should be in the form of a unix timestamp.

max_fave_date

Maximum date that a photo was favorited on. The date should be in the form of a unix timestamp.

extras

A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: description, license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags, o_dims, views, media, path_alias, url_sq, url_t, url_s, url_q, url_m, url_n, url_z, url_c, url_l, url_o

per_page

Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.

page

The page of results to return. If this argument is omitted, it defaults to 1.

Error codes

  • 1: User not found

    The specified user NSID was not a valid flickr user.

  • 100: Invalid API Key

    The API key passed was not valid or has expired.

  • 105: Service currently unavailable

    The requested service is temporarily unavailable.

  • 106: Write operation failed

    The requested operation failed due to a temporary issue.

  • 111: Format “xxx” not found

    The requested response format was not found.

  • 112: Method “xxx” not found

    The requested method was not found.

  • 114: Invalid SOAP envelope

    The SOAP envelope send in the request could not be parsed.

  • 115: Invalid XML-RPC Method Call

    The XML-RPC request document could not be parsed.

  • 116: Bad URL found

    One or more arguments contained a URL that has been used for abuse on Flickr.

# Generated automatically from flickr api
  def getPublicList(*args)
    @flickr.call 'flickr.favorites.getPublicList', *args
  end
remove(:photo_id => 'photo_id',:user_id => 'user_id') click to toggle source

flickr.favorites.remove request.

Removes a photo from a user's favorites list.

Arguments

photo_id (required)

The id of the photo to remove from the user's favorites.

user_id

NSID of the user whose favorites the photo should be removed from. This only works if the calling user owns the photo.

Error codes

  • 1: Photo not in favorites

    The photo id passed was not in the user's favorites.

  • 2: Cannot remove photo from that user's favorites

    user_id was passed as an argument, but photo_id is not owned by the authenticated user.

  • 3: User not found

    Invalid user_id argument.

  • 96: Invalid signature

    The passed signature was invalid.

  • 97: Missing signature

    The call required signing but no signature was sent.

  • 98: Login failed / Invalid auth token

    The login details or auth token passed were invalid.

  • 99: User not logged in / Insufficient permissions

    The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions.

  • 100: Invalid API Key

    The API key passed was not valid or has expired.

  • 105: Service currently unavailable

    The requested service is temporarily unavailable.

  • 106: Write operation failed

    The requested operation failed due to a temporary issue.

  • 111: Format “xxx” not found

    The requested response format was not found.

  • 112: Method “xxx” not found

    The requested method was not found.

  • 114: Invalid SOAP envelope

    The SOAP envelope send in the request could not be parsed.

  • 115: Invalid XML-RPC Method Call

    The XML-RPC request document could not be parsed.

  • 116: Bad URL found

    One or more arguments contained a URL that has been used for abuse on Flickr.

# Generated automatically from flickr api
  def remove(*args)
    @flickr.call 'flickr.favorites.remove', *args
  end