Build 1.01.318.0
[This is preliminary documentation and is subject to change.]
The Subscription type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | Subscription()()()() |
Creates a empty object.
|
| Subscription(Subscription) |
Initializes the subscription from a template.
|
| Subscription(Subscription, Boolean) |
Initializes the subscription from a template.
|
Methods
| Name | Description | |
|---|---|---|
| AddItem |
Adds an item to the subscription.
|
| AddItems |
Adds an item to the subscription.
|
| ApplyChanges |
Applies any changes to the subscription items.
|
| ChangesCompleted |
Sends a notification that the state of the subscription has changed.
|
| ConditionRefresh |
Tells the server to refresh all conditions being monitored by the subscription.
|
| Create |
Creates a subscription on the server.
|
| CreateItems |
Creates all items that have not already been created.
|
| Delete |
Deletes a subscription on the server.
|
| DeleteItems |
Deletes all items that have been marked for deletion.
|
| Dispose()()()() |
Frees any unmanaged resources.
|
 | Dispose(Boolean) |
An overrideable version of the Dispose.
|
| Equals | (Inherited from Object.) |
| Finalize |
The finializer implementation.
(Overrides Object..::..Finalize()()()().) |
| FindItemByClientHandle |
Returns the monitored item identified by the client handle.
|
| GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetType |
Gets the Type of the current instance.
(Inherited from Object.) |
| MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| Modify |
Modifies a subscription on the server.
|
| ModifyItems |
Modies all items that have been changed.
|
| RemoveItem |
Removes an item from the subscription.
|
| RemoveItems |
Removes an item from the subscription.
|
| Republish |
Republishes the specified notification message.
|
| ResolveItemNodeIds |
Resolves all relative paths to nodes on the server.
|
| SaveMessageInCache |
Adds the notification message to internal cache.
|
| SetMonitoringMode |
Deletes all items that have been marked for deletion.
|
| SetPublishingMode |
Changes the publishing enabled state for the subscription.
|
| ToString | (Inherited from Object.) |
Properties
| Name | Description | |
|---|---|---|
 | AvailableSequenceNumbers |
The sequence numbers that are available for republish requests.
|
| ChangesPending |
Returns true if the subscription has changes that need to be applied.
|
| Created |
Whether the subscription has been created on the server.
|
| CurrentKeepAliveCount |
The current keep alive count.
|
| CurrentLifetimeCount |
The current lifetime count.
|
| CurrentPriority |
The priority assigned to subscription when it was created.
|
| CurrentPublishingEnabled |
Whether publishing is currently enabled.
|
| CurrentPublishingInterval |
The current publishing interval.
|
| DefaultItem |
The default monitored item.
|
| DisableMonitoredItemCache |
Gets or sets a value indicating whether the notifications are cached within the monitored items.
|
| DisplayName |
A display name for the subscription.
|
| FastDataChangeCallback |
Gets or sets the fast data change callback.
|
| FastEventCallback |
Gets or sets the fast event callback.
|
| Handle |
A local handle assigned to the subscription
|
| Id |
The unique identifier assigned by the server.
|
| KeepAliveCount |
The keep alive count.
|
| LastNotification |
The last notification received from the server.
|
| LifetimeCount |
The maximum number of notifications per publish request.
|
| MaxMessageCount |
The maximum number of messages to keep in the internal cache.
|
| MaxNotificationsPerPublish |
The maximum number of notifications per publish request.
|
| MinLifetimeInterval |
The minimum lifetime for subscriptions in milliseconds.
|
| MonitoredItemCount |
Returns the number of monitored items.
|
| MonitoredItems |
The items to monitor.
|
| NotificationCount |
The number of notifications contained in the last notification message.
|
| Notifications |
The cached notifications.
|
| Priority |
The priority assigned to subscription.
|
| PublishingEnabled |
Whether publishing is enabled.
|
| PublishingInterval |
The publishing interval.
|
| PublishingStopped |
Returns true if the subscription is not receiving publishes.
|
| PublishTime |
The when that the last notification received was published.
|
| SequenceNumber |
The sequence number assigned to the last notification message.
|
| Session |
The session that owns the subscription item.
|
| TimestampsToReturn |
The timestamps to return with the notification messages.
|
Events
| Name | Description | |
|---|---|---|
 | PublishStatusChanged |
Raised to indicate the publishing state for the subscription has stopped or resumed (see PublishingStopped property).
|
| StateChanged |
Raised to indicate that the state of the subscription has changed.
|
See Also
