 | ChannelRequestFile Method (String, String, Boolean, Boolean, String) |
Download a file from the server.
Namespace:
TeamSpeak.Sdk.Client
Assembly:
TeamSpeak.Sdk (in TeamSpeak.Sdk.dll) Version: 0.1.6124.20226 (0.1.0.0)
Syntaxpublic Task RequestFile(
string fileName,
string destinationDirectory,
bool overwrite = false,
bool resume = false,
string channelPassword = null
)
Public Function RequestFile (
fileName As String,
destinationDirectory As String,
Optional overwrite As Boolean = false,
Optional resume As Boolean = false,
Optional channelPassword As String = Nothing
) As Task
public:
Task^ RequestFile(
String^ fileName,
String^ destinationDirectory,
bool overwrite = false,
bool resume = false,
String^ channelPassword = nullptr
)
member RequestFile :
fileName : string *
destinationDirectory : string *
?overwrite : bool *
?resume : bool *
?channelPassword : string
(* Defaults:
let _overwrite = defaultArg overwrite false
let _resume = defaultArg resume false
let _channelPassword = defaultArg channelPassword null
*)
-> Task
Parameters
- fileName
- Type: SystemString
Filename of the remote file, which is to be downloaded. - destinationDirectory
- Type: SystemString
Local target directory name where the download file should be saved. - overwrite (Optional)
- Type: SystemBoolean
when false, download will abort if local file exists - resume (Optional)
- Type: SystemBoolean
If we have a previously halted transfer: true = resume, false = restart transfer - channelPassword (Optional)
- Type: SystemString
Optional channel password. Pass empty string or null if unused.
Return Value
Type:
TaskA task that represents the asynchronous download operation.
See Also