PutFile (sdl_android 5.3.1 API)

java.lang.Object
- com.smartdevicelink.proxy.RPCStruct
- - com.smartdevicelink.proxy.RPCMessage
  - - com.smartdevicelink.proxy.RPCRequest
    - - com.smartdevicelink.proxy.rpc.PutFile

All Implemented Interfaces:: Cloneable

public class PutFile
extends RPCRequest

Used to push a binary data onto the SDL module from a mobile device, such as icons and album art.

Parameter List

Name	Type	Description	Req.	Notes	Version Available
FileName	String	File reference name.	Y	Maxlength=500	SmartDeviceLink 2.0
fileType	FileType	Selected file type.	Y		SmartDeviceLink 2.0
persistentFile	Boolean	Indicates if the file is meant to persist between sessions / ignition cycles. If set to TRUE,then the system will aim to persist this file through session / cycles. While files with this designation will have priority over others,they are subject to deletion by the system at any time.In the event of automatic deletion by the system, the app will receive a rejection and have to resend the file. If omitted, the value will be set to false.	N		SmartDeviceLink 2.0
systemFile	Boolean	Indicates if the file is meant to be passed thru core to elsewhere on the system. If set to TRUE, then the system will instead pass the data thru as it arrives to a predetermined area outside of core. If omitted, the value will be set to false.	N		SmartDeviceLink 2.3.2
offset	Float	Optional offset in bytes for resuming partial data chunks	N	Minvalue=0; Maxvalue=100000000000	SmartDeviceLink 2.3.2
length	Float	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	N	Minvalue=0; Maxvalue=100000000000	SmartDeviceLink 2.3.2
crc	Long	Additional CRC32 checksum to protect data integrity up to 512 Mbits .	N	minvalue="0" maxvalue="4294967295"	SmartDeviceLink 2.3.2

Note:

When using PutFiles you may want to check for memory

Response

Response is sent, when the file data was copied (success case). Or when an error occurred. Not supported on First generation SDL modules.

Non-default Result Codes:

SUCCESS

INVALID_DATA

OUT_OF_MEMORY

TOO_MANY_PENDING_REQUESTS

APPLICATION_NOT_REGISTERED

GENERIC_ERROR

REJECTED

Name	Type	Description	Req.	Notes	Version Available
spaceAvailable	Integer	Provides the total local space available on SDL for the registered app.		Minvalue=0; Maxvalue=2000000000	SmartDeviceLink 2.0

Since:: SmartDeviceLink 2.0
See Also:: DeleteFile, ListFiles

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`
`static String`	`KEY_PERSISTENT_FILE`
`static String`	`KEY_SDL_FILE_NAME`
`static String`	`KEY_SYSTEM_FILE`

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
`PutFile()` Constructs a new PutFile object
`PutFile(Hashtable<String,Object> hash)` Constructs a new PutFile object indicated by the Hashtable parameter
`PutFile(String syncFileName, FileType fileType)` Constructs a new PutFile object

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Long`	`getCRC()` This returns the CRC, if it has been set, for the file object
`byte[]`	`getFileData()`
`FileType`	`getFileType()` Gets a file type
`Long`	`getLength()`
`Long`	`getOffset()`
`Boolean`	`getPersistentFile()` Gets a value to Indicates if the file is meant to persist between sessions / ignition cycles
`String`	`getSdlFileName()` Gets a file reference name
`Boolean`	`getSystemFile()`
`PutFile`	`setCRC(byte[] fileData)` This takes the file data as an array of bytes and calculates the CRC32 for it.
`PutFile`	`setCRC(Long crc)` This assumes you have created your own CRC32 and are setting it with the file Please avoid using your own calculations for this, and use the method included in java.util
`PutFile`	`setFileData(byte[] fileData)`
`PutFile`	`setFileType(FileType fileType)` Sets file type
`PutFile`	`setLength(Integer length)` Deprecated. as of SmartDeviceLink 4.0. Use `setLength(Long)` instead.
`PutFile`	`setLength(Long length)`
`PutFile`	`setOffset(Integer offset)` Deprecated. as of SmartDeviceLink 4.0. Use `setOffset(Long)` instead.
`PutFile`	`setOffset(Long offset)`
`PutFile`	`setPersistentFile(Boolean persistentFile)` Sets a value to indicates if the file is meant to persist between sessions / ignition cycles.
`PutFile`	`setSdlFileName(String sdlFileName)` Sets a file reference name
`PutFile`	`setSystemFile(Boolean systemFile)`

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_PERSISTENT_FILE
```
public static final String KEY_PERSISTENT_FILE
```
    See Also:
    
    Constant Field Values
  - KEY_SYSTEM_FILE
```
public static final String KEY_SYSTEM_FILE
```
    See Also:
    
    Constant Field Values
  - KEY_FILE_TYPE
```
public static final String KEY_FILE_TYPE
```
    See Also:
    
    Constant Field Values
  - KEY_SDL_FILE_NAME
