PICO Unreal Platform SDK
Public Member Functions | List of all members
FPicoUserInterface Class Reference
Function » User

PicoUserInterface class. More...

#include <Pico_User.h>

Public Member Functions

bool GetLoginUser (FGetLoginUser InGetLoginUserDelegate)
 Gets the information about the current logged-in user. More...
 
bool GetUserInfo (const FString &UserId, FGetUserInfo InGetUserInfoDelegate)
 Gets the information by user ID. More...
 
bool GetLoggedInUserAndRoom (FGetLoggedInUserFriendsAndRooms OnGetLoggedInuserFriendsAndRoomsCallback)
 Gets the friends of the logged-in user and the rooms the friends might be in. If a friend is not in any room, the 'room' field will be null. More...
 
bool GetNextUserAndRoomArrayPage (UPico_UserAndRoomArray *InUserAndRoomArray, FGetNextUserAndRoomArrayPage OnGetNextUserAndRoomArrayPageCallback)
 Gets the friend list of the current user. More...
 
bool GetUserFriends (FGetLoggedInUserFriends OnGetLoggedInUserFriendsCallback)
 Gets the friend list of the current user. Friends who don't use this app won't appear in this list. More...
 
bool GetNextUserPage (UPico_UserArray *InUserArray, FGetNextUserPage OnGetNextUserPageCallback)
 Gets the next page of user list. More...
 
bool GetAuthorizePermissions (FGetPermissionResult OnGetPermissionResultCallback)
 Gets the authorized permissions. More...
 
bool RequestUserPermissions (TArray< FString > Permissions, FGetPermissionResult OnGetPermissionResultCallback)
 Requests user permissions. The user will received a pop-up notification window. More...
 

Detailed Description

PicoUserInterface class.

Member Function Documentation

◆ GetAuthorizePermissions()

bool GetAuthorizePermissions ( FGetPermissionResult  OnGetPermissionResultCallback)

Gets the authorized permissions.

Parameters
OnGetPermissionResultCallbackWill be executed when the request has been completed. Delegate will contain the requested object class.
Returns
Bool:
  • true: success
  • false: failure


◆ GetLoggedInUserAndRoom()

bool GetLoggedInUserAndRoom ( FGetLoggedInUserFriendsAndRooms  OnGetLoggedInuserFriendsAndRoomsCallback)

Gets the friends of the logged-in user and the rooms the friends might be in. If a friend is not in any room, the 'room' field will be null.

Parameters
OnGetLoggedInuserFriendsAndRoomsCallbackWill be executed when the request has been completed. Delegate will contain the requested object class.
Returns
Bool:
  • true: success
  • false: failure


◆ GetLoginUser()

bool GetLoginUser ( FGetLoginUser  InGetLoginUserDelegate)

Gets the information about the current logged-in user.

Parameters
InGetLoginUserDelegateWill be executed when the request has been completed. Delegate will contain the requested object class.
Returns
Bool:
  • true: success
  • false: failure


◆ GetNextUserAndRoomArrayPage()

bool GetNextUserAndRoomArrayPage ( UPico_UserAndRoomArray *  InUserAndRoomArray,
FGetNextUserAndRoomArrayPage  OnGetNextUserAndRoomArrayPageCallback 
)

Gets the friend list of the current user.

Parameters
InUserAndRoomArrayThe current object of user and room array.
OnGetNextUserAndRoomArrayPageCallbackWill be executed when the request has been completed. Delegate will contain the requested object class.
Returns
Bool:
  • true: success
  • false: failure


◆ GetNextUserPage()

bool GetNextUserPage ( UPico_UserArray *  InUserArray,
FGetNextUserPage  OnGetNextUserPageCallback 
)

Gets the next page of user list.

Parameters
InUserArrayThe current object of the user array.
OnGetNextUserPageCallbackWill be executed when the request has been completed. Delegate will contain the requested object class.
Returns
Bool:
  • true: success
  • false: failure


◆ GetUserFriends()

bool GetUserFriends ( FGetLoggedInUserFriends  OnGetLoggedInUserFriendsCallback)

Gets the friend list of the current user. Friends who don't use this app won't appear in this list.

Parameters
OnGetLoggedInUserFriendsCallbackWill be executed when the request has been completed. Delegate will contain the requested object class.
Returns
Bool:
  • true: success
  • false: failure


◆ GetUserInfo()

bool GetUserInfo ( const FString &  UserId,
FGetUserInfo  InGetUserInfoDelegate 
)

Gets the information by user ID.

Parameters
UserIdThe ID of the user.


Parameters
InGetUserInfoDelegateWill be executed when the request has been completed. Delegate will contain the requested object class.
Returns
Bool:
  • true: success
  • false: failure


◆ RequestUserPermissions()

bool RequestUserPermissions ( TArray< FString >  Permissions,
FGetPermissionResult  OnGetPermissionResultCallback 
)

Requests user permissions. The user will received a pop-up notification window.

Parameters
PermissionsWill be executed when the request has been completed. Delegate will contain the requested object class.
  • user_info: The permission to get the user's basic information, such as the user's nickname and profile picture.
  • friend_relation: The permission to get the user's friend list and invitable users.
  • sports_userinfo: The permission to get the user's information set in the sport center.
  • sports_summarydata: The permission to get a summary of the user's exercise data.
OnGetPermissionResultCallbackWill be executed when the request has been completed. Delegate will contain the requested object class.
Returns
Bool:
  • true: success
  • false: failure