Share via


IEventService.SubscribeEvent Method (String, String, String, DeliveryPreference, String)

Subscribes the specified user to the event.

Namespace:  Microsoft.TeamFoundation.Framework.Client
Assembly:  Microsoft.TeamFoundation.Client (in Microsoft.TeamFoundation.Client.dll)

Syntax

'Declaration
Function SubscribeEvent ( _
    userId As String, _
    eventType As String, _
    filterExpression As String, _
    preferences As DeliveryPreference, _
    classification As String _
) As Integer
int SubscribeEvent(
    string userId,
    string eventType,
    string filterExpression,
    DeliveryPreference preferences,
    string classification
)
int SubscribeEvent(
    String^ userId, 
    String^ eventType, 
    String^ filterExpression, 
    DeliveryPreference^ preferences, 
    String^ classification
)
abstract SubscribeEvent : 
        userId:string * 
        eventType:string * 
        filterExpression:string * 
        preferences:DeliveryPreference * 
        classification:string -> int
function SubscribeEvent(
    userId : String, 
    eventType : String, 
    filterExpression : String, 
    preferences : DeliveryPreference, 
    classification : String
) : int

Parameters

  • eventType
    Type: System.String

    The fully qualified name of the event type.

  • filterExpression
    Type: System.String

    A string that describes how to filter instances of the event type.

  • classification
    Type: System.String

    A classification tag for the event subscription.

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

See Also

Reference

IEventService Interface

SubscribeEvent Overload

Microsoft.TeamFoundation.Framework.Client Namespace