com.smartdevicelink.proxy.rpc

Class DeleteFile

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.DeleteFile

All Implemented Interfaces:

Cloneable

public class DeleteFile
extends RPCRequest

Used to delete a file resident on the SDL module in the app's local cache. Not supported on first generation SDL vehicles

Parameter List

Name	Type	Description	Reg.	Notes	SmartDeviceLink 2.0
SDLFileName	String	File reference name.	Y	maxlength:500	SmartDeviceLink 2.0

Response

Non-default Result Codes:

SUCCESS

INVALID_DATA

OUT_OF_MEMORY

TOO_MANY_PENDING_REQUESTS

APPLICATION_NOT_REGISTERED

GENERIC_ERROR

REJECTED

Since:

SmartDeviceLink 2.0

See Also:

PutFile, ListFiles

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_SDL_FILE_NAME

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
DeleteFile() Constructs a new DeleteFile object
DeleteFile(Hashtable<String,Object> hash) Constructs a new DeleteFile object indicated by the Hashtable parameter
DeleteFile(String sdlFileName) Constructs a new DeleteFile object

Method Summary

Modifier and Type	Method and Description
String	getSdlFileName() Gets a file reference name
DeleteFile	setSdlFileName(String sdlFileName) Sets a file reference name

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_SDL_FILE_NAME

public static final String KEY_SDL_FILE_NAME

See Also:

Constant Field Values

Constructor Detail

DeleteFile

public DeleteFile()

Constructs a new DeleteFile object

DeleteFile

public DeleteFile(Hashtable<String,Object> hash)

Constructs a new DeleteFile object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

DeleteFile

public DeleteFile(@NonNull
                  String sdlFileName)

Constructs a new DeleteFile object

Parameters:

sdlFileName - a String value representing a file reference name

Method Detail

setSdlFileName

public DeleteFile setSdlFileName(@NonNull
                                 String sdlFileName)

Sets a file reference name

Parameters:

sdlFileName - a String value representing a file reference name

getSdlFileName

public String getSdlFileName()

Gets a file reference name

Returns:

String -a String value representing a file reference name