C# Class Microsoft.AspNet.WebHooks.VstsWebHookHandlerBase

Provides a base IWebHookHandler implementation which can be used to for handling Visual Studio Team Services WebHook using strongly-typed payloads. For details about MyGet WebHooks, see https://www.visualstudio.com/en-us/get-started/integrate/service-hooks/webhooks-and-vso-vs.

Inheritance: WebHookHandler

Show file Open project: aspnet/WebHooks

Public Methods

Method	Description
ExecuteAsync ( WebHookHandlerContext context, BuildCompletedPayload payload ) : System.Threading.Tasks.Task	Executes the incoming WebHook request for event '`build.complete`'.
ExecuteAsync ( WebHookHandlerContext context, CodeCheckedInPayload payload ) : System.Threading.Tasks.Task	Executes the incoming WebHook request for event '`tfvc.checkin`'.
ExecuteAsync ( WebHookHandlerContext context, GitPullRequestCreatedPayload payload ) : System.Threading.Tasks.Task	Executes the incoming WebHook request for event '`git.pullrequest.created`'.
ExecuteAsync ( WebHookHandlerContext context, GitPullRequestUpdatedPayload payload ) : System.Threading.Tasks.Task	Executes the incoming WebHook request for event '`git.pullrequest.updated`'.
ExecuteAsync ( WebHookHandlerContext context, GitPushPayload payload ) : System.Threading.Tasks.Task	Executes the incoming WebHook request for event '`git.push`'.
ExecuteAsync ( WebHookHandlerContext context, Newtonsoft.Json.Linq.JObject payload ) : System.Threading.Tasks.Task	Executes the incoming WebHook request for unknown event.
ExecuteAsync ( WebHookHandlerContext context, TeamRoomMessagePostedPayload payload ) : System.Threading.Tasks.Task	Executes the incoming WebHook request for event '`message.posted`'.
ExecuteAsync ( WebHookHandlerContext context, WorkItemCommentedOnPayload payload ) : System.Threading.Tasks.Task	Executes the incoming WebHook request for event '`workitem.commented`'.
ExecuteAsync ( WebHookHandlerContext context, WorkItemCreatedPayload payload ) : System.Threading.Tasks.Task	Executes the incoming WebHook request for event '`workitem.created`'.
ExecuteAsync ( WebHookHandlerContext context, WorkItemDeletedPayload payload ) : System.Threading.Tasks.Task	Executes the incoming WebHook request for event '`workitem.deleted`'.
ExecuteAsync ( WebHookHandlerContext context, WorkItemRestoredPayload payload ) : System.Threading.Tasks.Task	Executes the incoming WebHook request for event '`workitem.restored`'.
ExecuteAsync ( WebHookHandlerContext context, WorkItemUpdatedPayload payload ) : System.Threading.Tasks.Task	Executes the incoming WebHook request for event '`workitem.updated`'.
ExecuteAsync ( string receiver, WebHookHandlerContext context ) : System.Threading.Tasks.Task

Protected Methods

Method	Description
VstsWebHookHandlerBase ( ) : System	Initializes a new instance of the VstsWebHookHandlerBase class.

Method Details

ExecuteAsync() public method

Executes the incoming WebHook request for event 'build.complete'.

public ExecuteAsync ( WebHookHandlerContext context, BuildCompletedPayload payload ) : System.Threading.Tasks.Task
context	WebHookHandlerContext	Provides context for the for further processing the incoming WebHook.
payload	BuildCompletedPayload	Strong-typed WebHook payload.
return	System.Threading.Tasks.Task

ExecuteAsync() public method

Executes the incoming WebHook request for event 'tfvc.checkin'.

public ExecuteAsync ( WebHookHandlerContext context, CodeCheckedInPayload payload ) : System.Threading.Tasks.Task
context	WebHookHandlerContext	Provides context for the for further processing the incoming WebHook.
payload	CodeCheckedInPayload	Strong-typed WebHook payload.
return	System.Threading.Tasks.Task

ExecuteAsync() public method

Executes the incoming WebHook request for event 'git.pullrequest.created'.

public ExecuteAsync ( WebHookHandlerContext context, GitPullRequestCreatedPayload payload ) : System.Threading.Tasks.Task
context	WebHookHandlerContext	Provides context for the for further processing the incoming WebHook.
payload	GitPullRequestCreatedPayload	Strong-typed WebHook payload.
return	System.Threading.Tasks.Task

