PICO Unreal Platform SDK
UOnlinePicoRoomFunction Class Reference

OnlinePicoRoom Blueprint Function class. More...

#include <Pico_Room.h>

Static Public Member Functions

static void LaunchInvitableUserFlow (UObject *WorldContextObject, const FString &RoomID, FRoomLaunchInvitableUserFlow OnLaunchInvitableUserFlowCallback)
 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 UpdateDataStore (UObject *WorldContextObject, const FString &RoomID, const TMap< FString, FString > &Data, FRoomUpdateDataStore OnUpdateDataStoreCallback)
 Updates the data store of the current room (the caller should be the room owner). More...
 
static void CreateAndJoinPrivate2 (UObject *WorldContextObject, ERoomJoinPolicy JoinPolicy, int32 MaxUsers, FPicoRoomOptions RoomOptions, FRoomCreateAndJoinPrivate2 OnCreateAndJoinPrivate2Callback)
 Creates a new private room and joins it. More...
 
static void Get (UObject *WorldContextObject, const FString &RoomID, FRoomGet OnGetCallback)
 Gets the information about a specified room. More...
 
static void GetCurrent (UObject *WorldContextObject, FRoomGetCurrent OnGetCurrentCallback)
 Gets the data of the room you are currently in. More...
 
static void GetCurrentForUser (UObject *WorldContextObject, const FString &UserId, FRoomGetCurrentForUser OnGetCurrentForUserCallback)
 Gets the current room of the specified user. More...
 
static void GetInvitableUsers2 (UObject *WorldContextObject, FPicoRoomOptions RoomOptions, FRoomGetInvitableUsers2 OnGetInvitableUsers2Callback)
 Gets a list of members the user can invite to the room. These members are drawn from the user's friends list and recently encountered list, and filtered based on relevance and interests. More...
 
static void GetModeratedRooms (UObject *WorldContextObject, int PageIndex, int PageSize, FRoomGetModeratedRooms OnGetModeratedRoomsCallback)
 Gets the list of moderated rooms created for the application. More...
 
static void InviteUser (UObject *WorldContextObject, const FString &RoomID, const FString &Token, FRoomInviteUser OnInviteUserCallback)
 Invites a user to the current room. More...
 
static void Join2 (UObject *WorldContextObject, const FString &RoomID, FPicoRoomOptions RoomOptions, FRoomJoin2 OnJoin2Callback)
 Joins the target room and meanwhile leaves the current room. More...
 
static void KickUser (UObject *WorldContextObject, const FString &RoomID, const FString &UserID, int32 KickDurationSeconds, FRoomKickUser OnKickUserCallback)
 Kicks a user out of a room. For use by homeowners only. More...
 
static void Leave (UObject *WorldContextObject, const FString &RoomID, FRoomLeave OnLeaveCallback)
 Leaves the current room. More...
 
static void SetDescription (UObject *WorldContextObject, const FString &RoomID, const FString &Description, FRoomSetDescription OnSetDescriptionCallback)
 Sets the description of a room. For use by homeowners only. More...
 
static void UpdateMembershipLockStatus (UObject *WorldContextObject, const FString &RoomID, ERoomMembershipLockStatus MembershipLockStatus, FRoomUpdateMembershipLockStatus OnUpdateMembershipLockStatusCallback)
 Locks/unlocks the membership of a room (the caller should be the room owner) to allow/disallow new members from being able to join the room. More...
 
static void UpdateOwner (UObject *WorldContextObject, const FString &RoomID, const FString &UserID, FRoomUpdateOwner OnUpdateOwnerCallback)
 Modifies the owner of the room, this person needs to be the person in this room. More...
 
static void UpdatePrivateRoomJoinPolicy (UObject *WorldContextObject, const FString &RoomID, ERoomJoinPolicy JoinPolicy, FRoomUpdatePrivateRoomJoinPolicy OnUpdatePrivateRoomJoinPolicyCallback)
 Sets the join policy for a specified private room. More...
 

Detailed Description

OnlinePicoRoom Blueprint Function class.