FPicoRoomInterface Class Reference

PicoRoomInterface class. More...

#include <Pico_Room.h>

Public Member Functions
bool	LaunchInvitableUserFlow (const FString &RoomID, FRoomLaunchInvitableUserFlow OnLaunchInvitableUserFlowCallback)
	Launches the invitation flow to let the current user invite friends to a specified room. This launches the system default invite UI where the user can select friends to invite and then send invitations to them. Therefore, this is a shortcut if you do not want to build the invite UI by yourself. More...
bool	UpdateDataStore (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...
bool	CreateAndJoinPrivate2 (ERoomJoinPolicy JoinPolicy, uint32 MaxUsers, FPicoRoomOptions RoomOptions, FRoomCreateAndJoinPrivate2 OnCreateAndJoinPrivate2Callback)
	Creates a new private room and joins it. More...
bool	Get (const FString &RoomID, FRoomGet OnGetCallback)
	Gets the information about a specified room. More...
bool	GetCurrent (FRoomGetCurrent OnGetCurrentCallback)
	Gets the data of the room you are currently in. More...
bool	GetCurrentForUser (const FString &UserId, FRoomGetCurrentForUser OnGetCurrentForUserCallback)
	Gets the current room of the specified user. More...
bool	GetInvitableUsers2 (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...
bool	GetModeratedRooms (int PageIndex, int PageSize, FRoomGetModeratedRooms OnGetModeratedRoomsCallback)
	Gets the list of moderated rooms created for the application. More...
bool	InviteUser (const FString &RoomID, const FString &Token, FRoomInviteUser OnInviteUserCallback)
	Invites a user to the current room. More...
bool	Join2 (const FString &RoomID, FPicoRoomOptions options, FRoomJoin2 OnJoin2Callback)
	Joins the target room and meanwhile leaves the current room. More...
bool	KickUser (const FString &RoomID, const FString &UserID, int KickDurationSeconds, FRoomKickUser OnKickUserCallback)
	Kicks a user out of a room. For use by homeowners only. More...
bool	Leave (const FString &RoomID, FRoomLeave OnLeaveCallback)
	Leaves the current room. More...
bool	SetDescription (const FString &RoomID, const FString &Description, FRoomSetDescription OnSetDescriptionCallback)
	Sets the description of a room. For use by homeowners only. More...
bool	UpdateMembershipLockStatus (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...
bool	UpdateOwner (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...
bool	UpdatePrivateRoomJoinPolicy (const FString &RoomID, ERoomJoinPolicy JoinPolicy, FRoomUpdatePrivateRoomJoinPolicy OnUpdatePrivateRoomJoinPolicyCallback)
	Sets the join policy for a specified private room. More...

Detailed Description

PicoRoomInterface class.