public class ParseFile extends Object
ParseFile
is a local representation of a file that is saved to the Parse cloud.
The workflow is to construct a ParseFile
with data and optionally a filename. Then save
it and set it as a field on a ParseObject
.
Example:
ParseFile file = new ParseFile("hello".getBytes()); file.save(); ParseObject object = new ParseObject("TestObject"); object.put("file", file); object.save();
Constructor and Description |
---|
ParseFile(byte[] data)
Creates a new file from a byte array.
|
ParseFile(byte[] data,
String contentType)
Creates a new file from a byte array, and content type.
|
ParseFile(File file)
Creates a new file from a file pointer.
|
ParseFile(File file,
String contentType)
Creates a new file from a file pointer, and content type.
|
ParseFile(String name,
byte[] data)
Creates a new file from a byte array and a name.
|
ParseFile(String name,
byte[] data,
String contentType)
Creates a new file from a byte array, file name, and content type.
|
Modifier and Type | Method and Description |
---|---|
void |
cancel()
Cancels the current network request and callbacks whether it's uploading or fetching data from
the server.
|
byte[] |
getData()
Synchronously gets the data from cache if available or fetches its content from the network.
|
Task<byte[]> |
getDataInBackground()
Asynchronously gets the data from cache if available or fetches its content from the network.
|
void |
getDataInBackground(GetDataCallback dataCallback)
Asynchronously gets the data from cache if available or fetches its content from the network.
|
void |
getDataInBackground(GetDataCallback dataCallback,
ProgressCallback progressCallback)
Asynchronously gets the data from cache if available or fetches its content from the network.
|
Task<byte[]> |
getDataInBackground(ProgressCallback progressCallback)
Asynchronously gets the data from cache if available or fetches its content from the network.
|
InputStream |
getDataStream()
Synchronously gets the data stream from cached file if available or fetches its content from
the network, saves the content as cached file and returns the data stream of the cached file.
|
Task<InputStream> |
getDataStreamInBackground()
Asynchronously gets the data stream from cached file if available or fetches its content from
the network, saves the content as cached file and returns the data stream of the cached file.
|
void |
getDataStreamInBackground(GetDataStreamCallback dataStreamCallback)
Asynchronously gets the data stream from cached file if available or fetches its content from
the network, saves the content as cached file and returns the data stream of the cached file.
|
void |
getDataStreamInBackground(GetDataStreamCallback dataStreamCallback,
ProgressCallback progressCallback)
Asynchronously gets the data stream from cached file if available or fetches its content from
the network, saves the content as cached file and returns the data stream of the cached file.
|
Task<InputStream> |
getDataStreamInBackground(ProgressCallback progressCallback)
Asynchronously gets the data stream from cached file if available or fetches its content from
the network, saves the content as cached file and returns the data stream of the cached file.
|
File |
getFile()
Synchronously gets the file pointer from cache if available or fetches its content from the
network.
|
Task<File> |
getFileInBackground()
Asynchronously gets the file pointer from cache if available or fetches its content from the
network.
|
void |
getFileInBackground(GetFileCallback fileCallback)
Asynchronously gets the file pointer from cache if available or fetches its content from the
network.
|
void |
getFileInBackground(GetFileCallback fileCallback,
ProgressCallback progressCallback)
Asynchronously gets the file pointer from cache if available or fetches its content from the
network.
|
Task<File> |
getFileInBackground(ProgressCallback progressCallback)
Asynchronously gets the file pointer from cache if available or fetches its content from the
network.
|
String |
getName()
The filename.
|
String |
getUrl()
This returns the url of the file.
|
boolean |
isDataAvailable()
Whether the file has available data.
|
boolean |
isDirty()
Whether the file still needs to be saved.
|
void |
save()
Saves the file to the Parse cloud synchronously.
|
Task<Void> |
saveInBackground()
Saves the file to the Parse cloud in a background thread.
|
Task<Void> |
saveInBackground(ProgressCallback uploadProgressCallback)
Saves the file to the Parse cloud in a background thread.
|
void |
saveInBackground(SaveCallback callback)
Saves the file to the Parse cloud in a background thread.
|
void |
saveInBackground(SaveCallback saveCallback,
ProgressCallback progressCallback)
Saves the file to the Parse cloud in a background thread.
|
public ParseFile(File file)
file
- The file.public ParseFile(File file, String contentType)
file
- The file.contentType
- The file's content type.public ParseFile(String name, byte[] data, String contentType)
name
- The file's name, ideally with extension. The file name must begin with an alphanumeric
character, and consist of alphanumeric characters, periods, spaces, underscores, or
dashes.data
- The file's data.contentType
- The file's content type.public ParseFile(byte[] data)
data
- The file's data.public ParseFile(String name, byte[] data)
name
- The file's name, ideally with extension. The file name must begin with an alphanumeric
character, and consist of alphanumeric characters, periods, spaces, underscores, or
dashes.data
- The file's data.public ParseFile(byte[] data, String contentType)
data
- The file's data.contentType
- The file's content type.public String getName()
public boolean isDirty()
public boolean isDataAvailable()
public String getUrl()
public void save() throws ParseException
ParseException
public Task<Void> saveInBackground(ProgressCallback uploadProgressCallback)
uploadProgressCallback
- A ProgressCallback that is called periodically with progress updates.public Task<Void> saveInBackground()
public void saveInBackground(SaveCallback saveCallback, ProgressCallback progressCallback)
saveCallback
- A SaveCallback that gets called when the save completes.progressCallback
- A ProgressCallback that is called periodically with progress updates.public void saveInBackground(SaveCallback callback)
callback
- A SaveCallback that gets called when the save completes.public byte[] getData() throws ParseException
ParseFile.getDataInBackground()
instead unless you're already in a
background thread.ParseException
public Task<byte[]> getDataInBackground(ProgressCallback progressCallback)
ProgressCallback
will be called periodically with progress updates.progressCallback
- A ProgressCallback
that is called periodically with progress updates.public Task<byte[]> getDataInBackground()
public void getDataInBackground(GetDataCallback dataCallback, ProgressCallback progressCallback)
ProgressCallback
will be called periodically with progress updates.
A GetDataCallback
will be called when the get completes.dataCallback
- A GetDataCallback
that is called when the get completes.progressCallback
- A ProgressCallback
that is called periodically with progress updates.public void getDataInBackground(GetDataCallback dataCallback)
GetDataCallback
will be called when the get completes.dataCallback
- A GetDataCallback
that is called when the get completes.public File getFile() throws ParseException
ParseFile.getFileInBackground()
instead unless you're already
in a background thread.
Note: The File
location may change without notice and should not be
stored to be accessed later.ParseException
public Task<File> getFileInBackground(ProgressCallback progressCallback)
ProgressCallback
will be called periodically with progress updates.
Note: The File
location may change without notice and should not be
stored to be accessed later.progressCallback
- A ProgressCallback
that is called periodically with progress updates.public Task<File> getFileInBackground()
File
location may change without notice and should not be
stored to be accessed later.public void getFileInBackground(GetFileCallback fileCallback, ProgressCallback progressCallback)
GetFileCallback
will be called when the get completes.
The ProgressCallback
will be called periodically with progress updates.
The ProgressCallback
is guaranteed to be called with 100 before the
GetFileCallback
is called.
Note: The File
location may change without notice and should not be
stored to be accessed later.fileCallback
- A GetFileCallback
that is called when the get completes.progressCallback
- A ProgressCallback
that is called periodically with progress updates.public void getFileInBackground(GetFileCallback fileCallback)
GetFileCallback
will be called when the get completes.
Note: The File
location may change without notice and should not be
stored to be accessed later.fileCallback
- A GetFileCallback
that is called when the get completes.public InputStream getDataStream() throws ParseException
ParseFile.getDataStreamInBackground(com.parse.ProgressCallback)
instead unless you're already in a
background thread.ParseException
public Task<InputStream> getDataStreamInBackground(ProgressCallback progressCallback)
ProgressCallback
will be called periodically with progress updates.progressCallback
- A ProgressCallback
that is called periodically with progress updates.public Task<InputStream> getDataStreamInBackground()
public void getDataStreamInBackground(GetDataStreamCallback dataStreamCallback, ProgressCallback progressCallback)
GetDataStreamCallback
will be called when the get completes. The
ProgressCallback
will be called periodically with progress updates. The
ProgressCallback
is guaranteed to be called with 100 before
GetDataStreamCallback
is called.dataStreamCallback
- A GetDataStreamCallback
that is called when the get completes.progressCallback
- A ProgressCallback
that is called periodically with progress updates.public void getDataStreamInBackground(GetDataStreamCallback dataStreamCallback)
GetDataStreamCallback
will be called when the get completes.dataStreamCallback
- A GetDataStreamCallback
that is called when the get completes.public void cancel()