Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Messaging > IMessageSubscription

Light Theme

Dark Theme

IMessageSubscription

Interface for message subscriptions.

Windows

MacOS

Linux

References

Module	Messaging
Header	/Engine/Source/Runtime/Messaging/Public/IMessageSubscription.h
Include	#include "IMessageSubscription.h"

Syntax

class IMessageSubscription

Remarks

Interface for message subscriptions.

This interface provides access to a message subscription that was previously created with the IMessageBus.Subscribe method. It can be used to query the subscription's details using the various getters and modify its enabled state using the IMessageSubscription.Enable and IMessageSubscription.Disable methods.

A subscription that is disabled will cause a message endpoint to stop receiving messages for the subscribed message type. However, the subscription is merely disabled and not removed.

Destructors

	Name	Description
	~IMessageSubscription()	Virtual destructor.

Functions

	Name	Description
void	Disable()	Disables the subscription.
void	Enable()	Enables the subscription.
FName	GetMessageType()	Gets the type of subscribed messages.
const TRange...	GetScopeRange()	Gets the range of subscribed message scopes.
const TWeakP...	GetSubscriber()	Gets the subscriber.
bool	IsEnabled()	Checks whether the subscription is enabled.

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

Take our survey

Dismiss