Class GetFile
Hierarchy
java.lang.Object
com.smartdevicelink.proxy.RPCStruct
com.smartdevicelink.proxy.RPCMessage
com.smartdevicelink.proxy.RPCRequest
- Package
- com.smartdevicelink.proxy.rpc
Overview
This request is sent to the module to retrieve a fileQuick Jump
- Fields
- Constructors
- Methods
Fields
KEY_FILE_NAME
public static final java.lang.String KEY_FILE_NAME
- Constant Value
- "fileName"
KEY_APP_SERVICE_ID
public static final java.lang.String KEY_APP_SERVICE_ID
- Constant Value
- "appServiceId"
KEY_FILE_TYPE
public static final java.lang.String KEY_FILE_TYPE
- Constant Value
- "fileType"
KEY_OFFSET
public static final java.lang.String KEY_OFFSET
- Constant Value
- "offset"
KEY_LENGTH
public static final java.lang.String KEY_LENGTH
- Constant Value
- "length"
Inherited Fields
Constructors
GetFile()
public GetFile()
GetFile( java.util.Hashtable<java.lang.String, java.lang.Object> hash )
public GetFile(java.util.Hashtable<java.lang.String, java.lang.Object> hash)
Constructor Parameters
- hash
GetFile( String fileName )
public GetFile(String fileName)
Constructor Parameters
- fileName
Methods
setFileName( String fileName )
File name that should be retrieved. maxlength="255"
public com.smartdevicelink.proxy.rpc.GetFile setFileName(String fileName)
Method Parameters
- fileName
- -
getFileName()
File name that should be retrieved. maxlength="255"
public java.lang.String getFileName()
setAppServiceId( String appServiceId )
ID of the service that should have uploaded the requested file
public com.smartdevicelink.proxy.rpc.GetFile setAppServiceId(String appServiceId)
Method Parameters
- appServiceId
- -
getAppServiceId()
ID of the service that should have uploaded the requested file
public java.lang.String getAppServiceId()
setFileType( FileType fileType )
Selected file type.
public com.smartdevicelink.proxy.rpc.GetFile setFileType(FileType fileType)
Method Parameters
- fileType
- -
getFileType()
Selected file type.
public com.smartdevicelink.proxy.rpc.enums.FileType getFileType()
setOffset( Integer offset )
Optional offset in bytes for resuming partial data chunks minvalue="0" maxvalue="2000000000"
public com.smartdevicelink.proxy.rpc.GetFile setOffset(Integer offset)
Method Parameters
- offset
- -
getOffset()
Optional offset in bytes for resuming partial data chunks minvalue="0" maxvalue="2000000000"
public java.lang.Integer getOffset()
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"
public com.smartdevicelink.proxy.rpc.GetFile setLength(Integer length)
Method Parameters
- length
- -
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"
public java.lang.Integer getLength()
Inherited Methods
| From Class | Methods |
|---|---|
| com.smartdevicelink.proxy.RPCRequest | getCorrelationID, setCorrelationID, setOnRPCResponseListener, getOnRPCResponseListener |
| com.smartdevicelink.proxy.RPCMessage | getFunctionID, getFunctionName, setFunctionName, getMessageType, setParameters, getParameters, getObject, getString, getInteger, getFloat, getDouble, getBoolean, getLong |
| com.smartdevicelink.proxy.RPCStruct | getStoreValue, getStore, deserializeJSON, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong, clone, equals, hashCode |
| java.lang.Object | getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize |