 | ChannelMoveFile Method (String, Channel, String, String, String) |
Moves or renames a file. If the source and target channels and paths are the same, the file will simply be renamed.
Namespace:
TeamSpeak.Sdk.Client
Assembly:
TeamSpeak.Sdk (in TeamSpeak.Sdk.dll) Version: 0.1.6124.20226 (0.1.0.0)
Syntaxpublic Task MoveFile(
string file,
Channel toChannel,
string toFile,
string channelPassword = null,
string toChannelPassword = null
)
Public Function MoveFile (
file As String,
toChannel As Channel,
toFile As String,
Optional channelPassword As String = Nothing,
Optional toChannelPassword As String = Nothing
) As Task
public:
Task^ MoveFile(
String^ file,
Channel^ toChannel,
String^ toFile,
String^ channelPassword = nullptr,
String^ toChannelPassword = nullptr
)
member MoveFile :
file : string *
toChannel : Channel *
toFile : string *
?channelPassword : string *
?toChannelPassword : string
(* Defaults:
let _channelPassword = defaultArg channelPassword null
let _toChannelPassword = defaultArg toChannelPassword null
*)
-> Task
Parameters
- file
- Type: SystemString
Old name of the file. The file name needs to include the full path within the channel, e.g. “/file” for a top-level file or “/dir1/dir2/file” for a file located in a subdirectory. - toChannel
- Type: TeamSpeak.Sdk.ClientChannel
Target channel, to which we want to move the file. - toFile
- Type: SystemString
New name of the file. The new name needs to include the full path within the channel, e.g. “/file” for a top-level file or “/dir1/dir2/file” for a file located in a subdirectory. - channelPassword (Optional)
- Type: SystemString
Optional channel password. Pass empty string or null if unused. - toChannelPassword (Optional)
- Type: SystemString
Optional channel password. Pass empty string or null if unused.
Return Value
Type:
TaskA task that represents the asynchronous operation.
See Also