7b9502eb47 | ||
---|---|---|
ClientSamples | ||
ClientSamples.Runner | ||
ClientSamples.Tests.Integration | ||
.gitignore | ||
ClientSamples.sln | ||
LICENSE | ||
Program.cs | ||
README.md |
README.md
Visual Studio Team Services .NET Client Library Samples
Getting started
TBD
About the client libraries
For .NET developers building Windows apps and services that integrate with Visual Studio Team Services, client libraries are available for integrating with work item tracking, version control, build, and other services are now available. These packages replace the traditional TFS Client OM installer and make it easy to acquire and redistribute the libraries needed by your app or service.
Package | Description | When to use |
---|---|---|
Microsoft.TeamFoundationServer.ExtendedClient | Integrate with Microsoft Team Foundation Server (2012, 2013, 2015) and Visual Studio Team Services from desktop-based Windows applications. Work with and manage version control, work items, and build, and other resources from your client application. | Existing Windows apps leveraging an older version of the TFS Client OM. |
Microsoft.TeamFoundationServer.Client | Integrate with Team Foundation Server 2015 and Visual Studio Team Services from desktop-based, ASP.NET, and other Windows applications. Provides access to version control, work item tracking, build, and more via public REST APIs. | Window desktop apps and services that need to integrate with TFS 2015 and later and Visual Studio Team Services. |
Microsoft.VisualStudio.Services.Client | Integrate with Team Foundation Server 2015 and Visual Studio Team Services from desktop-based, ASP.NET, and other Windows applications. Provides access to shared platform services such as account, profile, identity, security, and more via public REST APIs. | Windows desktop apps and services that need to interact with "shared platform" services (account, profile, identity, security, etc). |
Microsoft.VisualStudio.Services.InteractiveClient | Integrate with Team Foundation Server 2015 and Visual Studio Team Services from desktop-based Windows applications that require interactive sign-in by a user. | Windows desktop applications not utilizing basic authentication or OAuth for authentication. |
Microsoft.VisualStudio.Services.DistributedTask.Client | Integrate with Team Foundation Server 2015 and Visual Studio Team Services from desktop-based, ASP.NET, and other Windows applications. Provides access to the Distributed Task Service via public REST APIs. | Window desktop apps and services that need to integrate with TFS 2015 and later and Visual Studio Team Services. |
Microsoft.VisualStudio.Services.Release.Client | Integrate with Team Foundation Server 2015 and Visual Studio Team Services from desktop-based, ASP.NET, and other Windows applications. Provides access to the Release Service via public REST APIs. | Window desktop apps and services that need to integrate with TFS 2015 and later and Visual Studio Team Services. |
Useful references
- [.NET Client library intro](https:// www.visualstudio.com/docs/integrate/get-started/client-libraries/dotnet)
- [WIQL reference](https:// msdn.microsoft.com/en-us/library/bb130198(v=vs.90).aspx)
Contributing to the samples
Guidelines for samples
- All samples must have an accompanying test
- Organization and naming
1 Samples for a particular area should live in a folder with that name (e.g.
Notification
) 2. The class name should be{Resource}Sample.cs
, where resource is the name of the resource (e.g.Subscriptions
) 3. Namespace should beVstsSamples.Client.{Area}
- Style
- Use line breaks and empty lines to help deliniate important sections or lines that need to stand out
- Use the same "dummy" data across all samples so it's easier to correlate similar concepts
- Coding
- Avoid
var
typed variables - Go out of your way to show types so it's clear from the sample what types are being used
- Include examples of exceptions when exceptions for a particular API are common
- Use constants from the client libraries for property names, etc instead of hard-coded strings
- Avoid
- All samples/snippets should be runnable on their own (without any input)