Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem
Interface class for user-user and user-room chat
| Name | IOnlineChat |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineChatInterface.h |
| Include Path | #include "Interfaces/OnlineChatInterface.h" |
Syntax
class IOnlineChat
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IOnlineChat() |
Interfaces/OnlineChatInterface.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnChatPrivateMessageReceivedDelegates | FOnChatPrivateMessageReceived | Interfaces/OnlineChatInterface.h | ||
| OnChatPrivateMessageSentDelegates | FOnChatPrivateMessageSent | Interfaces/OnlineChatInterface.h | ||
| OnChatRoomConfiguredDelegates | FOnChatRoomConfigured | Interfaces/OnlineChatInterface.h | ||
| OnChatRoomCreatedDelegates | FOnChatRoomCreated | Delegate callbacks (see declarations above) | Interfaces/OnlineChatInterface.h | |
| OnChatRoomExitDelegates | FOnChatRoomExit | Interfaces/OnlineChatInterface.h | ||
| OnChatRoomJoinPrivateDelegates | FOnChatRoomJoinPrivate | Interfaces/OnlineChatInterface.h | ||
| OnChatRoomJoinPublicDelegates | FOnChatRoomJoinPublic | Interfaces/OnlineChatInterface.h | ||
| OnChatRoomMemberExitDelegates | FOnChatRoomMemberExit | Interfaces/OnlineChatInterface.h | ||
| OnChatRoomMemberJoinDelegates | FOnChatRoomMemberJoin | Interfaces/OnlineChatInterface.h | ||
| OnChatRoomMemberUpdateDelegates | FOnChatRoomMemberUpdate | Interfaces/OnlineChatInterface.h | ||
| OnChatRoomMessageReceivedDelegates | FOnChatRoomMessageReceived | Interfaces/OnlineChatInterface.h | ||
| OnChatRoomMessageSentDelegates | FOnChatRoomMessageSent | Interfaces/OnlineChatInterface.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FDelegateHandle AddOnChatPrivateMessageReceivedDelegate_Handle
(
const FOnChatPrivateMessageReceivedDelegate& Delegate |
Interfaces/OnlineChatInterface.h | ||
virtual FDelegateHandle AddOnChatPrivateMessageSentDelegate_Handle
(
const FOnChatPrivateMessageSentDelegate& Delegate |
Interfaces/OnlineChatInterface.h | ||
virtual FDelegateHandle AddOnChatRoomConfiguredDelegate_Handle
(
const FOnChatRoomConfiguredDelegate& Delegate |
Interfaces/OnlineChatInterface.h | ||
virtual FDelegateHandle AddOnChatRoomCreatedDelegate_Handle
(
const FOnChatRoomCreatedDelegate& Delegate |
Interfaces/OnlineChatInterface.h | ||
virtual FDelegateHandle AddOnChatRoomExitDelegate_Handle
(
const FOnChatRoomExitDelegate& Delegate |
Interfaces/OnlineChatInterface.h | ||
virtual FDelegateHandle AddOnChatRoomJoinPrivateDelegate_Handle
(
const FOnChatRoomJoinPrivateDelegate& Delegate |
Interfaces/OnlineChatInterface.h | ||
virtual FDelegateHandle AddOnChatRoomJoinPublicDelegate_Handle
(
const FOnChatRoomJoinPublicDelegate& Delegate |
Interfaces/OnlineChatInterface.h | ||
virtual FDelegateHandle AddOnChatRoomMemberExitDelegate_Handle
(
const FOnChatRoomMemberExitDelegate& Delegate |
Interfaces/OnlineChatInterface.h | ||
virtual FDelegateHandle AddOnChatRoomMemberJoinDelegate_Handle
(
const FOnChatRoomMemberJoinDelegate& Delegate |
Interfaces/OnlineChatInterface.h | ||
virtual FDelegateHandle AddOnChatRoomMemberUpdateDelegate_Handle
(
const FOnChatRoomMemberUpdateDelegate& Delegate |
Interfaces/OnlineChatInterface.h | ||
virtual FDelegateHandle AddOnChatRoomMessageReceivedDelegate_Handle
(
const FOnChatRoomMessageReceivedDelegate& Delegate |
Interfaces/OnlineChatInterface.h | ||
virtual FDelegateHandle AddOnChatRoomMessageSentDelegate_Handle
(
const FOnChatRoomMessageSentDelegate& Delegate |
Interfaces/OnlineChatInterface.h | ||
virtual void ClearOnChatPrivateMessageReceivedDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineChatInterface.h | ||
virtual void ClearOnChatPrivateMessageReceivedDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineChatInterface.h | ||
virtual void ClearOnChatPrivateMessageSentDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineChatInterface.h | ||
virtual void ClearOnChatPrivateMessageSentDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineChatInterface.h | ||
virtual void ClearOnChatRoomConfiguredDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineChatInterface.h | ||
virtual void ClearOnChatRoomConfiguredDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineChatInterface.h | ||
virtual void ClearOnChatRoomCreatedDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineChatInterface.h | ||
virtual void ClearOnChatRoomCreatedDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineChatInterface.h | ||
virtual void ClearOnChatRoomExitDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineChatInterface.h | ||
virtual void ClearOnChatRoomExitDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineChatInterface.h | ||
virtual void ClearOnChatRoomJoinPrivateDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineChatInterface.h | ||
virtual void ClearOnChatRoomJoinPrivateDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineChatInterface.h | ||
virtual void ClearOnChatRoomJoinPublicDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineChatInterface.h | ||
virtual void ClearOnChatRoomJoinPublicDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineChatInterface.h | ||
virtual void ClearOnChatRoomMemberExitDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineChatInterface.h | ||
virtual void ClearOnChatRoomMemberExitDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineChatInterface.h | ||
virtual void ClearOnChatRoomMemberJoinDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineChatInterface.h | ||
virtual void ClearOnChatRoomMemberJoinDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineChatInterface.h | ||
virtual void ClearOnChatRoomMemberUpdateDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineChatInterface.h | ||
virtual void ClearOnChatRoomMemberUpdateDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineChatInterface.h | ||
virtual void ClearOnChatRoomMessageReceivedDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineChatInterface.h | ||
virtual void ClearOnChatRoomMessageReceivedDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineChatInterface.h | ||
virtual void ClearOnChatRoomMessageSentDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineChatInterface.h | ||
virtual void ClearOnChatRoomMessageSentDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineChatInterface.h | ||
bool ConfigureRoom
(
const FUniqueNetId& UserId, |
Kick off request for configuring a chat room with a provided configuration | Interfaces/OnlineChatInterface.h | |
bool CreateRoom
(
const FUniqueNetId& UserId, |
Kick off request for creating a chat room with a provided configuration | Interfaces/OnlineChatInterface.h | |
void DumpChatState() |
Dump state information about chat rooms | Interfaces/OnlineChatInterface.h | |
bool ExitRoom
(
const FUniqueNetId& UserId, |
Kick off request for exiting a previously joined chat room | Interfaces/OnlineChatInterface.h | |
void GetJoinedRooms
(
const FUniqueNetId& UserId, |
Get cached list of rooms that have been joined | Interfaces/OnlineChatInterface.h | |
bool GetLastMessages
(
const FUniqueNetId& UserId, |
Get cached list of chat messages for a currently joined chat room | Interfaces/OnlineChatInterface.h | |
TSharedPtr< FChatRoomMember > GetMember
(
const FUniqueNetId& UserId, |
Get cached member currently joined in a chat room | Interfaces/OnlineChatInterface.h | |
bool GetMembers
(
const FUniqueNetId& UserId, |
Get cached list of members currently joined in a chat room | Interfaces/OnlineChatInterface.h | |
TSharedPtr< FChatRoomInfo > GetRoomInfo
(
const FUniqueNetId& UserId, |
Get cached room info for a room | Interfaces/OnlineChatInterface.h | |
bool IsChatAllowed
(
const FUniqueNetId& UserId, |
Determine if chat is allowed for a given user | Interfaces/OnlineChatInterface.h | |
bool IsMessageFromLocalUser
(
const FUniqueNetId& UserId, |
Check if a message is from the local user | Interfaces/OnlineChatInterface.h | |
bool JoinPrivateRoom
(
const FUniqueNetId& UserId, |
Kick off request for joining a private chat room | Interfaces/OnlineChatInterface.h | |
bool JoinPublicRoom
(
const FUniqueNetId& UserId, |
Kick off request for joining a public chat room | Interfaces/OnlineChatInterface.h | |
bool SendPrivateChat
(
const FUniqueNetId& UserId, |
Kick off request for sending a chat message privately between users | Interfaces/OnlineChatInterface.h | |
bool SendRoomChat
(
const FUniqueNetId& UserId, |
Kick off request for sending a chat message to a joined chat room | Interfaces/OnlineChatInterface.h | |
virtual void TriggerOnChatPrivateMessageReceivedDelegates
(
const FUniqueNetId& Param1, |
Interfaces/OnlineChatInterface.h | ||
virtual void TriggerOnChatPrivateMessageSentDelegates
(
const FUniqueNetId& Param1, |
Interfaces/OnlineChatInterface.h | ||
virtual void TriggerOnChatRoomConfiguredDelegates
(
const FUniqueNetId& Param1, |
Interfaces/OnlineChatInterface.h | ||
virtual void TriggerOnChatRoomCreatedDelegates
(
const FUniqueNetId& Param1, |
Interfaces/OnlineChatInterface.h | ||
virtual void TriggerOnChatRoomExitDelegates
(
const FUniqueNetId& Param1, |
Interfaces/OnlineChatInterface.h | ||
virtual void TriggerOnChatRoomJoinPrivateDelegates
(
const FUniqueNetId& Param1, |
Interfaces/OnlineChatInterface.h | ||
virtual void TriggerOnChatRoomJoinPublicDelegates
(
const FUniqueNetId& Param1, |
Interfaces/OnlineChatInterface.h | ||
virtual void TriggerOnChatRoomMemberExitDelegates
(
const FUniqueNetId& Param1, |
Interfaces/OnlineChatInterface.h | ||
virtual void TriggerOnChatRoomMemberJoinDelegates
(
const FUniqueNetId& Param1, |
Interfaces/OnlineChatInterface.h | ||
virtual void TriggerOnChatRoomMemberUpdateDelegates
(
const FUniqueNetId& Param1, |
Interfaces/OnlineChatInterface.h | ||
virtual void TriggerOnChatRoomMessageReceivedDelegates
(
const FUniqueNetId& Param1, |
Interfaces/OnlineChatInterface.h | ||
virtual void TriggerOnChatRoomMessageSentDelegates
(
const FUniqueNetId& Param1, |
Interfaces/OnlineChatInterface.h |