PICO Unreal Platform SDK
UOnlinePicoUserFunction Class Reference

OnlinePicoUser Blueprint Function class. More...

#include <Pico_User.h>

Static Public Member Functions

static void PicoGetLoggedInUserAndRoom (UObject *WorldContextObject, FGetLoggedInUserFriendsAndRooms InGetLoggedInuserFriendsAndRoomsCallback)
 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...
 
static void PicoGetNextUserAndRoomArrayPage (UObject *WorldContextObject, UPico_UserAndRoomArray *InUserAndRoomArray, FGetNextUserAndRoomArrayPage InGetNextUserAndRoomArrayPageCallback)
 Gets the friend list of the current user. More...
 
static void PicoGetUserFriends (UObject *WorldContextObject, FGetLoggedInUserFriends InGetLoggedInUserFriendsDelegate)
 Gets the friend list of the current user. Friends who don't use this app won't appear in this list. More...
 
static void PicoGetNextUserPage (UObject *WorldContextObject, UPico_UserArray *InUserArray, FGetNextUserPage InGetNextUserPageDelegate)
 Gets the next page of a user list. More...
 
static bool GetLoginUser (UObject *WorldContextObject, FGetLoginUser InGetLoginUserDelegate)
 Gets the information about the current logged-in user. More...
 
static bool GetPicoUserInfo (UObject *WorldContextObject, const FString &UserId, FGetUserInfo InGetUserInfoDelegate)
 Gets user information by user ID. More...
 
static bool GetAuthorizePermissions (UObject *WorldContextObject, FGetPermissionResult OnGetPermissionResultCallback)
 Gets the authorized permissions. More...
 
static bool RequestUserPermissions (UObject *WorldContextObject, TArray< FString > Permissions, FGetPermissionResult OnGetPermissionResultCallback)
 Requests user permissions. The user will received a pop-up notification window. More...
 

Detailed Description

OnlinePicoUser Blueprint Function class.

Member Function Documentation

◆ GetAuthorizePermissions()

static bool GetAuthorizePermissions ( UObject *  WorldContextObject,
FGetPermissionResult  OnGetPermissionResultCallback 
)
static

Gets the authorized permissions.

Parameters
WorldContextObjectUsed to get the information about the current world.
OnGetPermissionResultCallbackWill be executed when the request has been completed. Delegate will contain the requested object class.
Returns
Bool:
  • true: success
  • false: failure


◆ GetLoginUser()

static bool GetLoginUser ( UObject *  WorldContextObject,
FGetLoginUser  InGetLoginUserDelegate 
)
static

Gets the information about the current logged-in user.

Parameters
WorldContextObjectUsed to get the information about the current world.
InGetLoginUserDelegateWill be executed when the request has been completed. Delegate will contain the requested object class.
Returns
Bool:
  • true: success
  • false: failure


◆ GetPicoUserInfo()

static bool GetPicoUserInfo ( UObject *  WorldContextObject,
const FString &  UserId,
FGetUserInfo  InGetUserInfoDelegate 
)
static

Gets user information by user ID.

Parameters
WorldContextObjectUsed to get the information about the current world.
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


◆ PicoGetLoggedInUserAndRoom()

static void PicoGetLoggedInUserAndRoom ( UObject *  WorldContextObject,
FGetLoggedInUserFriendsAndRooms  InGetLoggedInuserFriendsAndRoomsCallback 
)
static

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
WorldContextObjectUsed to get the information about the current world.
InGetLoggedInuserFriendsAndRoomsCallbackWill be executed when the request has been completed. Delegate will contain the requested object class.
Returns
Bool:
  • true: success
  • false: failure


◆ PicoGetNextUserAndRoomArrayPage()

static void PicoGetNextUserAndRoomArrayPage ( UObject *  WorldContextObject,
UPico_UserAndRoomArray *  InUserAndRoomArray,
FGetNextUserAndRoomArrayPage  InGetNextUserAndRoomArrayPageCallback 
)
static

Gets the friend list of the current user.

Parameters
WorldContextObjectUsed to get the information about the current world.
InUserAndRoomArrayThe current object of user and room array.


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


◆ PicoGetNextUserPage()

static void PicoGetNextUserPage ( UObject *  WorldContextObject,
UPico_UserArray *  InUserArray,
FGetNextUserPage  InGetNextUserPageDelegate 
)
static

Gets the next page of a user list.

Parameters
WorldContextObjectUsed to get the information about the current world.
InUserArrayThe current object of user array.


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


◆ PicoGetUserFriends()

static void PicoGetUserFriends ( UObject *  WorldContextObject,
FGetLoggedInUserFriends  InGetLoggedInUserFriendsDelegate 
)
static

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

Parameters
WorldContextObjectUsed to get the information about the current world.
InGetLoggedInUserFriendsDelegateWill be executed when the request has been completed. Delegate will contain the requested object class.
Returns
Bool:
  • true: success
  • false: failure


◆ RequestUserPermissions()

static bool RequestUserPermissions ( UObject *  WorldContextObject,
TArray< FString >  Permissions,
FGetPermissionResult  OnGetPermissionResultCallback 
)
static

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

Parameters
WorldContextObjectUsed to get the information about the current world.
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