IMessageSubscription

Interface for message subscriptions.

Choose your operating system:

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

Public function Virtual

~IMessageSubscription()

Virtual destructor.

Functions

Name Description

Public function

void

 

Disable()

Disables the subscription.

Public function

void

 

Enable()

Enables the subscription.

Public function

FName

 

GetMessageType()

Gets the type of subscribed messages.

Public function

const TRange...

 

GetScopeRange()

Gets the range of subscribed message scopes.

Public function

const TWeakP...

 

GetSubscriber()

Gets the subscriber.

Public function

bool

 

IsEnabled()

Checks whether the subscription is enabled.