ExecuteAsync() public method

Executes the incoming WebHook request for event 'git.pullrequest.updated'.

public ExecuteAsync ( WebHookHandlerContext context, GitPullRequestUpdatedPayload payload ) : System.Threading.Tasks.Task
context	WebHookHandlerContext	Provides context for the for further processing the incoming WebHook.
payload	GitPullRequestUpdatedPayload	Strong-typed WebHook payload.
return	System.Threading.Tasks.Task

ExecuteAsync() public method

Executes the incoming WebHook request for event 'git.push'.

public ExecuteAsync ( WebHookHandlerContext context, GitPushPayload payload ) : System.Threading.Tasks.Task
context	WebHookHandlerContext	Provides context for the for further processing the incoming WebHook.
payload	GitPushPayload	Strong-typed WebHook payload.
return	System.Threading.Tasks.Task

ExecuteAsync() public method

Executes the incoming WebHook request for unknown event.

public ExecuteAsync ( WebHookHandlerContext context, Newtonsoft.Json.Linq.JObject payload ) : System.Threading.Tasks.Task
context	WebHookHandlerContext	Provides context for the for further processing the incoming WebHook.
payload	Newtonsoft.Json.Linq.JObject	JSON payload.
return	System.Threading.Tasks.Task

ExecuteAsync() public method

Executes the incoming WebHook request for event 'message.posted'.

public ExecuteAsync ( WebHookHandlerContext context, TeamRoomMessagePostedPayload payload ) : System.Threading.Tasks.Task
context	WebHookHandlerContext	Provides context for the for further processing the incoming WebHook.
payload	TeamRoomMessagePostedPayload	Strong-typed WebHook payload.
return	System.Threading.Tasks.Task

ExecuteAsync() public method

Executes the incoming WebHook request for event 'workitem.commented'.

public ExecuteAsync ( WebHookHandlerContext context, WorkItemCommentedOnPayload payload ) : System.Threading.Tasks.Task
context	WebHookHandlerContext	Provides context for the for further processing the incoming WebHook.
payload	WorkItemCommentedOnPayload	Strong-typed WebHook payload.
return	System.Threading.Tasks.Task

ExecuteAsync() public method

Executes the incoming WebHook request for event 'workitem.created'.

public ExecuteAsync ( WebHookHandlerContext context, WorkItemCreatedPayload payload ) : System.Threading.Tasks.Task
context	WebHookHandlerContext	Provides context for the for further processing the incoming WebHook.
payload	WorkItemCreatedPayload	Strong-typed WebHook payload.
return	System.Threading.Tasks.Task

ExecuteAsync() public method

Executes the incoming WebHook request for event 'workitem.deleted'.

public ExecuteAsync ( WebHookHandlerContext context, WorkItemDeletedPayload payload ) : System.Threading.Tasks.Task
context	WebHookHandlerContext	Provides context for the for further processing the incoming WebHook.
payload	WorkItemDeletedPayload	Strong-typed WebHook payload.
return	System.Threading.Tasks.Task

ExecuteAsync() public method

Executes the incoming WebHook request for event 'workitem.restored'.

public ExecuteAsync ( WebHookHandlerContext context, WorkItemRestoredPayload payload ) : System.Threading.Tasks.Task
context	WebHookHandlerContext	Provides context for the for further processing the incoming WebHook.
payload	WorkItemRestoredPayload	Strong-typed WebHook payload.
return	System.Threading.Tasks.Task

ExecuteAsync() public method

Executes the incoming WebHook request for event 'workitem.updated'.

public ExecuteAsync ( WebHookHandlerContext context, WorkItemUpdatedPayload payload ) : System.Threading.Tasks.Task
context	WebHookHandlerContext	Provides context for the for further processing the incoming WebHook.
payload	WorkItemUpdatedPayload	Strong-typed WebHook payload.
return	System.Threading.Tasks.Task

ExecuteAsync() public method

public ExecuteAsync ( string receiver, WebHookHandlerContext context ) : System.Threading.Tasks.Task
receiver	string
context	WebHookHandlerContext
return	System.Threading.Tasks.Task

VstsWebHookHandlerBase() protected method

Initializes a new instance of the VstsWebHookHandlerBase class.

protected VstsWebHookHandlerBase ( ) : System
return	System