Navigation
Unreal Engine C++ API Reference > Runtime > Messaging
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
| Type | Name | Description | |
|---|---|---|---|
  |
Virtual destructor. |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | Disable () |
Disables the subscription. |
 |
void | Enable () |
Enables the subscription. |
 |
FTopLevelAssetPath | Gets the type of subscribed messages. | |
 |
const TRange< EMessageScope > & | Gets the range of subscribed message scopes. | |
 |
const TWeakPtr< IMessageReceiver, ESPMode::ThreadSafe > & | Gets the subscriber. | |
 |
bool | IsEnabled () |
Checks whether the subscription is enabled. |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
 |
FName | Types names are now represented by path names. Please use GetMessageTypePathName. |