com.smartdevicelink.managers.file

Class FileManager

java.lang.Object

com.smartdevicelink.managers.BaseSubManager

com.smartdevicelink.managers.file.FileManager

public class FileManager
extends BaseSubManager

FileManager
Note: This class must be accessed through the SdlManager. Do not instantiate it by itself.
The FileManager uploads files and keeps track of all the uploaded files names during a session.

Field Summary

Fields inherited from class com.smartdevicelink.managers.BaseSubManager

ERROR, internalInterface, LIMITED, READY, SETTING_UP, SHUTDOWN

Constructor Summary

Constructors

Constructor and Description
FileManager(ISdl internalInterface, Context context, FileManagerConfig fileManagerConfig) Constructor for FileManager

Method Summary

Modifier and Type	Method and Description
static String	buildErrorString(Result resultCode, String info) Deprecated.
void	deleteRemoteFilesWithNames(List<String> fileNames, MultipleFileCompletionListener listener) Attempts to delete a list of files from core, calls listener with indication of success/failure
void	deleteRemoteFileWithName(String fileName, CompletionListener listener) Attempts to delete the desired file from core, calls listener with indication of success/failure
void	dispose() Called when manager is being torn down
boolean	fileNeedsUpload(SdlFile file) Check if an SdlFile needs to be uploaded to Core or not.
int	getBytesAvailable() Get the number of bytes still available for files for this app.
List<String>	getRemoteFileNames() Returns a list of file names currently residing on core
boolean	hasUploadedFile(SdlFile file) Check if an SdlFile has been uploaded to core
void	start(CompletionListener listener) Starts up a BaseSubManager, and calls provided callback once BaseSubManager is done setting up or failed setup.
void	uploadArtwork(SdlArtwork file, CompletionListener listener) Attempts to upload a SdlArtwork to core
void	uploadArtworks(List<SdlArtwork> files, MultipleFileCompletionListener listener) Attempts to upload a list of SdlArtworks to core
void	uploadFile(SdlFile file, CompletionListener listener) Attempts to upload a SdlFile to core
void	uploadFiles(List<? extends SdlFile> files, MultipleFileCompletionListener listener) Attempts to upload a list of SdlFiles to core

Methods inherited from class com.smartdevicelink.managers.BaseSubManager

getState, handleTransportUpdated, onTransportUpdate, transitionToState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileManager

public FileManager(ISdl internalInterface,
                   Context context,
                   FileManagerConfig fileManagerConfig)

Constructor for FileManager

Parameters:

internalInterface - an instance of the ISdl interface that can be used for common SDL operations (sendRpc, addRpcListener, etc)

context - an instances of Context interface to global information for application

fileManagerConfig - an instance of the FileManagerConfig gives access to artworkRetryCount and fileRetryCount to let us if those file types can be re-upload if they fail

Method Detail

start

public void start(CompletionListener listener)

Description copied from class: BaseSubManager

Starts up a BaseSubManager, and calls provided callback once BaseSubManager is done setting up or failed setup.

Overrides:

start in class BaseSubManager

Parameters:

listener - CompletionListener that is called once the BaseSubManager's state is READY, LIMITED, or ERROR

dispose

public void dispose()

Description copied from class: BaseSubManager

Called when manager is being torn down

Overrides:

dispose in class BaseSubManager

getRemoteFileNames

public List<String> getRemoteFileNames()

Returns a list of file names currently residing on core

Returns:

List of remote file names

getBytesAvailable

public int getBytesAvailable()

Get the number of bytes still available for files for this app.

Returns:

int value representing The number of bytes still available

deleteRemoteFileWithName

public void deleteRemoteFileWithName(@NonNull
                                     String fileName,
                                     CompletionListener listener)

Attempts to delete the desired file from core, calls listener with indication of success/failure

Parameters:

fileName - name of file to be deleted

listener - callback that is called on response from core

deleteRemoteFilesWithNames

public void deleteRemoteFilesWithNames(@NonNull
                                       List<String> fileNames,
                                       MultipleFileCompletionListener listener)

Attempts to delete a list of files from core, calls listener with indication of success/failure

Parameters:

fileNames - list of file names to be deleted

listener - callback that is called once core responds to all deletion requests

hasUploadedFile

public boolean hasUploadedFile(@NonNull
                               SdlFile file)

Check if an SdlFile has been uploaded to core

Parameters:

file - SdlFile

Returns:

boolean that tells whether file has been uploaded to core (true) or not (false)

fileNeedsUpload

public boolean fileNeedsUpload(@NonNull
                               SdlFile file)

Check if an SdlFile needs to be uploaded to Core or not. It is different from hasUploadedFile() because it takes isStaticIcon and overwrite properties into consideration. ie, if the file is static icon, the method always returns false. If the file is dynamic, it returns true in one of these situations: 1) the file has the overwrite property set to true 2) the file hasn't been uploaded to Core before.

Parameters:

file - the SdlFile that needs to be checked

Returns:

boolean that tells whether file needs to be uploaded to Core or not

uploadFiles

public void uploadFiles(@NonNull
                        List<? extends SdlFile> files,
                        MultipleFileCompletionListener listener)

Attempts to upload a list of SdlFiles to core

Parameters:

files - list of SdlFiles with file name and one of A) fileData, B) Uri, or C) resourceID set

listener - callback that is called once core responds to all upload requests

uploadFile

public void uploadFile(@NonNull
                       SdlFile file,
                       CompletionListener listener)

Attempts to upload a SdlFile to core

Parameters:

file - SdlFile with file name and one of A) fileData, B) Uri, or C) resourceID set

listener - called when core responds to the attempt to upload the file

uploadArtwork

public void uploadArtwork(SdlArtwork file,
                          CompletionListener listener)

Attempts to upload a SdlArtwork to core

Parameters:

file - SdlArtwork with file name and one of A) fileData, B) Uri, or C) resourceID set

listener - called when core responds to the attempt to upload the file

uploadArtworks

public void uploadArtworks(List<SdlArtwork> files,
                           MultipleFileCompletionListener listener)

Attempts to upload a list of SdlArtworks to core

Parameters:

files - list of SdlArtworks with file name and one of A) fileData, B) Uri, or C) resourceID set

listener - callback that is called once core responds to all upload requests

buildErrorString

@Deprecated
public static String buildErrorString(Result resultCode,
                                                  String info)

Deprecated.

Builds an error string for a given Result and info string

Parameters:

resultCode - Result

info - String returned from OnRPCRequestListener.onError()

Returns:

Error string