DashboardHttpClientBase.GetWidgetMetadataAsync 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 |
|---|---|
| GetWidgetMetadataAsync(String, String, Object, CancellationToken) |
[Preview API] Get the widget metadata satisfying the specified contribution ID. |
| GetWidgetMetadataAsync(String, Object, CancellationToken) |
[Preview API] Get the widget metadata satisfying the specified contribution ID. |
| GetWidgetMetadataAsync(Guid, String, Object, CancellationToken) |
[Preview API] Get the widget metadata satisfying the specified contribution ID. |
GetWidgetMetadataAsync(String, String, Object, CancellationToken)
[Preview API] Get the widget metadata satisfying the specified contribution ID.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.WidgetMetadataResponse> GetWidgetMetadataAsync(string project, string contributionId, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetWidgetMetadataAsync : string * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.WidgetMetadataResponse>
override this.GetWidgetMetadataAsync : string * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.WidgetMetadataResponse>Parameters
- project
- String
Project ID or project name
- contributionId
- String
The ID of Contribution for the Widget
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetWidgetMetadataAsync(String, Object, CancellationToken)
[Preview API] Get the widget metadata satisfying the specified contribution ID.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.WidgetMetadataResponse> GetWidgetMetadataAsync(string contributionId, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetWidgetMetadataAsync : string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.WidgetMetadataResponse>
override this.GetWidgetMetadataAsync : string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.WidgetMetadataResponse>Parameters
- contributionId
- String
The ID of Contribution for the Widget
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetWidgetMetadataAsync(Guid, String, Object, CancellationToken)
[Preview API] Get the widget metadata satisfying the specified contribution ID.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.WidgetMetadataResponse> GetWidgetMetadataAsync(Guid project, string contributionId, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetWidgetMetadataAsync : Guid * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.WidgetMetadataResponse>
override this.GetWidgetMetadataAsync : Guid * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.WidgetMetadataResponse>Parameters
- project
- Guid
Project ID
- contributionId
- String
The ID of Contribution for the Widget
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.