com.smartdevicelink.proxy.rpc

Class GetFileResponse

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCResponse

com.smartdevicelink.proxy.rpc.GetFileResponse

All Implemented Interfaces:

Cloneable

public class GetFileResponse
extends RPCResponse

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_CRC
static String	KEY_FILE_TYPE
static String	KEY_LENGTH
static String	KEY_OFFSET

Fields inherited from class com.smartdevicelink.proxy.RPCResponse

KEY_INFO, KEY_RESULT_CODE, KEY_SUCCESS

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
GetFileResponse() Constructs a new PublishAppServiceResponse object
GetFileResponse(Boolean success, Result resultCode) Constructs a new PublishAppServiceResponse object
GetFileResponse(Hashtable<String,Object> hash)

Method Summary

Modifier and Type	Method and Description
Integer	getCRC() Additional CRC32 checksum to protect data integrity up to 512 Mbits minvalue="0" maxvalue="4294967295"
FileType	getFileType() File type that is being sent in response
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"
GetFileResponse	setCRC(Integer crc) Additional CRC32 checksum to protect data integrity up to 512 Mbits minvalue="0" maxvalue="4294967295"
GetFileResponse	setFileType(FileType fileType) File type that is being sent in response
GetFileResponse	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"
GetFileResponse	setOffset(Integer offset) Optional offset in bytes for resuming partial data chunks minvalue="0" maxvalue="2000000000"

Methods inherited from class com.smartdevicelink.proxy.RPCResponse

getCorrelationID, getInfo, getResultCode, getSuccess, setCorrelationID, setInfo, setResultCode, setSuccess

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_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

KEY_FILE_TYPE

public static final String KEY_FILE_TYPE

See Also:

Constant Field Values

KEY_CRC

public static final String KEY_CRC

See Also:

Constant Field Values

Constructor Detail

GetFileResponse

public GetFileResponse()

Constructs a new PublishAppServiceResponse object

GetFileResponse

public GetFileResponse(Hashtable<String,Object> hash)

GetFileResponse

public GetFileResponse(@NonNull
                       Boolean success,
                       @NonNull
                       Result resultCode)

Constructs a new PublishAppServiceResponse object

Parameters:

success - whether the request is successfully processed

resultCode - whether the request is successfully processed

Method Detail

setFileType

public GetFileResponse setFileType(FileType fileType)

File type that is being sent in response

Parameters:

fileType - -

getFileType

public FileType getFileType()

File type that is being sent in response

Returns:

fileType

setOffset

public GetFileResponse 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 GetFileResponse 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

setCRC

public GetFileResponse setCRC(Integer crc)

Additional CRC32 checksum to protect data integrity up to 512 Mbits minvalue="0" maxvalue="4294967295"

Parameters:

crc - -

getCRC

public Integer getCRC()

Additional CRC32 checksum to protect data integrity up to 512 Mbits minvalue="0" maxvalue="4294967295"

Returns:

crc