Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > OnlineSubsystem > Interfaces > IOnlineChat

Light Theme

Dark Theme

IOnlineChat

Interface class for user-user and user-room chat

Windows

MacOS

Linux

References

Module	OnlineSubsystem
Header	/Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineChatInterface.h
Include	#include "Interfaces/OnlineChatInterface.h"

Syntax

class IOnlineChat

Remarks

Interface class for user-user and user-room chat

Variables

	Name	Description
FOnChatPrivateM...	OnChatPrivateMessageReceivedDelegates
FOnChatRoomConf...	OnChatRoomConfiguredDelegates
FOnChatRoomCrea...	OnChatRoomCreatedDelegates	Delegate callbacks (see declarations above)
FOnChatRoomExit	OnChatRoomExitDelegates
FOnChatRoomJoin...	OnChatRoomJoinPrivateDelegates
FOnChatRoomJoin...	OnChatRoomJoinPublicDelegates
FOnChatRoomMemb...	OnChatRoomMemberExitDelegates
FOnChatRoomMemb...	OnChatRoomMemberJoinDelegates
FOnChatRoomMemb...	OnChatRoomMemberUpdateDelegates
FOnChatRoomMess...	OnChatRoomMessageReceivedDelegates

Destructors

	Name	Description
	~IOnlineChat()

Functions

	Name	Description
