SALES: 1-800-867-1380

Subscription Class

Represents a Subscription entity.

System.Object
  Microsoft.ServiceBus.Messaging.Subscription

Namespace:  Microsoft.ServiceBus.Messaging
Assembly:  Microsoft.ServiceBus.Messaging (in Microsoft.ServiceBus.Messaging.dll)

public sealed class Subscription

The Subscription type exposes the following members.

  NameDescription
Public propertyDefaultMessageTimeToLiveGets the default message time to live of the subscription.
Public propertyEnableDeadLetteringOnFilterEvaluationExceptionsGets the value that indicates if this subscription has dead letter support on Filter evaluation exceptions.
Public propertyEnableDeadLetteringOnMessageExpirationGets the value that indicates if this subscription has dead letter support when a message expires.
Public propertyExtensionDataGets the additional information that describes any extension to a subscription description.
Public propertyLockDurationGets the lock duration time span associated with this subscription.
Public propertyNameGets the name of the subscription.
Public propertyNamespaceClientGets the namespace client that created or retrieved this subscription.
Public propertyRequiresSessionGets the value indicating if this subscription supports the concept of session. This reflects the value specified by RequiresSession when the subscription was created.
Public propertyTopicPathGets the path of the topic that this subscription belongs to.
Top

  NameDescription
Public methodAddRule(String, FilterExpression)Adds a rule to this subscription.
Public methodAddRule(String, RuleDescription)Adds a rule to this subscription.
Public methodBeginAddRule(String, FilterExpression, AsyncCallback, Object)Asynchronous version of the AddRule method.
Public methodBeginAddRule(String, RuleDescription, AsyncCallback, Object)Asynchronous version of the AddRule method.
Public methodBeginGetRuleAsynchronous version of the GetRule method.
Public methodBeginGetRulesAsynchronous version of the GetRules method.
Public methodBeginRemoveRuleAsynchronous version of the RemoveRule method.
Public methodEndAddRuleEnds an add rule operation.
Public methodEndGetRuleEnds a get rule.
Public methodEndGetRulesEnumerates end get rules in this collection.
Public methodEndRemoveRuleEnds a remove rule operation.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetDescriptionGets a copy of the subscription’s description.
Public methodGetHashCode (Inherited from Object.)
Public methodGetRuleGets a rule with the specified name. Returns null if the rule does not exist in this subscription.
Public methodGetRulesGets all rules in an enumerated collection.
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodRemoveRuleRemoves the rule described by ruleName.
Public methodToString (Inherited from Object.)
Top

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft