TaskAgentHttpClientBase.DownloadSecureFileAsync 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
| DownloadSecureFileAsync(Guid, Guid, String, Nullable<Boolean>, Object, CancellationToken) |
[Preview API] Download a secure file by Id |
| DownloadSecureFileAsync(String, Guid, String, Nullable<Boolean>, Object, CancellationToken) |
[Preview API] Download a secure file by Id |
DownloadSecureFileAsync(Guid, Guid, String, Nullable<Boolean>, Object, CancellationToken)
[Preview API] Download a secure file by Id
public virtual System.Threading.Tasks.Task<System.IO.Stream> DownloadSecureFileAsync(Guid project, Guid secureFileId, string ticket, Nullable<bool> download = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member DownloadSecureFileAsync : Guid * Guid * string * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>
override this.DownloadSecureFileAsync : Guid * Guid * string * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>Parameters
- project
- Guid
Project ID
- secureFileId
- Guid
The unique secure file Id
- ticket
- String
A valid download ticket
If download is true, the file is sent as attachement in the response body. If download is false, the response body contains the file stream.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
DownloadSecureFileAsync(String, Guid, String, Nullable<Boolean>, Object, CancellationToken)
[Preview API] Download a secure file by Id
public virtual System.Threading.Tasks.Task<System.IO.Stream> DownloadSecureFileAsync(string project, Guid secureFileId, string ticket, Nullable<bool> download = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member DownloadSecureFileAsync : string * Guid * string * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>
override this.DownloadSecureFileAsync : string * Guid * string * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>Parameters
- project
- String
Project ID or project name
- secureFileId
- Guid
The unique secure file Id
- ticket
- String
A valid download ticket
If download is true, the file is sent as attachement in the response body. If download is false, the response body contains the file stream.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.