BoxClient.ExtractFolderAsync Method

Definition

Extract archive to folder

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Azure.Connectors.Sdk.Box.Models.BlobMetadata>> ExtractFolderAsync(string sourceArchiveFilePath, string destinationFolderPath, bool? overwrite = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ExtractFolderAsync : string * string * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Azure.Connectors.Sdk.Box.Models.BlobMetadata>>
override this.ExtractFolderAsync : string * string * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Azure.Connectors.Sdk.Box.Models.BlobMetadata>>
Public Overridable Function ExtractFolderAsync (sourceArchiveFilePath As String, destinationFolderPath As String, Optional overwrite As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of List(Of BlobMetadata))

Parameters

sourceArchiveFilePath
String

Source Archive File Path

destinationFolderPath
String

Destination Folder Path

overwrite
Nullable<Boolean>

Overwrite

cancellationToken
CancellationToken

Cancellation token.

Returns

The Extract archive to folder response.

Remarks

Extracts an archive file into a folder in Box (example: .zip).

Applies to