TaskAgentHttpClientBase.GetSecureFileAsync 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
| GetSecureFileAsync(Guid, Guid, Nullable<Boolean>, Nullable<SecureFileActionFilter>, Object, CancellationToken) |
[Preview API] Get a secure file |
| GetSecureFileAsync(String, Guid, Nullable<Boolean>, Nullable<SecureFileActionFilter>, Object, CancellationToken) |
[Preview API] Get a secure file |
GetSecureFileAsync(Guid, Guid, Nullable<Boolean>, Nullable<SecureFileActionFilter>, Object, CancellationToken)
[Preview API] Get a secure file
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.DistributedTask.WebApi.SecureFile> GetSecureFileAsync(Guid project, Guid secureFileId, Nullable<bool> includeDownloadTicket = null, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.SecureFileActionFilter> actionFilter = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetSecureFileAsync : Guid * Guid * Nullable<bool> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.SecureFileActionFilter> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.DistributedTask.WebApi.SecureFile>
override this.GetSecureFileAsync : Guid * Guid * Nullable<bool> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.SecureFileActionFilter> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.DistributedTask.WebApi.SecureFile>Parameters
- project
- Guid
Project ID
- secureFileId
- Guid
The unique secure file Id
If includeDownloadTicket is true and the caller has permissions, a download ticket is included in the response.
- actionFilter
- Nullable<SecureFileActionFilter>
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetSecureFileAsync(String, Guid, Nullable<Boolean>, Nullable<SecureFileActionFilter>, Object, CancellationToken)
[Preview API] Get a secure file
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.DistributedTask.WebApi.SecureFile> GetSecureFileAsync(string project, Guid secureFileId, Nullable<bool> includeDownloadTicket = null, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.SecureFileActionFilter> actionFilter = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetSecureFileAsync : string * Guid * Nullable<bool> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.SecureFileActionFilter> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.DistributedTask.WebApi.SecureFile>
override this.GetSecureFileAsync : string * Guid * Nullable<bool> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.SecureFileActionFilter> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.DistributedTask.WebApi.SecureFile>Parameters
- project
- String
Project ID or project name
- secureFileId
- Guid
The unique secure file Id
If includeDownloadTicket is true and the caller has permissions, a download ticket is included in the response.
- actionFilter
- Nullable<SecureFileActionFilter>
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.