Classes
class	UOnlinePicoRoomFunction
	OnlinePicoRoom Blueprint Function class. More...

class	UOnlinePicoNotificationFunction
	OnlinePicoRoom Blueprint Function class. More...

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...

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...

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...

Detailed Description

This is the BP_Room group

Function Documentation

◆ CreateAndJoinPrivate2() [1/2]

bool CreateAndJoinPrivate2	(	ERoomJoinPolicy	JoinPolicy,
		uint32	MaxUsers,
		FPicoRoomOptions	RoomOptions,
		FRoomCreateAndJoinPrivate2	OnCreateAndJoinPrivate2Callback
	)

Creates a new private room and joins it.

Note: This type of room can be obtained by querying the room where a friend is, so it is suitable for playing with friends.

Parameters

JoinPolicy	Specifies who can join the room: `0`: nobody `1`: everybody `2`: friends of members `3`: friends of the room owner `4`: invited users `5`: unknown
MaxUsers	The maximum number of members allowed in the room, including the room creator.
RoomOptions	Room configuration for this request.
OnCreateAndJoinPrivate2Callback	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

true: success
false: failure

◆ CreateAndJoinPrivate2() [2/2]

static void CreateAndJoinPrivate2	(	UObject *	WorldContextObject,
		ERoomJoinPolicy	JoinPolicy,
		int32	MaxUsers,
		FPicoRoomOptions	RoomOptions,
		FRoomCreateAndJoinPrivate2	OnCreateAndJoinPrivate2Callback
	)

static

Creates a new private room and joins it.

Note: This type of room can be obtained by querying the room where a friend is, so it is suitable for playing with friends.

Parameters

WorldContextObject	Used to get the information about the current world.
JoinPolicy	Specifies who can join the room: `0`: nobody `1`: everybody `2`: friends of members `3`: friends of the room owner `4`: invited users `5`: unknown
MaxUsers	The maximum number of members allowed in the room, including the room creator.
RoomOptions	Room configuration for this request.
OnCreateAndJoinPrivate2Callback	Will be executed when the request has been completed. Delegate will contain the requested object class.

◆ Get() [1/2]

bool Get	(	const FString &	RoomID,
		FRoomGet	OnGetCallback
	)

Gets the information about a specified room.

Parameters

RoomID	The ID of the room to get information for.
OnGetCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

true: success
false: failure

◆ Get() [2/2]

static void Get	(	UObject *	WorldContextObject,
		const FString &	RoomID,
		FRoomGet	OnGetCallback
	)

static

Gets the information about a specified room.

Parameters

WorldContextObject	Used to get the information about the current world.
RoomID	The ID of the room to get information for.
OnGetCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

◆ GetCurrent() [1/2]

bool GetCurrent ( FRoomGetCurrent OnGetCurrentCallback )

Gets the data of the room you are currently in.

Parameters

OnGetCurrentCallback Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

true: success
false: failure

◆ GetCurrent() [2/2]

static void GetCurrent	(	UObject *	WorldContextObject,
		FRoomGetCurrent	OnGetCurrentCallback
	)

static

Gets the data of the room you are currently in.

Parameters

WorldContextObject	Used to get the information about the current world.
OnGetCurrentCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

◆ GetCurrentForUser() [1/2]

bool GetCurrentForUser	(	const FString &	UserId,
		FRoomGetCurrentForUser	OnGetCurrentForUserCallback
	)

Gets the current room of the specified user.

Note: The user's privacy settings may not allow you to access their room.

Parameters

UserId	The ID of the user.
OnGetCurrentForUserCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

true: success
false: failure

◆ GetCurrentForUser() [2/2]

static void GetCurrentForUser	(	UObject *	WorldContextObject,
		const FString &	UserId,
		FRoomGetCurrentForUser	OnGetCurrentForUserCallback
	)

static

Gets the current room of the specified user.

Note: The user's privacy settings may not allow you to access their room.

Parameters

WorldContextObject	Used to get the information about the current world.
UserId	The ID of the user.
OnGetCurrentForUserCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

◆ GetInvitableUsers2() [1/2]

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.

Parameters

roomOptions	Additional configuration for this request. If you pass `null`, the response will return code `0`.
OnGetInvitableUsers2Callback	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

true: success
false: failure

◆ GetInvitableUsers2() [2/2]

static void GetInvitableUsers2	(	UObject *	WorldContextObject,
		FPicoRoomOptions	RoomOptions,
		FRoomGetInvitableUsers2	OnGetInvitableUsers2Callback
	)

