Fbml.refreshImgSrc

From Facebook Developer Wiki

Jump to: navigation, search

Contents

Description

Fetches and re-caches the image stored at the given URL, for use in images published to non-canvas pages via the API (for example, to user profiles via profile.setFBML, or to News Feed via feed.publishUserAction). See the FBML documentation for a description of the markup and its role in various contexts. Further, see UsageNotes/Images for more information on how Facebook handles images.

Note: Despite our previous announcement, this function is no longer going to be deprecated.

Parameters

RequiredNameTypeDescription
required api_key string The application key associated with the calling application.
call_id float The request's sequence number. Each successive call for any session must use a sequence number greater than the last. We suggest using the current time in milliseconds, such as PHP's microtime(true) function.
sig string An MD5 hash of the current request and your secret key, as described in the How Facebook Authenticates Your Application.
v string This must be set to 1.0 to use this version of the API.
url string The absolute URL from which to refresh the image.
optional format string The desired response format, which can be either XML or JSON. (Default value is XML.)
callback string Name of a function to call. This is primarily to enable cross-domain JavaScript requests using the <script> tag, also known as JSONP, and works with both the XML and JSON formats. The function will be called with the response passed as the parameter.

Example Requests

//PHP EXAMPLE: $facebook->api_client->fbml_refreshImgSrc(IMAGE_URL_HERE);

Response

This method returns 1 (true) if Facebook found a cached version of your image and successfully refreshed the image. It returns a blank response if Facebook was unable to find any previously cached version to refresh, or the image was unable to be re-fetched from your site and cached successfully. In such instances, whatever images were cached before remain as they were cached.

Example Return XML

<?xml version="1.0" encoding="UTF-8"?> <fbml_refreshImgSrc_response xmlns="http://api.facebook.com/1.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://api.facebook.com/1.0/ http://api.facebook.com/1.0/facebook.xsd"> 1 </fbml_refreshImgSrc_response>

Error Codes

CodeDescription
1 An unknown error occurred. Please resubmit the request.
2 The service is not available at this time.
4 The application has reached the maximum number of requests allowed. More requests are allowed once the time window has completed.
5 The request came from a remote address not allowed by this application.
101 The API key submitted is not associated with any known application.
102 The session key was improperly submitted or has reached its timeout. Direct the user to log in again to obtain another key.
103 The submitted call_id was not greater than the previous call_id for this session.
104 Incorrect signature.

Notes

  • This method no longer requires a session_key.
Retrieved from "http://wiki.developers.facebook.com/index.php/Fbml.refreshImgSrc"
reference