FOnlineNotificationHandler

This class is a static manager used to track notification transports and map the delivered notifications to subscribed notification handlers

Windows
MacOS
Linux

References

Module

OnlineSubsystem

Header

/Engine/Plugins/Online/OnlineSubsystem/Source/Public/OnlineNotificationHandler.h

Include

#include "OnlineNotificationHandler.h"

Syntax

class FOnlineNotificationHandler

Remarks

This class is a static manager used to track notification transports and map the delivered notifications to subscribed notification handlers

Variables

Name Description

Protected variable

TMap< FString, ...

 

PlayerBindingMap

Map from player and type of notification to the delegate to call

Protected variable

NotificationTyp...

 

SystemBindingMap

Map from type of notification to the delegate to call

Constructors

Name Description

Public function

FOnlineNotificationHandler()

Lifecycle is managed by OnlineSubSystem, all access should be made through there

Functions

Name Description

Public function

FDelegateHan...

 

AddPlayerNotificationBinding_Handle

(
    const FUniqueNetId& PlayerId,
    FString NotificationType,
    const FOnlineNotificationBinding& ...
)

Add a notification binding for a type

Public function

FDelegateHan...

 

AddSystemNotificationBinding_Handle

(
    FString NotificationType,
    const FOnlineNotificationBinding& ...
)

Add a notification binding for a type

Public function

void

 

DeliverNotification

(
    const FOnlineNotification& Notific...
)

Deliver a notification to the appropriate handler for that player/msg type.

Public function

void

 

RemovePlayerNotificationBinding

(
    const FUniqueNetId& PlayerId,
    FString NotificationType,
    FDelegateHandle RemoveHandle
)

Remove the player notification handler for a type

Public function

void

 

RemoveSystemNotificationBinding

(
    FString NotificationType,
    FDelegateHandle RemoveHandle
)

Remove the notification handler for a type

Public function

void

 

ResetAllPlayerNotificationBindings()

Resets all player notification handlers

Public function

void

 

ResetPlayerNotificationBindings

(
    const FUniqueNetId& PlayerId
)

Resets a player's notification handlers

Public function

void

 

ResetSystemNotificationBindings()

Resets all system notification handlers

Typedefs

Name

Description

NotificationTypeBindingsMap

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