static

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.

Parameters

WorldContextObject	Used to get the information about the current world.
RoomOptions	Additional configuration for this request. If you pass `null`, the response will return code `0`.
OnGetInvitableUsers2Callback	Will be executed when the request has been completed. Delegate will contain the requested object class.

◆ GetModeratedRooms() [1/2]

bool GetModeratedRooms	(	int	PageIndex,
		int	PageSize,
		FRoomGetModeratedRooms	OnGetModeratedRoomsCallback
	)

Gets the list of moderated rooms created for the application.

Parameters

index	Start page index.
size	Page entry number in response (should range from `5` to `20`).
OnGetModeratedRoomsCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

true: success
false: failure

◆ GetModeratedRooms() [2/2]

static void GetModeratedRooms	(	UObject *	WorldContextObject,
		int	PageIndex,
		int	PageSize,
		FRoomGetModeratedRooms	OnGetModeratedRoomsCallback
	)

static

Gets the list of moderated rooms created for the application.

Parameters

WorldContextObject	Used to get the information about the current world.
PageIndex	Start page index.
PageSize	Page entry number in response (should range from `5` to `20`).
OnGetModeratedRoomsCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

◆ 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

PageIdx	Defines which page of pending room invites to return. The first page index is `0`.
PageSize	Defines the number of pending room invites returned on each page.
OnRoomInviteNotificationsCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

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

WorldContextObject	Used to get the information about the current world.
PageIdx	Defines which page of pending room invites to return. The first page index is `0`.
PageSize	Defines the number of pending room invites returned on each page.
OnRoomInviteNotificationsCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

◆ InviteUser() [1/2]

bool InviteUser	(	const FString &	RoomID,
		const FString &	Token,
		FRoomInviteUser	OnInviteUserCallback
	)

Invites a user to the current room.

Note: The user invited will receive a notification of type MessageType.Notification_Room_InviteReceived.

Parameters

roomId	The ID of the room.
token	The user's invitation token, which is returned by `RoomService.GetInvitableUsers2()`.
OnInviteUserCallback	Will be executed when the request has been completed. Delegate will contain the requested info.

Returns

Bool:

true: success
false: failure

◆ InviteUser() [2/2]

static void InviteUser	(	UObject *	WorldContextObject,
		const FString &	RoomID,
		const FString &	Token,
		FRoomInviteUser	OnInviteUserCallback
	)

static

Invites a user to the current room.

Note: The user invited will receive a notification of type MessageType.Notification_Room_InviteReceived.

Parameters

WorldContextObject	Used to get the information about the current world.
RoomID	The ID of the room.
Token	The user's invitation token, which is returned by `RoomService.GetInvitableUsers2()`.
OnInviteUserCallback	Will be executed when the request has been completed. Delegate will contain the requested info.

◆ Join2() [1/2]

bool Join2	(	const FString &	RoomID,
		FPicoRoomOptions	options,
		FRoomJoin2	OnJoin2Callback
	)

Joins the target room and meanwhile leaves the current room.

Parameters

RoomID	The ID of the room to join.
options	(Optional) Additional room configuration for this request.
OnJoin2Callback	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

true: success
false: failure

◆ Join2() [2/2]

static void Join2	(	UObject *	WorldContextObject,
		const FString &	RoomID,
		FPicoRoomOptions	RoomOptions,
		FRoomJoin2	OnJoin2Callback
	)

static

Joins the target room and meanwhile leaves the current room.

Parameters

WorldContextObject	Used to get the information about the current world.
RoomID	The ID of the room to join.
RoomOptions	(Optional) Additional room configuration for this request.
OnJoin2Callback	Will be executed when the request has been completed. Delegate will contain the requested object class.

◆ KickUser() [1/2]

bool KickUser	(	const FString &	RoomID,
		const FString &	UserID,
		int	KickDurationSeconds,
		FRoomKickUser	OnKickUserCallback
	)

Kicks a user out of a room. For use by homeowners only.

Parameters

RoomID	The ID of the room.
UserID	The ID of the user to be kicked (cannot be yourself).
kickDuration	The Length of the ban (in seconds).
OnKickUserCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

true: success
false: failure

◆ KickUser() [2/2]

static void KickUser	(	UObject *	WorldContextObject,
		const FString &	RoomID,
		const FString &	UserID,
		int32	KickDurationSeconds,
		FRoomKickUser	OnKickUserCallback
	)

static

Kicks a user out of a room. For use by homeowners only.

