DashboardHttpClientBase.GetWidgetTypesAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Name | Description |
|---|---|
| GetWidgetTypesAsync(WidgetScope, Object, CancellationToken) |
[Preview API] Get all available widget metadata in alphabetical order. |
| GetWidgetTypesAsync(Guid, WidgetScope, Object, CancellationToken) |
[Preview API] Get all available widget metadata in alphabetical order. |
| GetWidgetTypesAsync(String, WidgetScope, Object, CancellationToken) |
[Preview API] Get all available widget metadata in alphabetical order. |
GetWidgetTypesAsync(WidgetScope, Object, CancellationToken)
[Preview API] Get all available widget metadata in alphabetical order.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.WidgetTypesResponse> GetWidgetTypesAsync(Microsoft.TeamFoundation.Dashboards.WebApi.WidgetScope scope, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetWidgetTypesAsync : Microsoft.TeamFoundation.Dashboards.WebApi.WidgetScope * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.WidgetTypesResponse>
override this.GetWidgetTypesAsync : Microsoft.TeamFoundation.Dashboards.WebApi.WidgetScope * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.WidgetTypesResponse>Parameters
- scope
- WidgetScope
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetWidgetTypesAsync(Guid, WidgetScope, Object, CancellationToken)
[Preview API] Get all available widget metadata in alphabetical order.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.WidgetTypesResponse> GetWidgetTypesAsync(Guid project, Microsoft.TeamFoundation.Dashboards.WebApi.WidgetScope scope, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetWidgetTypesAsync : Guid * Microsoft.TeamFoundation.Dashboards.WebApi.WidgetScope * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.WidgetTypesResponse>
override this.GetWidgetTypesAsync : Guid * Microsoft.TeamFoundation.Dashboards.WebApi.WidgetScope * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.WidgetTypesResponse>Parameters
- project
- Guid
Project ID
- scope
- WidgetScope
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetWidgetTypesAsync(String, WidgetScope, Object, CancellationToken)
[Preview API] Get all available widget metadata in alphabetical order.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.WidgetTypesResponse> GetWidgetTypesAsync(string project, Microsoft.TeamFoundation.Dashboards.WebApi.WidgetScope scope, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetWidgetTypesAsync : string * Microsoft.TeamFoundation.Dashboards.WebApi.WidgetScope * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.WidgetTypesResponse>
override this.GetWidgetTypesAsync : string * Microsoft.TeamFoundation.Dashboards.WebApi.WidgetScope * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.WidgetTypesResponse>Parameters
- project
- String
Project ID or project name
- scope
- WidgetScope
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.