com.github.theholywaffle.teamspeak3.api.wrapper

Class FileTransfer

java.lang.Object

com.github.theholywaffle.teamspeak3.api.wrapper.Wrapper

com.github.theholywaffle.teamspeak3.api.wrapper.FileTransfer

public class FileTransfer
extends Wrapper

Field Summary

Fields inherited from class com.github.theholywaffle.teamspeak3.api.wrapper.Wrapper

EMPTY

Constructor Summary

Constructors

Constructor and Description
FileTransfer(Map<String,String> map)

Method Summary

Modifier and Type	Method and Description
double	getAverageSpeed() Returns the current file transfer speed in bytes per second.
int	getClientId() Gets the ID of the client who started this file transfer.
int	getClientTransferId() Returns the key that the client has sent to the server to identify their file transfer.
double	getCurrentSpeed() Returns the current file transfer speed in bytes per second.
String	getDiskFilePath() Gets the path of the folder that the file which is being transferred is stored in on disk.
String	getFileName() Returns the name of the file on the TS3 server without its full path.
long	getRuntime() Returns how many milliseconds have elapsed since the file transfer was first announced to the server.
int	getServerTransferId() Returns an internal ID that the server uses to identify their file transfer.
int	getStatus() Returns the current status of the file transfer.
long	getTotalFileSize() Gets the size in bytes the file will have once it is fully transferred.
long	getTransferredFileSize() Gets the amount of bytes that have already been transferred.
boolean	hasStarted() Returns true if the file transfer has started.
boolean	isActive() Returns true if the file transfer is still active.

Methods inherited from class com.github.theholywaffle.teamspeak3.api.wrapper.Wrapper

get, get, getBoolean, getBoolean, getDouble, getDouble, getInt, getInt, getLong, getLong, getMap, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FileTransfer

public FileTransfer(Map<String,String> map)

Method Detail

getClientId

public int getClientId()

Gets the ID of the client who started this file transfer.

Returns:

the ID of the involved client

getDiskFilePath

public String getDiskFilePath()

Gets the path of the folder that the file which is being transferred is stored in on disk. This path seems to be relative to the folder the TS3 server is installed in.

Returns:

the disk path of the folder containing the transferring file

getFileName

public String getFileName()

Returns the name of the file on the TS3 server without its full path.

Returns:

the file's name

getTotalFileSize

public long getTotalFileSize()

Gets the size in bytes the file will have once it is fully transferred.

Returns:

the final file size in bytes

getTransferredFileSize

public long getTransferredFileSize()

Gets the amount of bytes that have already been transferred.

Returns:

the amount of transferred bytes

getClientTransferId

public int getClientTransferId()

Returns the key that the client has sent to the server to identify their file transfer.

Returns:

the client's file transfer ID

getServerTransferId

public int getServerTransferId()

Returns an internal ID that the server uses to identify their file transfer. This is not the key that can be used to request a file from the file server.

Returns:

the server's file transfer ID

getStatus

public int getStatus()

Returns the current status of the file transfer.

Currently known status codes:

• 0 - Not started
• 1 - Active
• 2 - Inactive (paused, stalled or done)

Returns:

the current transfer status

hasStarted

public boolean hasStarted()

Returns true if the file transfer has started.

Returns:

whether the file transfer has started

isActive

public boolean isActive()

Returns true if the file transfer is still active. This is the case when the transfer has started and is not done or paused.

Returns:

whether the file transfer is active

getCurrentSpeed

public double getCurrentSpeed()

Returns the current file transfer speed in bytes per second.

Returns:

the current transfer speed

getAverageSpeed

public double getAverageSpeed()

Returns the current file transfer speed in bytes per second.

Returns:

the current transfer speed

getRuntime

public long getRuntime()

Returns how many milliseconds have elapsed since the file transfer was first announced to the server. This value will count up even if the file transfer has not yet been started, but will stop if the transfer has been paused or is complete.

Returns:

the transfer runtime in milliseconds