Table of Contents

Class SubscriptionFilter

Namespace
Skyline.DataMiner.Net
Assembly
SLNetTypes.dll

SubscriptionFilters are used in CreateSubscriptionMessage to indicate which types of messages should be subscribed to. The different types of SubscriptionFilter objects can be used to subscribe with a certain level of granularity:

  • SubscriptionFilter: Subscribes to all messages of a given type (DMS).
  • SubscriptionFilterCluster: Limits subscription to one particular cluster.
  • SubscriptionFilterDMA: Limits messages to one particular DataMiner Agent.
  • SubscriptionFilterElement: Limits messages to one particular element.
  • SubscriptionFilterParameter: Limits messages to one particular parameter. 
[Serializable]
public class SubscriptionFilter
Inheritance
SubscriptionFilter
Extension Methods

Constructors

SubscriptionFilter()

Initializes a new instance of the SubscriptionFilter class.

SubscriptionFilter(SubscriptionFilter)
SubscriptionFilter(string)

Initializes a new instance of the SubscriptionFilter class.

SubscriptionFilter(string, string[])

Initializes a new instance of the SubscriptionFilter class.

SubscriptionFilter(Type)

Initializes a new SubscriptionFilter instance for the given message type.

SubscriptionFilter(Type, SubscriptionFilterOptions)

Initializes a new instance of the SubscriptionFilter class.

Fields

BaseMessageType

Message type from which all messages must derive.

BaseNameSpace

Base namespace for messages. If message types are within this namespace, they can be qualified with their type name only, without the need to specify the full type namespace.

Filters

Extra filters. Can currently be used for AlarmEventMessage filters (alarmfilter combinations) and parameter change subscriptions (partial table subscription info).

MessageType

The type of messages this SubscriptionFilter handles.

Properties

MessageTypeWithFilterInfo

Same as MessageType, but if filters are specified, also contains the list of filters in the string. Used by ToString().

Options

Gets or sets extra options, such as "skip initial events"

Methods

Clone()

Returns a (deep) clone of this object

Equals(object)

Checks if two SubscriptionFilter objects are identical.

EqualsSet(SubscriptionFilter[], SubscriptionFilter[])

Checks if the two given sets of subscription filters contain the same items.

EqualsSet(List<SubscriptionFilter>, List<SubscriptionFilter>)

Checks if the two given sets of subscription filters contain the same items.

GetHashCode()

Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.

HasOption(SubscriptionFilterOptions)

Determines whether the specified option is present.

ToString()

Converts to string.

ToType(string)

Converts a given type name (e.g. AlarmEventMessage) into the associated Type object.

ToTypeName(Type)

Gets the name of the type (e.g. AlarmEventMessage) that needs to be used in a subscription filter if one wants to subscribe to the given type of messages.

ToTypeObject()

Returns the Type object that corresponds to the MessageType that is specified in the SubscriptionFilter.

Propose changes