com.smartdevicelink.proxy.rpc

Class GetFile

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.GetFile

All Implemented Interfaces:

Cloneable

public class GetFile
extends RPCRequest

This request is sent to the module to retrieve a file

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_APP_SERVICE_ID
static String	KEY_FILE_NAME
static String	KEY_FILE_TYPE
static String	KEY_LENGTH
static String	KEY_OFFSET

Fields inherited from class com.smartdevicelink.proxy.RPCRequest

onResponseListener

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

function, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parameters

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
GetFile()
GetFile(Hashtable<String,Object> hash)
GetFile(String fileName)

Method Summary

Modifier and Type	Method and Description
String	getAppServiceId() ID of the service that should have uploaded the requested file
String	getFileName() File name that should be retrieved.
FileType	getFileType() Selected file type.
Integer	getLength() Optional length in bytes for resuming partial data chunks if offset is set to 0, then length is the total length of the file to be downloaded minvalue="0" maxvalue="2000000000"
Integer	getOffset() Optional offset in bytes for resuming partial data chunks minvalue="0" maxvalue="2000000000"
GetFile	setAppServiceId(String appServiceId) ID of the service that should have uploaded the requested file
GetFile	setFileName(String fileName) File name that should be retrieved.
GetFile	setFileType(FileType fileType) Selected file type.
GetFile	setLength(Integer length) Optional length in bytes for resuming partial data chunks if offset is set to 0, then length is the total length of the file to be downloaded minvalue="0" maxvalue="2000000000"
GetFile	setOffset(Integer offset) Optional offset in bytes for resuming partial data chunks minvalue="0" maxvalue="2000000000"

Methods inherited from class com.smartdevicelink.proxy.RPCRequest

getCorrelationID, getOnRPCResponseListener, setCorrelationID, setOnRPCResponseListener

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

getBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParameters

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_FILE_NAME

public static final String KEY_FILE_NAME

See Also:

Constant Field Values

KEY_APP_SERVICE_ID

public static final String KEY_APP_SERVICE_ID

See Also:

Constant Field Values

KEY_FILE_TYPE

public static final String KEY_FILE_TYPE

See Also:

Constant Field Values

KEY_OFFSET

public static final String KEY_OFFSET

See Also:

Constant Field Values

KEY_LENGTH

public static final String KEY_LENGTH

See Also:

Constant Field Values

Constructor Detail

GetFile

public GetFile()

GetFile

public GetFile(Hashtable<String,Object> hash)

GetFile

public GetFile(@NonNull
               String fileName)

Method Detail

setFileName

public GetFile setFileName(@NonNull
                           String fileName)

File name that should be retrieved. maxlength="255"

Parameters:

fileName - -

getFileName

public String getFileName()

File name that should be retrieved. maxlength="255"

Returns:

fileName

setAppServiceId

public GetFile setAppServiceId(String appServiceId)

ID of the service that should have uploaded the requested file

Parameters:

appServiceId - -

getAppServiceId

public String getAppServiceId()

ID of the service that should have uploaded the requested file

Returns:

appServiceId

setFileType

public GetFile setFileType(FileType fileType)

Selected file type.

Parameters:

fileType - -

getFileType

public FileType getFileType()

Selected file type.

Returns:

fileType

setOffset

public GetFile setOffset(Integer offset)

Optional offset in bytes for resuming partial data chunks minvalue="0" maxvalue="2000000000"

Parameters:

offset - -

getOffset

public Integer getOffset()

Optional offset in bytes for resuming partial data chunks minvalue="0" maxvalue="2000000000"

Returns:

offset

setLength

public GetFile setLength(Integer length)

Optional length in bytes for resuming partial data chunks if offset is set to 0, then length is the total length of the file to be downloaded minvalue="0" maxvalue="2000000000"

Parameters:

length - -

getLength

public Integer getLength()

Optional length in bytes for resuming partial data chunks if offset is set to 0, then length is the total length of the file to be downloaded minvalue="0" maxvalue="2000000000"

Returns:

length