PICO Unreal Platform SDK

Classes

class  UOnlinePicoRoomFunction
 OnlinePicoRoom Blueprint Function class. More...
 
class  UOnlinePicoNotificationFunction
 OnlinePicoRoom Blueprint Function class. More...
 
class  UPico_RoomInviteNotification
 UPico_RoomInviteNotification class. More...
 
class  UPico_RoomInviteNotificationArray
 UPico_RoomInviteNotificationArray class. More...
 

Functions

bool GetRoomInviteNotifications (int PageIdx, int PageSize, FNotificationRoomInviteNotifications OnRoomInviteNotificationsCallback)
 Gets a list of all pending room invites for your app. For example, notifications that may have been sent before the user launches your app. More...
 
bool MarkAsRead (const FString &NotificationID, FNotificationMarkAsRead OnMarkAsReadCallback)
 Marks a notification as read. More...
 
static void GetRoomInviteNotifications (UObject *WorldContextObject, int PageIdx, int PageSize, FNotificationRoomInviteNotifications OnRoomInviteNotificationsCallback)
 Gets a list of all pending room invites for your app. For example, notifications that may have been sent before the user launches your app. More...
 
static void MarkAsRead (UObject *WorldContextObject, const FString &NotificationID, FNotificationMarkAsRead OnMarkAsReadCallback)
 Marks a notification as read. More...
 
FString GetID ()
 Invitation ID.
 
FString GetRoomID ()
 Room ID.
 
FString GetSenderID ()
 Inviter's user ID.
 
FString GetSentTime ()
 The time when the invitation is sent as string.
 
FDateTime GetSentDateTime ()
 The time when the invitation is sent.
 
UPico_RoomInviteNotificationGetElement (int32 Index)
 Get RoomInviteNotificationArray element form Index.
 
int32 GetSize ()
 Get the size of RoomInviteNotificationArray .
 
bool HasNextPage ()
 Get whether the list has the next page.
 

Detailed Description

This is the BP_Room group

Function Documentation

◆ GetRoomInviteNotifications() [1/2]

bool GetRoomInviteNotifications ( int  PageIdx,
int  PageSize,
FNotificationRoomInviteNotifications  OnRoomInviteNotificationsCallback 
)

Gets a list of all pending room invites for your app. For example, notifications that may have been sent before the user launches your app.

Parameters
PageIdxDefines which page of pending room invites to return. The first page index is 0.
PageSizeDefines the number of pending room invites returned on each page.
OnRoomInviteNotificationsCallbackWill be executed when the request has been completed.
Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage, UPico_RoomInviteNotificationArray *, RoomInviteNotificationArray).
Returns
Bool:
  • true: success
  • false: failure


◆ GetRoomInviteNotifications() [2/2]

static void GetRoomInviteNotifications ( UObject *  WorldContextObject,
int  PageIdx,
int  PageSize,
FNotificationRoomInviteNotifications  OnRoomInviteNotificationsCallback 
)
static

Gets a list of all pending room invites for your app. For example, notifications that may have been sent before the user launches your app.

Parameters
WorldContextObjectUsed to get the information about the current world.
PageIdxDefines which page of pending room invites to return. The first page index is 0.
PageSizeDefines the number of pending room invites returned on each page.
OnRoomInviteNotificationsCallbackWill be executed when the request has been completed.
Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage, UPico_RoomInviteNotificationArray *, RoomInviteNotificationArray).

◆ MarkAsRead() [1/2]

bool MarkAsRead ( const FString &  NotificationID,
FNotificationMarkAsRead  OnMarkAsReadCallback 
)

Marks a notification as read.

Parameters
NotificationIDThe ID of the notificaiton to mark.
OnMarkAsReadCallbackWill be executed when the request has been completed.
Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage).
Returns
Bool:
  • true: success
  • false: failure

◆ MarkAsRead() [2/2]

static void MarkAsRead ( UObject *  WorldContextObject,
const FString &  NotificationID,
FNotificationMarkAsRead  OnMarkAsReadCallback 
)
static

Marks a notification as read.

Parameters
WorldContextObjectUsed to get the information about the current world.
NotificationIDThe ID of the notificaiton to mark.
OnMarkAsReadCallbackWill be executed when the request has been completed.
Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage).