TeamFoundationNotificationService.SubscribeEvent Method
SubscribeEvent is used to create a new event subscription to events that are fired on the server. Subscriptions can have several filters that enable to user to only recieve specific events.
Namespace: Microsoft.TeamFoundation.Framework.Server
Assembly: Microsoft.TeamFoundation.Framework.Server (in Microsoft.TeamFoundation.Framework.Server.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:
int SubscribeEvent(
TeamFoundationRequestContext^ requestContext,
IdentityDescriptor^ user,
String^ eventType,
String^ filterExpression,
DeliveryPreference^ preferences,
String^ classification
)
member SubscribeEvent :
requestContext:TeamFoundationRequestContext *
user:IdentityDescriptor *
eventType:string *
filterExpression:string *
preferences:DeliveryPreference *
classification:string -> int
public function SubscribeEvent(
requestContext : TeamFoundationRequestContext,
user : IdentityDescriptor,
eventType : String,
filterExpression : String,
preferences : DeliveryPreference,
classification : String
) : int
Parameters
requestContext
Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationRequestContextContext this operation is run.
user
Type: Microsoft.TeamFoundation.Framework.Server.IdentityDescriptorOptional: User to associate the request with. If an user is supplied other than the user making the request the calling user will need collection write permissions.
eventType
Type: System.StringType of event to subscribe to.
filterExpression
Type: System.StringFilter to apply to events.
preferences
Type: Microsoft.TeamFoundation.Framework.Server.DeliveryPreferenceThis defines how the notification should be delivered.
classification
Type: System.StringOptional: 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
- 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.