Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
JavaEE Documentation
DeleteFile

Class DeleteFile

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct
         com.smartdevicelink.proxy.RPCMessage
             com.smartdevicelink.proxy.RPCRequest

Package
com.smartdevicelink.proxy.rpc

Overview

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

Fields

KEY_SDL_FILE_NAME

public static final java.lang.String KEY_SDL_FILE_NAME
Constant Value
"syncFileName"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCRequest onResponseListener
com.smartdevicelink.proxy.RPCMessage KEY_REQUEST, KEY_RESPONSE, KEY_NOTIFICATION, KEY_FUNCTION_NAME, KEY_PARAMETERS, KEY_CORRELATION_ID, messageType, parameters, function
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

DeleteFile()

Constructs a new DeleteFile object

public DeleteFile()

DeleteFile( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

Constructs a new DeleteFile object indicated by the Hashtable parameter

public DeleteFile(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Constructor Parameters

hash
The Hashtable to use

DeleteFile( String sdlFileName )

Constructs a new DeleteFile object

public DeleteFile(String sdlFileName)

Constructor Parameters

sdlFileName
a String value representing a file reference name

Methods

setSdlFileName( String sdlFileName )

Sets a file reference name

public com.smartdevicelink.proxy.rpc.DeleteFile setSdlFileName(String sdlFileName)

Method Parameters

sdlFileName
a String value representing a file reference name

getSdlFileName()

Gets a file reference name

public java.lang.String getSdlFileName()

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
View on GitHub.com
Previous Section Next Section