IXmppMultiUserChat Class Reference

#include <XmppMultiUserChat.h>

Public Member Functions
virtual	~IXmppMultiUserChat ()
virtual bool	CreateRoom (const FXmppRoomId &RoomId, const FString &Nickname, const FXmppRoomConfig &RoomConfig=FXmppRoomConfig())=0
virtual bool	ConfigureRoom (const FXmppRoomId &RoomId, const FXmppRoomConfig &RoomConfig)=0
virtual bool	JoinPublicRoom (const FXmppRoomId &RoomId, const FString &Nickname)=0
virtual bool	JoinPrivateRoom (const FXmppRoomId &RoomId, const FString &Nickname, const FString &Password)=0
virtual bool	RegisterMember (const FXmppRoomId &RoomId, const FString &Nickname)=0
virtual bool	UnregisterMember (const FXmppRoomId &RoomId, const FString &Nickname)=0
virtual bool	ExitRoom (const FXmppRoomId &RoomId)=0
virtual bool	SendChat (const FXmppRoomId &RoomId, const FString &MsgBody, const FString &ChatInfo)=0
virtual void	GetJoinedRooms (TArray< FXmppRoomId > &OutRooms)=0
virtual bool	RefreshRoomInfo (const FXmppRoomId &RoomId)=0
virtual bool	GetRoomInfo (const FXmppRoomId &RoomId, FXmppRoomInfo &OutRoomInfo)=0
virtual bool	GetMembers (const FXmppRoomId &RoomId, TArray< FXmppChatMemberRef > &OutMembers)=0
virtual FXmppChatMemberPtr	GetMember (const FXmppRoomId &RoomId, const FXmppUserJid &MemberJid)=0
virtual bool	GetLastMessages (const FXmppRoomId &RoomId, int32 NumMessages, TArray< TSharedRef< FXmppChatMessage > > &OutMessages)=0
virtual void	HandleMucPresence (const FXmppMucPresence &MemberPresence)=0
virtual void	DumpMultiUserChatState () const =0
	DECLARE_MULTICAST_DELEGATE_FourParams (FOnXmppRoomCreateComplete, const TSharedRef< IXmppConnection > &, bool, const FXmppRoomId &, const FString &)
virtual FOnXmppRoomCreateComplete &	OnRoomCreated ()=0
	DECLARE_MULTICAST_DELEGATE_FourParams (FOnXmppRoomConfigureComplete, const TSharedRef< IXmppConnection > &, bool, const FXmppRoomId &, const FString &)
virtual FOnXmppRoomConfigureComplete &	OnRoomConfigured ()=0
	DECLARE_MULTICAST_DELEGATE_FourParams (FOnXmppRoomInfoRefreshComplete, const TSharedRef< IXmppConnection > &, bool, const FXmppRoomId &, const FString &)
virtual FOnXmppRoomInfoRefreshComplete &	OnRoomInfoRefreshed ()=0
	DECLARE_MULTICAST_DELEGATE_FourParams (FOnXmppRoomJoinPublicComplete, const TSharedRef< IXmppConnection > &, bool, const FXmppRoomId &, const FString &)
virtual FOnXmppRoomJoinPublicComplete &	OnJoinPublicRoom ()=0
	DECLARE_MULTICAST_DELEGATE_FourParams (FOnXmppRoomJoinPrivateComplete, const TSharedRef< IXmppConnection > &, bool, const FXmppRoomId &, const FString &)
virtual FOnXmppRoomJoinPrivateComplete &	OnJoinPrivateRoom ()=0
	DECLARE_MULTICAST_DELEGATE_FourParams (FOnXmppRoomExitComplete, const TSharedRef< IXmppConnection > &, bool, const FXmppRoomId &, const FString &)
virtual FOnXmppRoomExitComplete &	OnExitRoom ()=0
	DECLARE_MULTICAST_DELEGATE_ThreeParams (FOnXmppRoomMemberJoin, const TSharedRef< IXmppConnection > &, const FXmppRoomId &, const FXmppUserJid &)
virtual FOnXmppRoomMemberJoin &	OnRoomMemberJoin ()=0
	DECLARE_MULTICAST_DELEGATE_ThreeParams (FOnXmppRoomMemberExit, const TSharedRef< IXmppConnection > &, const FXmppRoomId &, const FXmppUserJid &)
virtual FOnXmppRoomMemberExit &	OnRoomMemberExit ()=0
	DECLARE_MULTICAST_DELEGATE_ThreeParams (FOnXmppRoomMemberChanged, const TSharedRef< IXmppConnection > &, const FXmppRoomId &, const FXmppUserJid &)