FDelegateHan...	AddOnChatPrivateMessageReceivedDelegate_Handle ( const FOnChatPrivateMessageReceived... )
FDelegateHan...	AddOnChatRoomConfiguredDelegate_Handle ( const FOnChatRoomConfiguredDelegate... )
FDelegateHan...	AddOnChatRoomCreatedDelegate_Handle ( const FOnChatRoomCreatedDelegate& ... )
FDelegateHan...	AddOnChatRoomExitDelegate_Handle ( const FOnChatRoomExitDelegate& Del... )
FDelegateHan...	AddOnChatRoomJoinPrivateDelegate_Handle ( const FOnChatRoomJoinPrivateDelegat... )
FDelegateHan...	AddOnChatRoomJoinPublicDelegate_Handle ( const FOnChatRoomJoinPublicDelegate... )
FDelegateHan...	AddOnChatRoomMemberExitDelegate_Handle ( const FOnChatRoomMemberExitDelegate... )
FDelegateHan...	AddOnChatRoomMemberJoinDelegate_Handle ( const FOnChatRoomMemberJoinDelegate... )
FDelegateHan...	AddOnChatRoomMemberUpdateDelegate_Handle ( const FOnChatRoomMemberUpdateDelega... )
FDelegateHan...	AddOnChatRoomMessageReceivedDelegate_Handle ( const FOnChatRoomMessageReceivedDel... )
void	ClearOnChatPrivateMessageReceivedDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnChatPrivateMessageReceivedDelegates ( void* Object )
void	ClearOnChatRoomConfiguredDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnChatRoomConfiguredDelegates ( void* Object )
void	ClearOnChatRoomCreatedDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnChatRoomCreatedDelegates ( void* Object )
void	ClearOnChatRoomExitDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnChatRoomExitDelegates ( void* Object )
void	ClearOnChatRoomJoinPrivateDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnChatRoomJoinPrivateDelegates ( void* Object )
void	ClearOnChatRoomJoinPublicDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnChatRoomJoinPublicDelegates ( void* Object )
void	ClearOnChatRoomMemberExitDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnChatRoomMemberExitDelegates ( void* Object )
void	ClearOnChatRoomMemberJoinDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnChatRoomMemberJoinDelegates ( void* Object )
void	ClearOnChatRoomMemberUpdateDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnChatRoomMemberUpdateDelegates ( void* Object )
void	ClearOnChatRoomMessageReceivedDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnChatRoomMessageReceivedDelegates ( void* Object )
bool	ConfigureRoom ( const FUniqueNetId& UserId, const FChatRoomId& RoomId, const FChatRoomConfig& ChatRoomCon... )	Kick off request for configuring a chat room with a provided configuration
bool	CreateRoom ( const FUniqueNetId& UserId, const FChatRoomId& RoomId, const FString& Nickname, const FChatRoomConfig& ChatRoomCon... )	Kick off request for creating a chat room with a provided configuration
void	DumpChatState()	Dump state information about chat rooms
bool	ExitRoom ( const FUniqueNetId& UserId, const FChatRoomId& RoomId )	Kick off request for exiting a previously joined chat room
void	GetJoinedRooms ( const FUniqueNetId& UserId, TArray< FChatRoomId >& OutRooms )	Get cached list of rooms that have been joined
bool	GetLastMessages ( const FUniqueNetId& UserId, const FChatRoomId& RoomId, int32 NumMessages, TArray< TSharedRef< FChatMessage > ... )	Get cached list of chat messages for a currently joined chat room
TSharedPtr< ...	GetMember ( const FUniqueNetId& UserId, const FChatRoomId& RoomId, const FUniqueNetId& MemberId )	Get cached member currently joined in a chat room
bool	GetMembers ( const FUniqueNetId& UserId, const FChatRoomId& RoomId, TArray< TSharedRef< FChatRoomMember... )	Get cached list of members currently joined in a chat room
TSharedPtr< ...	GetRoomInfo ( const FUniqueNetId& UserId, const FChatRoomId& RoomId )	Get cached room info for a room
bool	IsChatAllowed ( const FUniqueNetId& UserId, const FUniqueNetId& RecipientId )	Determine if chat is allowed for a given user
bool	IsMessageFromLocalUser ( const FUniqueNetId& UserId, const FChatMessage& Message, const bool bIncludeExternalInstance... )	Check if a message is from the local user
bool	JoinPrivateRoom ( const FUniqueNetId& UserId, const FChatRoomId& RoomId, const FString& Nickname, const FChatRoomConfig& ChatRoomCon... )	Kick off request for joining a private chat room
bool	JoinPublicRoom ( const FUniqueNetId& UserId, const FChatRoomId& RoomId, const FString& Nickname, const FChatRoomConfig& ChatRoomCon... )	Kick off request for joining a public chat room
bool	SendPrivateChat ( const FUniqueNetId& UserId, const FUniqueNetId& RecipientId, const FString& MsgBody )	Kick off request for sending a chat message privately between users
bool	SendRoomChat ( const FUniqueNetId& UserId, const FChatRoomId& RoomId, const FString& MsgBody )	Kick off request for sending a chat message to a joined chat room
void	TriggerOnChatPrivateMessageReceivedDelegates ( const FUniqueNetId& Param1, const TSharedRef< FChatMessage >& ... )
void	TriggerOnChatRoomConfiguredDelegates ( const FUniqueNetId& Param1, const FChatRoomId& Param2, bool Param3, const FString& Param4 )
void	TriggerOnChatRoomCreatedDelegates ( const FUniqueNetId& Param1, const FChatRoomId& Param2, bool Param3, const FString& Param4 )
void	TriggerOnChatRoomExitDelegates ( const FUniqueNetId& Param1, const FChatRoomId& Param2, bool Param3, const FString& Param4 )
void	TriggerOnChatRoomJoinPrivateDelegates ( const FUniqueNetId& Param1, const FChatRoomId& Param2, bool Param3, const FString& Param4 )
void	TriggerOnChatRoomJoinPublicDelegates ( const FUniqueNetId& Param1, const FChatRoomId& Param2, bool Param3, const FString& Param4 )
void	TriggerOnChatRoomMemberExitDelegates ( const FUniqueNetId& Param1, const FChatRoomId& Param2, const FUniqueNetId& Param3 )
void	TriggerOnChatRoomMemberJoinDelegates ( const FUniqueNetId& Param1, const FChatRoomId& Param2, const FUniqueNetId& Param3 )
void	TriggerOnChatRoomMemberUpdateDelegates ( const FUniqueNetId& Param1, const FChatRoomId& Param2, const FUniqueNetId& Param3 )
void	TriggerOnChatRoomMessageReceivedDelegates ( const FUniqueNetId& Param1, const FChatRoomId& Param2, const TSharedRef< FChatMessage >& ... )

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss