com.github.theholywaffle.teamspeak3.api.wrapper

Class FileTransferParameters

java.lang.Object

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

com.github.theholywaffle.teamspeak3.api.wrapper.FileTransferParameters

public class FileTransferParameters
extends Wrapper

Represents an internally started file transfer and encapsulates the command response.

Field Summary

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

EMPTY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	getClientTransferId() Returns the key that the client has sent to the server to identify their file transfer.
String	getFileServerHost() Gets the IP address or hostname of the file server the TS3 instance wants us to send our data to.
int	getFileServerPort() Gets the port of the file server the TS3 instance wants us to send our data to.
long	getFileSize() Gets the size of the file being downloaded in bytes.
String	getFileTransferKey() Gets the key needed identify ourselves to the file server and to start the file transfer.
String	getMessage() Gets the message that is provided in case the command fails.
QueryError	getQueryError() Gets a QueryError that can be used when throwing an exception.
int	getServerTransferId() Returns an internal ID that the server uses to identify their file transfer.
int	getStatus() Gets the status / error code of this command.

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

FileTransferParameters

public FileTransferParameters(Map<String,String> map)

Method Detail

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

getFileTransferKey

public String getFileTransferKey()

Gets the key needed identify ourselves to the file server and to start the file transfer.

Returns:

the file transfer key

getFileServerHost

public String getFileServerHost()

Gets the IP address or hostname of the file server the TS3 instance wants us to send our data to.

Returns:

the IP address of the file server

getFileServerPort

public int getFileServerPort()

Gets the port of the file server the TS3 instance wants us to send our data to.

Returns:

the port of the file server

getFileSize

public long getFileSize()

Gets the size of the file being downloaded in bytes. Only present if this is a successfully started download.

Returns:

the size of the file being downloaded.

getQueryError

public QueryError getQueryError()

Gets a QueryError that can be used when throwing an exception.

Returns:

a query error for this command's success value

getStatus

public int getStatus()

Gets the status / error code of this command. Only present if the command failed.

Returns:

the command's status value

getMessage

public String getMessage()

Gets the message that is provided in case the command fails.

Returns:

the failure message