Share via


TeamFoundationNotificationService.SubscribeEvent Method (TeamFoundationRequestContext, IdentityDescriptor, String, String, DeliveryPreference, String)

SubscribeEvent is used to create a new event subscription to events that are fired on the server. subscriptions can have a number of filters that enable to user to only recieve specific events.

Namespace:  Microsoft.TeamFoundation.Server.Core
Assembly:  Microsoft.TeamFoundation.Server.Core (in Microsoft.TeamFoundation.Server.Core.dll)

Syntax

'Declaration
Public Function SubscribeEvent ( _
    requestContext As TeamFoundationRequestContext, _
    user As IdentityDescriptor, _
    eventType As String, _
    filterExpression As String, _
    preferences As DeliveryPreference, _
    classification As String _
) As Integer
public int SubscribeEvent(
    TeamFoundationRequestContext requestContext,
    IdentityDescriptor user,
    string eventType,
    string filterExpression,
    DeliveryPreference preferences,
    string classification
)
public:
virtual int SubscribeEvent(
    TeamFoundationRequestContext^ requestContext, 
    IdentityDescriptor^ user, 
    String^ eventType, 
    String^ filterExpression, 
    DeliveryPreference^ preferences, 
    String^ classification
) sealed
abstract SubscribeEvent : 
        requestContext:TeamFoundationRequestContext * 
        user:IdentityDescriptor * 
        eventType:string * 
        filterExpression:string * 
        preferences:DeliveryPreference * 
        classification:string -> int  
override SubscribeEvent : 
        requestContext:TeamFoundationRequestContext * 
        user:IdentityDescriptor * 
        eventType:string * 
        filterExpression:string * 
        preferences:DeliveryPreference * 
        classification:string -> int
public final function SubscribeEvent(
    requestContext : TeamFoundationRequestContext, 
    user : IdentityDescriptor, 
    eventType : String, 
    filterExpression : String, 
    preferences : DeliveryPreference, 
    classification : String
) : int

Parameters

  • filterExpression
    Type: System.String

    Filter to apply to events.

  • classification
    Type: System.String

    Optional: Some events define classifications which can be used as filter criteria to pinpoint specific events.

Return Value

Type: System.Int32
The subscription identifier.

.NET Framework Security

See Also

Reference

TeamFoundationNotificationService Class

SubscribeEvent Overload

Microsoft.TeamFoundation.Server.Core Namespace