SCUI_Client_ShowFavoriteGamesView()

#include <scoreloop/scui_client.h>
 

SC_Error_t SCUI_Client_ShowFavoriteGamesView(SCUI_Client_h self, SCUI_ViewResultCallback_t callback, void *cookie)

Arguments:

self

An opaque handle for the current SCUI_Client instance.

callback

Callback for UI dismiss notification.

cookie

The cookie passed to the callback.

Library:

libscoreloopcore

Description:

This method displays the favorites games view. The view is shown asynchronously and will automatically capture all user interactions over the whole screen. It allows adding currently played game to be added as top favorite for session user.

When the screen is dismissed, the callback will be called with a respective result.

Before showing the UI there must be a valid session with Scoreloop established, otherwise an error will be returned. Valid session might be also useful to evaluate if current game isn't already a user's favorite one. This can be achieved by calling SC_User_IsFavoriteGame().

Returns:

SC_Error_t A return code (A value of SC_OK indicates success and UI should shortly after appear, any other value indicates an error).