virtual FOnXmppRoomMemberChanged &	OnRoomMemberChanged ()=0
	DECLARE_MULTICAST_DELEGATE_FourParams (FOnXmppRoomChatReceived, const TSharedRef< IXmppConnection > &, const FXmppRoomId &, const FXmppUserJid &, const TSharedRef< FXmppChatMessage > &)
virtual FOnXmppRoomChatReceived &	OnRoomChatReceived ()=0

Detailed Description

Interface for creating/joining/chatting in a MUC

Constructor & Destructor Documentation

~IXmppMultiUserChat()

virtual IXmppMultiUserChat::~IXmppMultiUserChat ( )

inlinevirtual

Member Function Documentation

ConfigureRoom()

virtual bool IXmppMultiUserChat::ConfigureRoom ( const FXmppRoomId &  RoomId, const FXmppRoomConfig &  RoomConfig  )

pure virtual

CreateRoom()

virtual bool IXmppMultiUserChat::CreateRoom ( const FXmppRoomId &  RoomId, const FString &  Nickname, const FXmppRoomConfig &  RoomConfig = FXmppRoomConfig()  )

pure virtual

DECLARE_MULTICAST_DELEGATE_FourParams() [1/7]

IXmppMultiUserChat::DECLARE_MULTICAST_DELEGATE_FourParams	(	FOnXmppRoomChatReceived	,
		const TSharedRef< IXmppConnection > &	,
		const FXmppRoomId &	,
		const FXmppUserJid &	,
		const TSharedRef< FXmppChatMessage > &
	)

DECLARE_MULTICAST_DELEGATE_FourParams() [2/7]

IXmppMultiUserChat::DECLARE_MULTICAST_DELEGATE_FourParams	(	FOnXmppRoomConfigureComplete	,
		const TSharedRef< IXmppConnection > &	,
		bool	,
		const FXmppRoomId &	,
		const FString &
	)

DECLARE_MULTICAST_DELEGATE_FourParams() [3/7]

IXmppMultiUserChat::DECLARE_MULTICAST_DELEGATE_FourParams	(	FOnXmppRoomCreateComplete	,
		const TSharedRef< IXmppConnection > &	,
		bool	,
		const FXmppRoomId &	,
		const FString &
	)

DECLARE_MULTICAST_DELEGATE_FourParams() [4/7]

IXmppMultiUserChat::DECLARE_MULTICAST_DELEGATE_FourParams	(	FOnXmppRoomExitComplete	,
		const TSharedRef< IXmppConnection > &	,
		bool	,
		const FXmppRoomId &	,
		const FString &
	)

DECLARE_MULTICAST_DELEGATE_FourParams() [5/7]

IXmppMultiUserChat::DECLARE_MULTICAST_DELEGATE_FourParams	(	FOnXmppRoomInfoRefreshComplete	,
		const TSharedRef< IXmppConnection > &	,
		bool	,
		const FXmppRoomId &	,
		const FString &
	)

DECLARE_MULTICAST_DELEGATE_FourParams() [6/7]

IXmppMultiUserChat::DECLARE_MULTICAST_DELEGATE_FourParams	(	FOnXmppRoomJoinPrivateComplete	,
		const TSharedRef< IXmppConnection > &	,
		bool	,
		const FXmppRoomId &	,
		const FString &
	)

DECLARE_MULTICAST_DELEGATE_FourParams() [7/7]

IXmppMultiUserChat::DECLARE_MULTICAST_DELEGATE_FourParams	(	FOnXmppRoomJoinPublicComplete	,
		const TSharedRef< IXmppConnection > &	,
		bool	,
		const FXmppRoomId &	,
		const FString &
	)

DECLARE_MULTICAST_DELEGATE_ThreeParams() [1/3]

IXmppMultiUserChat::DECLARE_MULTICAST_DELEGATE_ThreeParams	(	FOnXmppRoomMemberChanged	,
		const TSharedRef< IXmppConnection > &	,
		const FXmppRoomId &	,
		const FXmppUserJid &
	)

DECLARE_MULTICAST_DELEGATE_ThreeParams() [2/3]

IXmppMultiUserChat::DECLARE_MULTICAST_DELEGATE_ThreeParams	(	FOnXmppRoomMemberExit	,
		const TSharedRef< IXmppConnection > &	,
		const FXmppRoomId &	,
		const FXmppUserJid &
	)

DECLARE_MULTICAST_DELEGATE_ThreeParams() [3/3]

IXmppMultiUserChat::DECLARE_MULTICAST_DELEGATE_ThreeParams	(	FOnXmppRoomMemberJoin	,
		const TSharedRef< IXmppConnection > &	,
		const FXmppRoomId &	,
		const FXmppUserJid &
	)

Delegate when a member joins a room

