AF SDK Reference

AFNotificationRuleSubscriber.Description Property

Save PDF

TABLE OF CONTENTS

AFNotificationRuleSubscriber.Description Property

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Read/write property that provides a more detailed description of the object.

Namespace: OSIsoft.AF.Notification
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public string Description { get; set; }

Public Property Description As String
	Get
	Set

Dim instance As AFNotificationRuleSubscriber
Dim value As String

value = instance.Description

instance.Description = value

public:
property String^ Description {
	String^ get ();
	void set (String^ value);
}

member Description : string with get, set

Property Value

Type: String
The detailed description of the object. The maximum length of this property is 1000 characters.

Remarks

If this AFNotificationRuleSubscriber was created from an AFNotificationContactTemplate or from a AFNotificationRuleSubscriber from an AFNotificationRuleTemplate, then the value of this property is defined by the template and cannot be changed. In this case when the value is defined by a template, then changing the template's Description property will also change the value of this property. If the AFNotificationRuleSubscriber was NOT created from a template, then this property can be modified.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8

AF SDK Reference