Data.setHashValue

From Facebook Developers Wiki

Jump to: navigation, search

Set a property value by a hash key.

Contents

[edit] 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's type. This is required so that different object types can use the same hash keys for different objects.
string key Hash key. This is a unique string chosen by the user that can be used to refer to the object in subsequent function calls.
string value Property's value to set. If the hash key exists, this will overwrite any previous value.
string prop_name Name of the property to set.

[edit] Return Value

64-bit integer: Numeric identifier (fbid) of the object.

[edit] PHP Client Coding Examples

$fbid2 = $api_client->data_setHashValue("global","junky","23","day");
echo "We just created an object of type 'global' with fbid $fbid2 and set day to 23.<br /><br />";

$day = $api_client->data_getHashValue('global','junky','day');
echo "Get object by hash.  Day=$day".".<br /><br />";

$api_client->data_setHashValue("global","junky","7","day");
echo "We just changed the value of day in object $fbid2".".<br />";

$array2 = $api_client->data_getObject($fbid2,array('day'));
echo "Contents of object $fbid2, showing the new value of day.<pre>";
print_r($array2);

Output:

We just created an object of type 'global' with fbid 10 and set day to 23.

Get object by hash. Day=23.

We just changed the value of day in object 10. Contents of object 10, showing the new value of day. 

Array
(
    [0] => 7
)

[edit] FQL Equivalent

(none)

[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.
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.
805 A temporary database failure happened. Usually this can be corrected by a re-try.
Retrieved from "http://wiki.developers.facebook.com/index.php/Data.setHashValue"