Parameters

Connection	the XMPP connection
RoomId	the ID of the room that a member joined
RoomMemberJid	the JID the member that joined, used to lookup the member inside of the room

DumpMultiUserChatState()

virtual void IXmppMultiUserChat::DumpMultiUserChatState ( ) const

pure virtual

ExitRoom()

virtual bool IXmppMultiUserChat::ExitRoom ( const FXmppRoomId &  RoomId )

pure virtual

GetJoinedRooms()

virtual void IXmppMultiUserChat::GetJoinedRooms ( TArray< FXmppRoomId > &  OutRooms )

pure virtual

GetLastMessages()

virtual bool IXmppMultiUserChat::GetLastMessages ( const FXmppRoomId &  RoomId, int32  NumMessages, TArray< TSharedRef< FXmppChatMessage > > &  OutMessages  )

pure virtual

GetMember()

virtual FXmppChatMemberPtr IXmppMultiUserChat::GetMember ( const FXmppRoomId &  RoomId, const FXmppUserJid &  MemberJid  )

pure virtual

GetMembers()

virtual bool IXmppMultiUserChat::GetMembers ( const FXmppRoomId &  RoomId, TArray< FXmppChatMemberRef > &  OutMembers  )

pure virtual

GetRoomInfo()

virtual bool IXmppMultiUserChat::GetRoomInfo ( const FXmppRoomId &  RoomId, FXmppRoomInfo &  OutRoomInfo  )

pure virtual

HandleMucPresence()

virtual void IXmppMultiUserChat::HandleMucPresence ( const FXmppMucPresence &  MemberPresence )

pure virtual

JoinPrivateRoom()

virtual bool IXmppMultiUserChat::JoinPrivateRoom ( const FXmppRoomId &  RoomId, const FString &  Nickname, const FString &  Password  )

pure virtual

JoinPublicRoom()

virtual bool IXmppMultiUserChat::JoinPublicRoom ( const FXmppRoomId &  RoomId, const FString &  Nickname  )

pure virtual

OnExitRoom()

virtual FOnXmppRoomExitComplete & IXmppMultiUserChat::OnExitRoom ( )

pure virtual

Returns

exit room delegate

OnJoinPrivateRoom()

virtual FOnXmppRoomJoinPrivateComplete & IXmppMultiUserChat::OnJoinPrivateRoom ( )

pure virtual

Returns

private room joined delegate

OnJoinPublicRoom()

virtual FOnXmppRoomJoinPublicComplete & IXmppMultiUserChat::OnJoinPublicRoom ( )

pure virtual

Returns

public room joined delegate

OnRoomChatReceived()

virtual FOnXmppRoomChatReceived & IXmppMultiUserChat::OnRoomChatReceived ( )

pure virtual

Returns

chat room message received delegate

OnRoomConfigured()

virtual FOnXmppRoomConfigureComplete & IXmppMultiUserChat::OnRoomConfigured ( )

pure virtual

Returns

room configured delegate

OnRoomCreated()

virtual FOnXmppRoomCreateComplete & IXmppMultiUserChat::OnRoomCreated ( )

pure virtual

Returns

room created delegate

OnRoomInfoRefreshed()

virtual FOnXmppRoomInfoRefreshComplete & IXmppMultiUserChat::OnRoomInfoRefreshed ( )

pure virtual

Returns

room refresh delegate

OnRoomMemberChanged()

virtual FOnXmppRoomMemberChanged & IXmppMultiUserChat::OnRoomMemberChanged ( )

pure virtual

Returns

room member changed delegate

OnRoomMemberExit()

virtual FOnXmppRoomMemberExit & IXmppMultiUserChat::OnRoomMemberExit ( )

pure virtual

Returns

room member exited room delegate

OnRoomMemberJoin()

virtual FOnXmppRoomMemberJoin & IXmppMultiUserChat::OnRoomMemberJoin ( )

pure virtual

Returns

room member joined room delegate

RefreshRoomInfo()

virtual bool IXmppMultiUserChat::RefreshRoomInfo ( const FXmppRoomId &  RoomId )

pure virtual

RegisterMember()

virtual bool IXmppMultiUserChat::RegisterMember ( const FXmppRoomId &  RoomId, const FString &  Nickname  )

pure virtual

SendChat()

virtual bool IXmppMultiUserChat::SendChat ( const FXmppRoomId &  RoomId, const FString &  MsgBody, const FString &  ChatInfo  )

pure virtual

UnregisterMember()

virtual bool IXmppMultiUserChat::UnregisterMember ( const FXmppRoomId &  RoomId, const FString &  Nickname  )

pure virtual

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/Online/XMPP/Public/XmppMultiUserChat.h