Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem > API/Plugins/OnlineSubsystem/Interfaces
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
| Type | Name | Description | |
|---|---|---|---|
| FOnChatPrivateMessageReceived | OnChatPrivateMessageReceivedDelegates | ||
| FOnChatRoomConfigured | OnChatRoomConfiguredDelegates | ||
| FOnChatRoomCreated | OnChatRoomCreatedDelegates | Delegate callbacks (see declarations above) | |
| FOnChatRoomExit | OnChatRoomExitDelegates | ||
| FOnChatRoomJoinPrivate | OnChatRoomJoinPrivateDelegates | ||
| FOnChatRoomJoinPublic | OnChatRoomJoinPublicDelegates | ||
| FOnChatRoomMemberExit | OnChatRoomMemberExitDelegates | ||
| FOnChatRoomMemberJoin | OnChatRoomMemberJoinDelegates | ||
| FOnChatRoomMemberUpdate | OnChatRoomMemberUpdateDelegates | ||
| FOnChatRoomMessageReceived | OnChatRoomMessageReceivedDelegates |
Destructors
| Type | Name | Description | |
|---|---|---|---|
~IOnlineChat () |
Functions
| Type | Name | Description | |
|---|---|---|---|
| FDelegateHandle | AddOnChatPrivateMessageReceivedDelegate_Handle
(
const FOnChatPrivateMessageReceivedDelegate& Delegate |
||
| FDelegateHandle | AddOnChatRoomConfiguredDelegate_Handle
(
const FOnChatRoomConfiguredDelegate& Delegate |
||
| FDelegateHandle | AddOnChatRoomCreatedDelegate_Handle
(
const FOnChatRoomCreatedDelegate& Delegate |
||
| FDelegateHandle | AddOnChatRoomExitDelegate_Handle
(
const FOnChatRoomExitDelegate& Delegate |
||
| FDelegateHandle | AddOnChatRoomJoinPrivateDelegate_Handle
(
const FOnChatRoomJoinPrivateDelegate& Delegate |
||
| FDelegateHandle | AddOnChatRoomJoinPublicDelegate_Handle
(
const FOnChatRoomJoinPublicDelegate& Delegate |
||
| FDelegateHandle | AddOnChatRoomMemberExitDelegate_Handle
(
const FOnChatRoomMemberExitDelegate& Delegate |
||
| FDelegateHandle | AddOnChatRoomMemberJoinDelegate_Handle
(
const FOnChatRoomMemberJoinDelegate& Delegate |
||
| FDelegateHandle | AddOnChatRoomMemberUpdateDelegate_Handle
(
const FOnChatRoomMemberUpdateDelegate& Delegate |
||
| FDelegateHandle | AddOnChatRoomMessageReceivedDelegate_Handle
(
const FOnChatRoomMessageReceivedDelegate& Delegate |
||
| void | |||
| void | ClearOnChatPrivateMessageReceivedDelegates
(
void* Object |
||
| void | |||
| void | ClearOnChatRoomConfiguredDelegates
(
void* Object |
||
| void | ClearOnChatRoomCreatedDelegate_Handle
(
FDelegateHandle& Handle |
||
| void | ClearOnChatRoomCreatedDelegates
(
void* Object |
||
| void | ClearOnChatRoomExitDelegate_Handle
(
FDelegateHandle& Handle |
||
| void | ClearOnChatRoomExitDelegates
(
void* Object |
||
| void | |||
| void | ClearOnChatRoomJoinPrivateDelegates
(
void* Object |
||
| void | |||
| void | ClearOnChatRoomJoinPublicDelegates
(
void* Object |
||
| void | |||
| void | ClearOnChatRoomMemberExitDelegates
(
void* Object |
||
| void | |||
| void | ClearOnChatRoomMemberJoinDelegates
(
void* Object |
||
| void | |||
| void | ClearOnChatRoomMemberUpdateDelegates
(
void* Object |
||
| void | |||
| void | ClearOnChatRoomMessageReceivedDelegates
(
void* Object |
||
| bool | ConfigureRoom
(
const FUniqueNetId& UserId, |
Kick off request for configuring a chat room with a provided configuration | |
| bool | CreateRoom
(
const FUniqueNetId& UserId, |
Kick off request for creating a chat room with a provided configuration | |
| void | Dump state information about chat rooms | ||
| bool | ExitRoom
(
const FUniqueNetId& UserId, |
Kick off request for exiting a previously joined chat room | |
| void | GetJoinedRooms
(
const FUniqueNetId& UserId, |
Get cached list of rooms that have been joined | |
| bool | GetLastMessages
(
const FUniqueNetId& UserId, |
Get cached list of chat messages for a currently joined chat room | |
| TSharedPtr< FChatRoomMember > | GetMember
(
const FUniqueNetId& UserId, |
Get cached member currently joined in a chat room | |
| bool | GetMembers
(
const FUniqueNetId& UserId, |
Get cached list of members currently joined in a chat room | |
| TSharedPtr< FChatRoomInfo > | GetRoomInfo
(
const FUniqueNetId& UserId, |
Get cached room info for a room | |
| bool | IsChatAllowed
(
const FUniqueNetId& UserId, |
Determine if chat is allowed for a given user | |
| bool | IsMessageFromLocalUser
(
const FUniqueNetId& UserId, |
Check if a message is from the local user | |
| bool | JoinPrivateRoom
(
const FUniqueNetId& UserId, |
Kick off request for joining a private chat room | |
| bool | JoinPublicRoom
(
const FUniqueNetId& UserId, |
Kick off request for joining a public chat room | |
| bool | SendPrivateChat
(
const FUniqueNetId& UserId, |
Kick off request for sending a chat message privately between users | |
| bool | SendRoomChat
(
const FUniqueNetId& UserId, |
Kick off request for sending a chat message to a joined chat room | |
| void | TriggerOnChatPrivateMessageReceivedDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnChatRoomConfiguredDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnChatRoomCreatedDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnChatRoomExitDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnChatRoomJoinPrivateDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnChatRoomJoinPublicDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnChatRoomMemberExitDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnChatRoomMemberJoinDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnChatRoomMemberUpdateDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnChatRoomMessageReceivedDelegates
(
const FUniqueNetId& Param1, |