Parameters

WorldContextObject	Used to get the information about the current world.
RoomID	The ID of the room.
UserID	The ID of the user to be kicked (cannot be yourself).
KickDurationSeconds	The Length of the ban (in seconds).
OnKickUserCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

◆ LaunchInvitableUserFlow() [1/2]

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.

Parameters

RoomID The ID of the room.

Returns

Bool:

true: success
false: failure

◆ LaunchInvitableUserFlow() [2/2]

static void LaunchInvitableUserFlow	(	UObject *	WorldContextObject,
		const FString &	RoomID,
		FRoomLaunchInvitableUserFlow	OnLaunchInvitableUserFlowCallback
	)

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

WorldContextObject	Used to get the information about the current world.
RoomID	The ID of the room.
InGetLoggedInuserFriendsAndRoomsCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

◆ Leave() [1/2]

bool Leave	(	const FString &	RoomID,
		FRoomLeave	OnLeaveCallback
	)

Leaves the current room.

Note: The room you are now in will be returned if the request succeeds.

Parameters

RoomID	The ID of the room.
OnLeaveCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

true: success
false: failure

◆ Leave() [2/2]

static void Leave	(	UObject *	WorldContextObject,
		const FString &	RoomID,
		FRoomLeave	OnLeaveCallback
	)

static

Leaves the current room.

Note: The room you are now in will be returned if the request succeeds.

Parameters

WorldContextObject	Used to get the information about the current world.
RoomID	The ID of the room.
OnLeaveCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

◆ MarkAsRead() [1/2]

bool MarkAsRead	(	const FString &	NotificationID,
		FNotificationMarkAsRead	OnMarkAsReadCallback
	)

Marks a notification as read.

Parameters

NotificationID	The ID of the notificaiton to mark.
OnMarkAsReadCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

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

WorldContextObject	Used to get the information about the current world.
NotificationID	The ID of the notificaiton to mark.
OnMarkAsReadCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

◆ SetDescription() [1/2]

bool SetDescription	(	const FString &	RoomID,
		const FString &	Description,
		FRoomSetDescription	OnSetDescriptionCallback
	)

Sets the description of a room. For use by homeowners only.

Parameters

RoomID	The ID of the room to set description for.
Description	The new description of the room.
OnSetDescriptionCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

true: success
false: failure

◆ SetDescription() [2/2]

static void SetDescription	(	UObject *	WorldContextObject,
		const FString &	RoomID,
		const FString &	Description,
		FRoomSetDescription	OnSetDescriptionCallback
	)

static

Sets the description of a room. For use by homeowners only.

Parameters

WorldContextObject	Used to get the information about the current world.
RoomID	The ID of the room to set description for.
Description	The new description of the room.
OnSetDescriptionCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

◆ UpdateDataStore() [1/2]

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).

Note: Room data stores only allow string values. The maximum key length is 32 bytes and the maximum value length is 64 bytes. If you provide illegal values, this method will return an error.

Parameters

roomId	The ID of the room that you currently own (call `Room.OwnerOptional` to check).
data	The key/value pairs to add or update. Null value will clear a given key.
OnUpdateDataStoreCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

true: success
false: failure

◆ UpdateDataStore() [2/2]

static void UpdateDataStore	(	UObject *	WorldContextObject,
		const FString &	RoomID,
		const TMap< FString, FString > &	Data,
		FRoomUpdateDataStore	OnUpdateDataStoreCallback
	)

static

Updates the data store of the current room (the caller should be the room owner).

Note: Room data stores only allow string values. The maximum key length is 32 bytes and the maximum value length is 64 bytes. If you provide illegal values, this method will return an error.

Parameters

WorldContextObject	Used to get the information about the current world.
roomId	The ID of the room that you currently own (call `Room.OwnerOptional` to check).
data	The key/value pairs to add or update. Null value will clear a given key.
OnUpdateDataStoreCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

◆ UpdateMembershipLockStatus() [1/2]

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.

Note: Locking membership will prevent other users from joining the room through Join2(), invitations, etc. Users that are in the room at the time of lock will be able to rejoin.

Parameters

RoomID	The ID of the room to lock/unlock membership for.
MembershipLockStatus	The new membership status to set for the room: `0`: Unknown `1`: lock `2`: unlock
OnUpdateMembershipLockStatusCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

true: success
false: failure

◆ UpdateMembershipLockStatus() [2/2]

