Subscribes the caller to an event.
Namespace: Microsoft.TeamFoundation.Framework.Client
Assembly: Microsoft.TeamFoundation.Client (in Microsoft.TeamFoundation.Client.dll)
Syntax
'Declaration
Function SubscribeEvent ( _
eventType As String, _
filterExpression As String, _
preferences As DeliveryPreference _
) As Integer
int SubscribeEvent(
string eventType,
string filterExpression,
DeliveryPreference preferences
)
int SubscribeEvent(
String^ eventType,
String^ filterExpression,
DeliveryPreference^ preferences
)
abstract SubscribeEvent :
eventType:string *
filterExpression:string *
preferences:DeliveryPreference -> int
function SubscribeEvent(
eventType : String,
filterExpression : String,
preferences : DeliveryPreference
) : int
Parameters
eventType
Type: System.StringThe fully qualified name of the event type.
filterExpression
Type: System.StringA string that describes how to filter instances of the event type.
preferences
Type: Microsoft.TeamFoundation.Framework.Client.DeliveryPreferenceDescribes how an event notification is delivered.
Return Value
Type: System.Int32
A unique identifier that represents the SubscriptionId.
Remarks
The SubscriptionId can unsubscribe from the subscription.
Users can have multiple subscriptions to the same event type but receive only one notification, regardless of the number of matching subscriptions.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.