Admin.getAppProperties
From Facebook Developers Wiki
This API call is currently in Beta.
Contents |
[edit] Description
Gets property values previously set for an application on either the Facebook Developer application or the with the admin.setAppProperties call.
[edit] Parameters
| Required | Name | Type | Description | |
| required | api_key | string | The application key associated with the calling application. | |
|---|---|---|---|---|
| sig | string | An MD5 hash of the current request and your secret key, as described in the authentication guide. | ||
| v | string | This must be set to 1.0 to use this version of the API. | ||
| optional | format | string | Desired response format. Either XML (default) or JSON. | |
| 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. | ||
| required | properties | json array | A list of property names that you want to view. This list is described on ApplicationProperties. |
[edit] Example Request
| This is using the PHP library $arr = $facebook->api_client->admin_getAppProperties(array('application_name','callback_url','ip_list')) |
[edit] Example Return XML
| <?xml version="1.0" encoding="UTF-8"?> <admin_getAppProperties_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"> [{"application_name": "Trunc"}, {"dev_mode": 0}] </admin_getAppProperties_response> |
[edit] Response
This method returns the app properties as a JSON encoded map from property name to value.
[edit] 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. | |
| 104 | Incorrect signature. |
[edit] Notes
- This function does not require a
session_keyorcall_id. - Desktop applications cannot call this method, as the method allows for configuring the application itself.
