Connectivity Software User's Guide and Reference
EasySparkplugMetricNotificationEventArgs Constructor(EasySparkplugMetricSubscriptionArguments,SparkplugComponentTypes,SparkplugNotificationType,SparkplugSystemDescriptor,String,String,String,String,String,OperationResult)



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug.OperationModel Namespace > EasySparkplugMetricNotificationEventArgs Class > EasySparkplugMetricNotificationEventArgs Constructor : EasySparkplugMetricNotificationEventArgs Constructor(EasySparkplugMetricSubscriptionArguments,SparkplugComponentTypes,SparkplugNotificationType,SparkplugSystemDescriptor,String,String,String,String,String,OperationResult)
The Sparkplug metric subscription arguments object.

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

The types of the Sparkplug components.
The Sparkplug notification type.
The Sparkplug system descriptor.

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

The client ID for the connection to the broker.

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

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).

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).

The Sparkplug device ID.

The value represents a Sparkplug device ID, or a filter for Sparkplug device 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).

The Sparkplug metric name.

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

The result of the operation - a success, or failure information.

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

Initializes a new instance of the class, specifying the Sparkplug metric subscription arguments, component types, notification type, system descriptor, client ID, group ID, edge node ID, device ID, metric name, and operation result.
Syntax
'Usage
 
Dim arguments As EasySparkplugMetricSubscriptionArguments
Dim componentTypes As SparkplugComponentTypes
Dim notificationType As SparkplugNotificationType
Dim systemDescriptor As SparkplugSystemDescriptor
Dim clientId As String
Dim groupId As String
Dim edgeNodeId As String
Dim deviceId As String
Dim metricName As String
Dim operationResult As OperationResult
 
Dim instance As New EasySparkplugMetricNotificationEventArgs(arguments, componentTypes, notificationType, systemDescriptor, clientId, groupId, edgeNodeId, deviceId, metricName, operationResult)

Parameters

arguments
The Sparkplug metric subscription arguments object.

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

componentTypes
The types of the Sparkplug components.
notificationType
The Sparkplug notification type.
systemDescriptor
The Sparkplug system descriptor.

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

clientId
The client ID for the connection to the broker.

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 represents a Sparkplug device ID, or a filter for Sparkplug device 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).

metricName
The Sparkplug metric name.

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

operationResult
The result of the operation - a success, or failure information.

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

Exceptions
ExceptionDescription

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Remarks

 

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.

Requirements

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

See Also