Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem
Interface class for enumerating/sending/receiving messages between users
| Name | IOnlineMessage |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineMessageInterface.h |
| Include Path | #include "Interfaces/OnlineMessageInterface.h" |
Syntax
class IOnlineMessage
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IOnlineMessage() |
Interfaces/OnlineMessageInterface.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnDeleteMessageCompleteDelegates | FOnDeleteMessageComplete | Delegate used when deleting a message has completed | Interfaces/OnlineMessageInterface.h | |
| OnEnumerateMessagesCompleteDelegates | FOnEnumerateMessagesComplete | Delegate used when the enumeration of message headers has completed | Interfaces/OnlineMessageInterface.h | |
| OnReadMessageCompleteDelegates | FOnReadMessageComplete | Delegate used when downloading of message contents has completed | Interfaces/OnlineMessageInterface.h | |
| OnSendMessageCompleteDelegates | FOnSendMessageComplete | Delegate used when sending of message has completed | Interfaces/OnlineMessageInterface.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FDelegateHandle AddOnDeleteMessageCompleteDelegate_Handle
(
int32 LocalUserNum, |
Interfaces/OnlineMessageInterface.h | ||
virtual FDelegateHandle AddOnEnumerateMessagesCompleteDelegate_Handle
(
int32 LocalUserNum, |
Interfaces/OnlineMessageInterface.h | ||
virtual FDelegateHandle AddOnReadMessageCompleteDelegate_Handle
(
int32 LocalUserNum, |
Interfaces/OnlineMessageInterface.h | ||
virtual FDelegateHandle AddOnSendMessageCompleteDelegate_Handle
(
int32 LocalUserNum, |
Interfaces/OnlineMessageInterface.h | ||
bool ClearMessage
(
int32 LocalUserNum, |
Clear the given cached message | Interfaces/OnlineMessageInterface.h | |
bool ClearMessageHeaders
(
int32 LocalUserNum |
Clear the cached list of message headers | Interfaces/OnlineMessageInterface.h | |
bool ClearMessages
(
int32 LocalUserNum |
Clear all the cached messages | Interfaces/OnlineMessageInterface.h | |
virtual void ClearOnDeleteMessageCompleteDelegate_Handle
(
int32 LocalUserNum, |
Interfaces/OnlineMessageInterface.h | ||
virtual void ClearOnDeleteMessageCompleteDelegates
(
int32 LocalUserNum, |
Interfaces/OnlineMessageInterface.h | ||
virtual void ClearOnEnumerateMessagesCompleteDelegate_Handle
(
int32 LocalUserNum, |
Interfaces/OnlineMessageInterface.h | ||
virtual void ClearOnEnumerateMessagesCompleteDelegates
(
int32 LocalUserNum, |
Interfaces/OnlineMessageInterface.h | ||
virtual void ClearOnReadMessageCompleteDelegate_Handle
(
int32 LocalUserNum, |
Interfaces/OnlineMessageInterface.h | ||
virtual void ClearOnReadMessageCompleteDelegates
(
int32 LocalUserNum, |
Interfaces/OnlineMessageInterface.h | ||
virtual void ClearOnSendMessageCompleteDelegate_Handle
(
int32 LocalUserNum, |
Interfaces/OnlineMessageInterface.h | ||
virtual void ClearOnSendMessageCompleteDelegates
(
int32 LocalUserNum, |
Interfaces/OnlineMessageInterface.h | ||
bool DeleteMessage
(
int32 LocalUserNum, |
Delete a message from currently logged in user's inbox | Interfaces/OnlineMessageInterface.h | |
bool EnumerateMessages
(
int32 LocalUserNum |
Enumerate list of available message headers from user's inbox | Interfaces/OnlineMessageInterface.h | |
TSharedPtr< class FOnlineMessage > GetMessage
(
int32 LocalUserNum, |
Get the cached message and its contents for a user. | Interfaces/OnlineMessageInterface.h | |
bool GetMessageHeaders
(
int32 LocalUserNum, |
Get the cached list of message headers for a user. Cache is populated by calling EnumerateMessages | Interfaces/OnlineMessageInterface.h | |
bool ReadMessage
(
int32 LocalUserNum, |
Download a message and its payload from user's inbox | Interfaces/OnlineMessageInterface.h | |
bool SendMessage
(
int32 LocalUserNum, |
Send a message from the currently logged in user to a list of recipients | Interfaces/OnlineMessageInterface.h | |
virtual void TriggerOnDeleteMessageCompleteDelegates
(
int32 LocalUserNum, |
Interfaces/OnlineMessageInterface.h | ||
virtual void TriggerOnEnumerateMessagesCompleteDelegates
(
int32 LocalUserNum, |
Interfaces/OnlineMessageInterface.h | ||
virtual void TriggerOnReadMessageCompleteDelegates
(
int32 LocalUserNum, |
Interfaces/OnlineMessageInterface.h | ||
virtual void TriggerOnSendMessageCompleteDelegates
(
int32 LocalUserNum, |
Interfaces/OnlineMessageInterface.h |