```
public static final String KEY_SDL_FILE_NAME
```
    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
  - KEY_CRC
```
public static final String KEY_CRC
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PutFile
```
public PutFile()
```
    Constructs a new PutFile object
  - PutFile
```
public PutFile(Hashtable<String,Object> hash)
```
    Constructs a new PutFile object indicated by the Hashtable parameter
    
    Parameters:
    
    hash - The Hashtable to use
  - PutFile
```
public PutFile(@NonNull
               String syncFileName,
               @NonNull
               FileType fileType)
```
    Constructs a new PutFile object
    
    Parameters:
    
    syncFileName - a String value representing a file reference name Notes: Maxlength=500, however the max file name length may vary based on remote filesystem limitations
    
    fileType - a FileType value representing a selected file type
- Method Detail
  - setSdlFileName
```
public PutFile setSdlFileName(@NonNull
                              String sdlFileName)
```
    Sets a file reference name
    
    Parameters:
    
    sdlFileName - a String value representing a file reference name
    Notes: Maxlength=500, however the max file name length may vary based on remote filesystem limitations
  - getSdlFileName
```
public String getSdlFileName()
```
    Gets a file reference name
    
    Returns:
    
    String - a String value representing a file reference name
  - setFileType
```
public PutFile setFileType(@NonNull
                           FileType fileType)
```
    Sets file type
    
    Parameters:
    
    fileType - a FileType value representing a selected file type
  - getFileType
```
public FileType getFileType()
```
    Gets a file type
    
    Returns:
    
    FileType -a FileType value representing a selected file type
  - setPersistentFile
```
public PutFile setPersistentFile(Boolean persistentFile)
```
    Sets a value to indicates if the file is meant to persist between sessions / ignition cycles. If set to TRUE, then the system will aim to persist this file through session / cycles. While files with this designation will have priority over others, they are subject to deletion by the system at any time. In the event of automatic deletion by the system, the app will receive a rejection and have to resend the file. If omitted, the value will be set to false
    
    Parameters:
    
    persistentFile - a Boolean value
  - getPersistentFile
```
public Boolean getPersistentFile()
```
    Gets a value to Indicates if the file is meant to persist between sessions / ignition cycles
    
    Returns:
    
    Boolean -a Boolean value to indicates if the file is meant to persist between sessions / ignition cycles
  - setFileData
```
public PutFile setFileData(byte[] fileData)
```
  - getFileData
```
public byte[] getFileData()
```
  - setOffset
```
public PutFile setOffset(Integer offset)
```
    Deprecated. as of SmartDeviceLink 4.0. Use setOffset(Long) instead.
    
    Parameters:
    
    offset - Optional offset in bytes for resuming partial data chunks
  - setOffset
```
public PutFile setOffset(Long offset)
```
    Parameters:
    
    offset - Optional offset in bytes for resuming partial data chunks
  - getOffset
```
public Long getOffset()
```
  - setLength
```
public PutFile setLength(Integer length)
```
    Deprecated. as of SmartDeviceLink 4.0. Use setLength(Long) instead.
    
    Parameters:
    
    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
  - setLength
```
public PutFile setLength(Long length)
```
    Parameters:
    
    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
  - getLength
```
public Long getLength()
```
  - setSystemFile
```
public PutFile setSystemFile(Boolean systemFile)
```
  - getSystemFile
```
public Boolean getSystemFile()
```
  - setCRC
```
public PutFile setCRC(byte[] fileData)
```
    This takes the file data as an array of bytes and calculates the CRC32 for it.
    
    Parameters:
    
    fileData - - the file as a byte array
  - setCRC
```
public PutFile setCRC(Long crc)
```
    This assumes you have created your own CRC32 and are setting it with the file Please avoid using your own calculations for this, and use the method included in java.util
    
    Parameters:
    
    crc - - the CRC32 of the file being set
  - getCRC
```
public Long getCRC()
```
    This returns the CRC, if it has been set, for the file object
    
    Returns:
    
    - a CRC32 Long

Class PutFile

Field Summary

Fields inherited from class com.smartdevicelink.proxy.RPCRequest

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

Constructor Summary

Method Summary

Methods inherited from class com.smartdevicelink.proxy.RPCRequest

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

Methods inherited from class java.lang.Object

Field Detail

KEY_PERSISTENT_FILE

KEY_SYSTEM_FILE

KEY_FILE_TYPE

KEY_SDL_FILE_NAME

KEY_OFFSET

KEY_LENGTH

KEY_CRC

Constructor Detail

PutFile

PutFile

PutFile

Method Detail

setSdlFileName

getSdlFileName

setFileType

getFileType

setPersistentFile

getPersistentFile

setFileData

getFileData

setOffset

setOffset

getOffset

setLength

setLength

getLength

setSystemFile

getSystemFile

setCRC

setCRC

getCRC