Handling a social relationship change

This topic provides example code for handling a social relationship change. In the examples, xboxLiveContext is the XblContextHandle for the signed-in user, state holds your title’s state, and LogToFile is a logging function that your title defines.

Subscribing to relationship changes

You don’t need to subscribe to relationship changes separately. The XBOX Services API (XSAPI) creates or reuses one social Real-Time Activity (RTA) subscription for the context. Relationship-changed handlers and incoming friend request count handlers share it. XSAPI removes the subscription only after you remove all handlers of both types.

XblSocialSubscribeToSocialRelationshipChange and XblSocialUnsubscribeFromSocialRelationshipChange are deprecated and don’t manage the RTA subscription. Remove calls to them from your code as a pair. If your code already created a subscription handle with XblSocialSubscribeToSocialRelationshipChange, release it by calling XblSocialUnsubscribeFromSocialRelationshipChange.

Adding a relationship-changed handler

Flat C API

state.socialRelationshipChangedHandlerToken = XblSocialAddSocialRelationshipChangedHandler(
    xboxLiveContext,
    [](const XblSocialRelationshipChangeEventArgs* args, void* context)
    {
        UNREFERENCED_PARAMETER(context);
        LogToFile("Social relationship changed:");
        std::stringstream ss;
        for (size_t i = 0; i < args->xboxUserIdsCount; ++i)
        {
            if (i > 0) 
            {
                ss << ", ";
            }
            ss << args->xboxUserIds[i];
        }
        LogToFile("socialNotification = %u, affectedXuids = %s", args->socialNotification, ss.str().data());
    },
    nullptr
);

Removing a relationship-changed handler

Flat C API

HRESULT hr = XblSocialRemoveSocialRelationshipChangedHandler(xboxLiveContext, state.socialRelationshipChangedHandlerToken);
state.socialRelationshipChangedHandlerToken = 0;

Handling a change in the number of incoming friend requests

Flat C API

XblFunctionContext friendRequestCountToken{ 0 };
HRESULT hr = XblSocialAddFriendRequestCountChangedHandler(
    xboxLiveContext,
    [](const XblSocialFriendRequestCountChangedEventArgs* args, void* context)
    {
        UNREFERENCED_PARAMETER(context);
        // args is valid only during the callback.
        LogToFile("Incoming friend requests: %zu", args->incomingFriendRequestCount);
    },
    nullptr,
    &friendRequestCountToken
);

if (SUCCEEDED(hr))
{
    // Keep the token until you no longer need notifications.
    state.friendRequestCountToken = friendRequestCountToken;
}

When you no longer need notifications, remove the handler. Remove only a handler that was registered successfully.

if (state.friendRequestCountToken != 0)
{
    HRESULT hr = XblSocialRemoveFriendRequestCountChangedHandler(xboxLiveContext, state.friendRequestCountToken);
    if (SUCCEEDED(hr))
    {
        state.friendRequestCountToken = 0;
    }
}

XBOX Services

PlayFab

Subscribing to relationship changes

Adding a relationship-changed handler

Removing a relationship-changed handler

Handling a change in the number of incoming friend requests

See also

​Subscribing to relationship changes

​Adding a relationship-changed handler

​Removing a relationship-changed handler

​Handling a change in the number of incoming friend requests

​See also

Subscribing to relationship changes

Adding a relationship-changed handler

Removing a relationship-changed handler

Handling a change in the number of incoming friend requests

See also