static void UpdateMembershipLockStatus	(	UObject *	WorldContextObject,
		const FString &	RoomID,
		ERoomMembershipLockStatus	MembershipLockStatus,
		FRoomUpdateMembershipLockStatus	OnUpdateMembershipLockStatusCallback
	)

static

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.

Note: Locking membership will prevent other users from joining the room through Join2(), invitations, etc. Users that are in the room at the time of lock will be able to rejoin.

Parameters

WorldContextObject	Used to get the information about the current world.
RoomID	The ID of the room to lock/unlock membership for.
MembershipLockStatus	The new membership status to set for the room: `0`: Unknown `1`: lock `2`: unlock
OnUpdateMembershipLockStatusCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

◆ UpdateOwner() [1/2]

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.

Parameters

RoomID	The ID of the room to change ownership for.
UserID	The ID of the new user to own the room. The new user must be in the same room.
OnUpdateOwnerCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

true: success
false: failure

◆ UpdateOwner() [2/2]

static void UpdateOwner	(	UObject *	WorldContextObject,
		const FString &	RoomID,
		const FString &	UserID,
		FRoomUpdateOwner	OnUpdateOwnerCallback
	)

static

Modifies the owner of the room, this person needs to be the person in this room.

Parameters

WorldContextObject	Used to get the information about the current world.
RoomID	The ID of the room to change ownership for.
UserID	The ID of the new user to own the room. The new user must be in the same room.
OnUpdateOwnerCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

◆ UpdatePrivateRoomJoinPolicy() [1/2]

bool UpdatePrivateRoomJoinPolicy	(	const FString &	RoomID,
		ERoomJoinPolicy	JoinPolicy,
		FRoomUpdatePrivateRoomJoinPolicy	OnUpdatePrivateRoomJoinPolicyCallback
	)

Sets the join policy for a specified private room.

Parameters

RoomID	The ID of the room you want to set join policy for.
JoinPolicy	Specifies who can join the room: `0`: nobody `1`: everybody `2`: friends of members `3`: friends of the room owner `4`: invited users `5`: unknown
OnUpdatePrivateRoomJoinPolicyCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

true: success
false: failure

◆ UpdatePrivateRoomJoinPolicy() [2/2]

static void UpdatePrivateRoomJoinPolicy	(	UObject *	WorldContextObject,
		const FString &	RoomID,
		ERoomJoinPolicy	JoinPolicy,
		FRoomUpdatePrivateRoomJoinPolicy	OnUpdatePrivateRoomJoinPolicyCallback
	)

static

Sets the join policy for a specified private room.

Parameters

WorldContextObject	Used to get the information about the current world.
RoomID	The ID of the room you want to set join policy for.
JoinPolicy	Specifies who can join the room: `0`: nobody `1`: everybody `2`: friends of members `3`: friends of the room owner `4`: invited users `5`: unknown
OnUpdatePrivateRoomJoinPolicyCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

Classes

Functions

Detailed Description

Function Documentation

◆ CreateAndJoinPrivate2() [1/2]

◆ CreateAndJoinPrivate2() [2/2]

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetCurrent() [1/2]

◆ GetCurrent() [2/2]

◆ GetCurrentForUser() [1/2]

◆ GetCurrentForUser() [2/2]

◆ GetInvitableUsers2() [1/2]

◆ GetInvitableUsers2() [2/2]

◆ GetModeratedRooms() [1/2]

◆ GetModeratedRooms() [2/2]

◆ GetRoomInviteNotifications() [1/2]

◆ GetRoomInviteNotifications() [2/2]

◆ InviteUser() [1/2]

◆ InviteUser() [2/2]

◆ Join2() [1/2]

◆ Join2() [2/2]

◆ KickUser() [1/2]

◆ KickUser() [2/2]

◆ LaunchInvitableUserFlow() [1/2]

◆ LaunchInvitableUserFlow() [2/2]

◆ Leave() [1/2]

◆ Leave() [2/2]

◆ MarkAsRead() [1/2]

◆ MarkAsRead() [2/2]

◆ SetDescription() [1/2]

◆ SetDescription() [2/2]

◆ UpdateDataStore() [1/2]

◆ UpdateDataStore() [2/2]

◆ UpdateMembershipLockStatus() [1/2]

◆ UpdateMembershipLockStatus() [2/2]

◆ UpdateOwner() [1/2]

◆ UpdateOwner() [2/2]

◆ UpdatePrivateRoomJoinPolicy() [1/2]

◆ UpdatePrivateRoomJoinPolicy() [2/2]