Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

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 file

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

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

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)

Parameters

hash

GetFile( String fileName )

public GetFile(String fileName)

Parameters

fileName

Methods

setFileName( String fileName )

File name that should be retrieved. maxlength="255"

public void setFileName(String fileName)

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 void setAppServiceId(String appServiceId)

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 void setFileType(FileType fileType)

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 void setOffset(Integer offset)

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 void setLength(Integer length)

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, deserializeJSONObject, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section