IOnlineMessage

Interface class for enumerating/sending/receiving messages between users

Windows
MacOS
Linux

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

Name Description

Public variable

FOnDeleteMessag...

 

OnDeleteMessageCompleteDelegates

Delegate used when deleting a message has completed

Public variable

FOnEnumerateMes...

 

OnEnumerateMessagesCompleteDelegates

Delegate used when the enumeration of message headers has completed

Public variable

FOnReadMessageC...

 

OnReadMessageCompleteDelegates

Delegate used when downloading of message contents has completed

Public variable

FOnSendMessageC...

 

OnSendMessageCompleteDelegates

Delegate used when sending of message has completed

Destructors

Name Description

Public function Virtual

~IOnlineMessage()

Functions

Name Description

Public function Virtual

FDelegateHan...

 

AddOnDeleteMessageCompleteDelegate_Handle

(
    int32 LocalUserNum,
    const FOnDeleteMessageCompleteDeleg...
)

Public function Virtual

FDelegateHan...

 

AddOnEnumerateMessagesCompleteDelegate_Handle

(
    int32 LocalUserNum,
    const FOnEnumerateMessagesCompleteD...
)

Public function Virtual

FDelegateHan...

 

AddOnReadMessageCompleteDelegate_Handle

(
    int32 LocalUserNum,
    const FOnReadMessageCompleteDelegat...
)

Public function Virtual

FDelegateHan...

 

AddOnSendMessageCompleteDelegate_Handle

(
    int32 LocalUserNum,
    const FOnSendMessageCompleteDelegat...
)

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

 

ClearOnDeleteMessageCompleteDelegate_Handle

(
    int32 LocalUserNum,
    FDelegateHandle& Handle
)

Public function Virtual

void

 

ClearOnDeleteMessageCompleteDelegates

(
    int32 LocalUserNum,
    void* Object
)

Public function Virtual

void

 

ClearOnEnumerateMessagesCompleteDelegate_Handle

(
    int32 LocalUserNum,
    FDelegateHandle& Handle
)

Public function Virtual

void

 

ClearOnEnumerateMessagesCompleteDelegates

(
    int32 LocalUserNum,
    void* Object
)

Public function Virtual

void

 

ClearOnReadMessageCompleteDelegate_Handle

(
    int32 LocalUserNum,
    FDelegateHandle& Handle
)

Public function Virtual

void

 

ClearOnReadMessageCompleteDelegates

(
    int32 LocalUserNum,
    void* Object
)

Public function Virtual

void

 

ClearOnSendMessageCompleteDelegate_Handle

(
    int32 LocalUserNum,
    FDelegateHandle& Handle
)

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< ...

 

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 FOnlineMe...
)

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< TSharedRef< const FUn...,
    const FString& MessageType,
    const FOnlineMessagePayload& Paylo...
)

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
)

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