Fbml.setRefHandle
From Facebook Developer Wiki
Contents |
Description
Associates a given "handle" with markup (like FBML or JavaScript) so that the handle can be used within the fb:ref tag. A handle is unique within an application and allows an application to publish content to its canvas pages more quickly because Facebook caches the content set in the fb:ref tag.
Parameters
| Required | Name | Type | Description | |
| required | api_key | string | The application key associated with the calling application. If you specify the API key in your client, you don't need to pass it with every call. | |
|---|---|---|---|---|
| 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. If you specify the call ID in your client, you don't need to pass it with every call. | ||
| sig | string | An MD5 hash of the current request and your secret key, as described in the How Facebook Authenticates Your Application. Facebook computes the signature for you automatically. | ||
| v | string | This must be set to 1.0 to use this version of the API. If you specify the version in your client, you don't need to pass it with every call. | ||
| handle | string | The handle to associate with the given content. | ||
| fbml | string | The content to associate with the given handle. | ||
| 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->call_method('facebook.Fbml.setRefHandle',
array( 'handle' => 'yourHandle',
'fbml' => 'Your content',) );
Example Return XML
<?xml version="1.0" encoding="UTF-8"?>
<fbml_setRefHandle_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_setRefHandle_response>
Error Codes
For a complete list of error codes, see Error codes.
| Code | Description | |
| 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. | |
| 700 | Unknown failure in storing ref data. Please try again. |
Notes
- Desktop applications cannot call this method, as the method allows for configuring the application itself.
- This method no longer requires a
session_key. If you receive a session key error code, please check your request to make sure you're not inadvertently sending a session key, since if you do send this parameter, we require that it is valid.
