Subscription Class

Represents a Subscription entity.

Inheritance Hierarchy

System.Object
  Microsoft.ServiceBus.Messaging.Subscription

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

Syntax

'Declaration
Public NotInheritable Class Subscription
'Usage
Dim instance As Subscription
public sealed class Subscription
public ref class Subscription sealed
[<SealedAttribute>]
type Subscription =  class end
public final class Subscription

The Subscription type exposes the following members.

Properties

  Name Description
Public property DefaultMessageTimeToLive Gets the default message time to live of the subscription.
Public property EnableDeadLetteringOnFilterEvaluationExceptions Gets the value that indicates if this subscription has dead letter support on Filter evaluation exceptions.
Public property EnableDeadLetteringOnMessageExpiration Gets the value that indicates if this subscription has dead letter support when a message expires.
Public property ExtensionData Gets the additional information that describes any extension to a subscription description.
Public property LockDuration Gets the lock duration time span associated with this subscription.
Public property Name Gets the name of the subscription.
Public property NamespaceClient Gets the namespace client that created or retrieved this subscription.
Public property RequiresSession Gets the value indicating if this subscription supports the concept of session. This reflects the value specified by RequiresSession when the subscription was created.
Public property TopicPath Gets the path of the topic that this subscription belongs to.

Top

Methods

  Name Description
Public method AddRule(String, FilterExpression) Adds a rule to this subscription.
Public method AddRule(String, RuleDescription) Adds a rule to this subscription.
Public method BeginAddRule(String, FilterExpression, AsyncCallback, Object) Asynchronous version of the AddRule method.
Public method BeginAddRule(String, RuleDescription, AsyncCallback, Object) Asynchronous version of the AddRule method.
Public method BeginGetRule Asynchronous version of the GetRule method.
Public method BeginGetRules Asynchronous version of the GetRules method.
Public method BeginRemoveRule Asynchronous version of the RemoveRule method.
Public method EndAddRule Ends an add rule operation.
Public method EndGetRule Ends a get rule.
Public method EndGetRules Enumerates end get rules in this collection.
Public method EndRemoveRule Ends a remove rule operation.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetDescription Gets a copy of the subscription’s description.
Public method GetHashCode (Inherited from Object.)
Public method GetRule Gets a rule with the specified name. Returns null if the rule does not exist in this subscription.
Public method GetRules Gets all rules in an enumerated collection.
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method RemoveRule Removes the rule described by ruleName.
Public method ToString (Inherited from Object.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.ServiceBus.Messaging Namespace