'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Function SubscribeDevicePayload( _
   ByVal consumer As IEasySparkplugConsumer, _
   ByVal hostDescriptor As SparkplugHostDescriptor, _
   ByVal groupId As String, _
   ByVal edgeNodeId As String, _
   ByVal deviceId As String _
) As Integer

'Usage
 
Dim consumer As IEasySparkplugConsumer
Dim hostDescriptor As SparkplugHostDescriptor
Dim groupId As String
Dim edgeNodeId As String
Dim deviceId As String
Dim value As Integer
 
value = IEasySparkplugConsumerExtension.SubscribeDevicePayload(consumer, hostDescriptor, groupId, edgeNodeId, deviceId)

[Extension()]
public static int SubscribeDevicePayload( 
   IEasySparkplugConsumer consumer,
   SparkplugHostDescriptor hostDescriptor,
   string groupId,
   string edgeNodeId,
   string deviceId
)

[Extension()]
public:
static int SubscribeDevicePayload( 
   IEasySparkplugConsumer^ consumer,
   SparkplugHostDescriptor^ hostDescriptor,
   String^ groupId,
   String^ edgeNodeId,
   String^ deviceId
) 

Parameters

consumer

The consumer object that will perform the operation.

The value of this parameter cannot be null (Nothing in Visual Basic).

hostDescriptor

The Sparkplug host descriptor.

The value of this parameter cannot be null (Nothing in Visual Basic).

groupId

The Sparkplug group ID.

The value represents a Sparkplug group ID, or a filter for Sparkplug group IDs. It must be a string with valid UTF-8 characters except for the reserved character '/' (forward slash). Characters '+' (plus) and '#' are filters, and can only be used when they are the single character in the string.

The value of this parameter cannot be null (Nothing in Visual Basic).

edgeNodeId

The Sparkplug edge node ID.

The value represents a Sparkplug edge node ID, or a filter for Sparkplug edge node IDs. It must be a string with valid UTF-8 characters except for the reserved character '/' (forward slash). Characters '+' (plus) and '#' are filters, and can only be used when they are the single character in the string.

The value of this parameter cannot be null (Nothing in Visual Basic).

deviceId

The Sparkplug device ID.

The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

To unsubscribe from the payload, use the UnsubscribePayload, UnsubscribeAllPayloads or UnsubscribeAll method.

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

Sparkplug is a trademark of Eclipse Foundation, Inc. "MQTT" is a trademark of the OASIS Open standards consortium. Other related terms are trademarks of their respective owners. Any use of these terms on this site is for descriptive purposes only and does not imply any sponsorship, endorsement or affiliation.

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows