EOS API reference page for EOS_Friends_AddNotifyFriendsUpdate

This function is part of the Friends Interface.


Listen for changes to friends for a particular account.

Return Value

A valid notification ID if successfully bound, or EOS_INVALID_NOTIFICATIONID otherwise


Parameter Type And Name

Usage Information

EOS_HFriends Handle

const EOS_Friends_AddNotifyFriendsUpdateOptions* Options

Information about who would like notifications.

void* ClientData

This value is returned to the caller when FriendsUpdateHandler is invoked.

const EOS_Friends_OnFriendsUpdateCallback FriendsUpdateHandler

The callback to be invoked when a change to any friend status changes.

This function enables your callback (the FriendsUpdateHandler parameter) to respond to events that happen on the back-end service. Remember to remove your callback function when it is no longer needed.

Callback Function Information

Because this function is asynchronous, it employs a callback of type EOS_Friends_OnFriendsUpdateCallback to report the results of its operation.

Callback Remarks

Callback for information related to a friend status update.

Callback Parameters

Parameter Type And Name

Usage Information

const EOS_Friends_OnFriendsUpdateInfo* Data

Related API Members