1. Epic GamesDeveloper
  3. IOnlineMessage

IOnlineMessage

Interface class for enumerating/sending/receiving messages between users

API > API/Plugins > API/Plugins/OnlineSubsystem > API/Plugins/OnlineSubsystem/Interfaces

References

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

Syntax

class IOnlineMessage

Remarks

Interface class for enumerating/sending/receiving messages between users

Variables

  Type Name Description
Public variable FOnDeleteMessageComplete[MAX_LOCAL_PLAYERS] OnDeleteMessageCompleteDelegates Delegate used when deleting a message has completed
Public variable FOnEnumerateMessagesComplete[MAX_LOCAL_PLAYERS] OnEnumerateMessagesCompleteDelegates Delegate used when the enumeration of message headers has completed
Public variable FOnReadMessageComplete[MAX_LOCAL_PLAYERS] OnReadMessageCompleteDelegates Delegate used when downloading of message contents has completed
Public variable FOnSendMessageComplete[MAX_LOCAL_PLAYERS] OnSendMessageCompleteDelegates Delegate used when sending of message has completed

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function bool

ClearMessage ( int32 LocalUserNum,
const FUniqueMessageId& MessageId
)

 Clear the given cached message
Public function bool

ClearMessageHeaders ( int32 LocalUserNum
)

 Clear the cached list of message headers
Public function bool

ClearMessages ( int32 LocalUserNum
)

 Clear all the cached messages
Public function Virtual void  
Public function Virtual void

ClearOnDeleteMessageCompleteDelegates ( int32 LocalUserNum,
void* Object
)

  
Public function Virtual void  
Public function Virtual void

ClearOnEnumerateMessagesCompleteDelegates ( int32 LocalUserNum,
void* Object
)

  
Public function Virtual void  
Public function Virtual void

ClearOnReadMessageCompleteDelegates ( int32 LocalUserNum,
void* Object
)

  
Public function Virtual void  
Public function Virtual void

ClearOnSendMessageCompleteDelegates ( int32 LocalUserNum,
void* Object
)

  
Public function bool

DeleteMessage ( int32 LocalUserNum,
const FUniqueMessageId& MessageId
)

 Delete a message from currently logged in user's inbox
Public function bool

EnumerateMessages ( int32 LocalUserNum
)

 Enumerate list of available message headers from user's inbox
Public function TSharedPtr< class FOnlineMessage >

GetMessage ( int32 LocalUserNum,
const FUniqueMessageId& MessageId
)

 Get the cached message and its contents for a user.
Public function bool

GetMessageHeaders ( int32 LocalUserNum,
TArray< TSharedRef< class FOnlineMessageHeader > >& OutHeaders
)

 Get the cached list of message headers for a user. Cache is populated by calling EnumerateMessages
Public function bool

ReadMessage ( int32 LocalUserNum,
const FUniqueMessageId& MessageId
)

 Download a message and its payload from user's inbox
Public function bool

SendMessage ( int32 LocalUserNum,
const TArray< FUniqueNetIdRef >& RecipientIds,
const FString& MessageType,
const FOnlineMessagePayload& Payload
)

 Send a message from the currently logged in user to a list of recipients
Public function Virtual void

TriggerOnDeleteMessageCompleteDelegates ( int32 LocalUserNum,
bool Param1,
const FUniqueMessageId& Param2,
const FString& Param3
)

  
Public function Virtual void

TriggerOnEnumerateMessagesCompleteDelegates ( int32 LocalUserNum,
bool Param1,
const FString& Param2
)

  
Public function Virtual void

TriggerOnReadMessageCompleteDelegates ( int32 LocalUserNum,
bool Param1,
const FUniqueMessageId& Param2,
const FString& Param3
)

  
Public function Virtual void

TriggerOnSendMessageCompleteDelegates ( int32 LocalUserNum,
bool Param1,
const FString& Param2
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page