Profile.setFBML
From Facebook Developer Wiki
Contents |
Description
Facebook will deprecate this method in late 2009/early 2010.
To integrate into the profile, use application tabs. For more information, please read the Developer Roadmap.
Sets the FBML for a user's profile or Facebook Page, including:
- The content for the profile box on the Wall tab
- The profile box for the Boxes tab
You can then prompt a user or Page to add the box or info section to the profile using fb:add-section-button. See the FBML documentation for a description of the markup and its role in various contexts.
The FBML is cached on Facebook's server for that particular user and that particular application. To change it, you must call profile.setFBML through a canvas page or some other script (such as a cron job) that makes use of the Facebook API.
For Web applications, you must pass either the ID of the user or Facebook Page on whose behalf you're making this call or the session key for that user or Facebook Page, but not both. If you don't specify a user with the uid parameter (or Page ID with the fb_page_id parameter), then that user or Page whose session it is will be the target of the call.
However, if your application is a desktop application, you must pass a valid session key for security reasons. Do not pass a uid or fb_page_id parameter.
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. | ||
| optional | session_key | string | The session key of the user whose FBML you are setting. Note: A session key is always required for desktop applications. It is required for Web applications only when the uid is not specified. | |
| 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, sometimes known as "JSONP". This works with both XML and JSON. | ||
| markup | string | Deprecated parameter for a user's profile FBML. | ||
| uid | int | The user ID for the user whose profile you are updating, or the page ID in case of a Page. If this parameter is not specified, then it defaults to the session user. Note: This parameter applies only to Web applications and is required by them only if the session_key is not specified. Facebook returns an error if this parameter is passed by a desktop application. | ||
| profile | string | The FBML intended for the application profile box that appears on the Boxes tab on the user's profile. | ||
| mobile_profile | string | The FBML intended for mobile devices. This parameter has been deprecated. Pass NULL in its place. | ||
| profile_main | string | The FBML intended for the narrow profile box on the Wall and Info tabs of the user's profile. |
Example Requests
Note: You must pass NULL between 'profile' and 'profile_main' to account for the deprecated 'profile_action' and 'mobile_profile' parameters.
Example Return XML
Error Codes
| Code | Description | |
| 1 | An unknown error occurred. Please resubmit the request. | |
|---|---|---|
| 2 | The service is not available at this time. | |
| 3 | Unknown method. The method must be one of those exposed by the API. | |
| 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. | |
| 100 | One of the parameters specified was missing or invalid. | |
| 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. | |
| 240 | The uid cannot be specified from a desktop application. | |
| 330 | The markup was invalid. |
Notes
- This function does not require a
session_key, unless it is being called by a desktop application. - I've had problems with words using umlauts. For example, "müzik". Perhaps encoding them will work - have yet to try that.
