Vp friend delete: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m Added reference number attribute |
||
| Line 4: | Line 4: | ||
{{sdk parameter row|int|friend_user_id|User id of user to delete}} | {{sdk parameter row|int|friend_user_id|User id of user to delete}} | ||
|attributes= | |attributes= | ||
{{sdk attribute row|int |reference_number |Is passed to the callback to identify for which method call it is fired}} | |||
|returncodes= | |returncodes= | ||
{{sdk return code row|not_in_universe|Universe request made while not connected to a universe server}} | {{sdk return code row|not_in_universe|Universe request made while not connected to a universe server}} | ||
Latest revision as of 23:24, 31 July 2018
Method call snippet
vp_friend_delete(instance, friend_user_id);Delete a user from the friend list.
Parameters
These are the parameters that this method requires:
| Parameter | Usage |
|---|---|
VPInstance instance |
Pointer to the instance this method call is intended for |
int friend_user_id |
User id of user to delete |
Used attributes
This method uses data set in these attributes when called:
| Attribute | Usage | |
|---|---|---|
| VP_REFERENCE_NUMBER | Is passed to the callback to identify for which method call it is fired |
Returns
This method returns a return code integer, which indicates whether the call was successful or errored for any reason:
| Return code | Cause |
|---|---|
VP_RC_SUCCESS |
Successful call (for methods that have a registered callback, it only means the request has been sent) |
VP_RC_NOT_IN_UNIVERSE |
Universe request made while not connected to a universe server |
Behavior
- There is no special behavior for this method
Examples
- This method has no usage examples; please add at least one to this page