Data.defineObjectProperty
From Facebook Developer Wiki
Note: Support for this method is temporarily disabled until we support user-level permissions. You can still make this call, but you must include your application secret.
Add a new object property to an object type.
Contents |
Parameters
| Type | Name | Description |
|---|---|---|
| string | api_key | The application key associated with the calling application. |
| string | session_key | The session key of the logged in user. |
| float | call_id | 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. |
| string | sig | An MD5 hash of the current request and your secret key, as described in the authentication guide. |
| string | v | This must be set to 1.0 to use this version of the API. |
| string | format | Optional - desired response format. Either "XML" (default) or "JSON". |
| string | callback | Optional - wrap the response inside a function 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. |
| string | obj_type | Object type to add a new property to. |
| string | prop_name | Name of the new property to add. This name needs to be a valid identifier, which is no longer than 32 characters, starting with a letter (a-z) and consisting of only small letters (a-z), numbers (0-9) and/or underscores. |
| integer | prop_type | Type of the new property:
|
Return Value
Returns 1 on success, error otherwise.
PHP Client Coding Examples
<?php
$facebook = new Facebook($key,$secret);
$typ = foo_get_type();
$facebook->api_client->call_method('facebook.data.defineObjectProperty', array('obj_type'=>$typ, 'prop_name'=>'newProp', 'prop_type'=>2 ));
// we can set 'prop_type' to 1, 2 or 3 for other data types
unset($facebook);
?>
FQL Equivalent
(none)
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. |
| 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. |
| 200 | Permission denied. Calling application or user doesn't have enough permissions to perform the action. |
| 800 | Internal error. Please report this to Facebook when getting this error. |
| 801 | Invalid operation error. This operation is not allowed. |
| 802 | Quota exceeded. Certain maximum number allocated for an application or a user is exceeded. |
| 804 | Object already exists on server. |
| 805 | A temporary database failure happened. Usually this can be corrected by a re-try. |
