AVFile (leancloud-common 0.1.8 API)

java.lang.Object
- com.avos.avoscloud.AVFile

```
public final class AVFile
extends Object
```
AVFile is a local representation of a file that is saved to the AVOSCloud cloud.

The workflow is to construct a AVFile with data and optionally a filename. Then save it and set it as a field on a AVObject.
Example:
```
 AVFile file = new AVFile("hello".getBytes());
 file.save();
 AVObject object = new AVObject("TestObject");
 object.put("file", file);
 object.save();
 
```

Constructor Summary

Constructors
Modifier	Constructor and Description
	`AVFile()`
	`AVFile(byte[] data)` Deprecated.
	`AVFile(String name, byte[] data)` Creates a new file from a byte array and a name.
`protected`	`AVFile(String name, String url)`
	`AVFile(String name, String url, Map<String,Object> metaData)` 创建一个基于网络文件的AVFile对象

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Object`	`addMetaData(String key, Object val)` Added meta data to file.
`void`	`cancel()` Cancels the current network request and callbacks whether it's uploading or fetching data from the server.
`void`	`clearMetaData()` Clear file metadata.
`void`	`delete()`
`void`	`deleteEventually()`
`void`	`deleteEventually(DeleteCallback callback)`
`void`	`deleteInBackground()`
`void`	`deleteInBackground(DeleteCallback callback)`
`protected AVACL`	`getACL()` 获取AVFile的ACL
`String`	`getBucket()`
`byte[]`	`getData()` Deprecated.
`void`	`getDataInBackground(GetDataCallback dataCallback)` Gets the data for this object in a background thread.
`void`	`getDataInBackground(GetDataCallback dataCallback, ProgressCallback progressCallback)` Gets the data for this object in a background thread.
`HashMap<String,Object>`	`getMetaData()` Returns the file's metadata map.
`Object`	`getMetaData(String key)` Returns the metadata value by key.
`static String`	`getMimeType(String url)`
`String`	`getName()` The filename.
`String`	`getObjectId()` Returns the file object Id.
`String`	`getOriginalName()`
`String`	`getOwnerObjectId()` Returns the file's owner
`int`	`getSize()` Returns the file size in bytes.
`String`	`getThumbnailUrl(boolean scaleToFit, int width, int height)` Returns a thumbnail image url using QiNiu endpoints.
`String`	`getThumbnailUrl(boolean scaleToFit, int width, int height, int quality, String fmt)` 返回缩略图URl 这个服务仅仅适用于保存在Qiniu的图片
`Uploader`	`getUploader(SaveCallback saveCallback, ProgressCallback progressCallback)`
`String`	`getUrl()` This returns the url of the file.
`boolean`	`isDataAvailable()` Deprecated.
`boolean`	`isDirty()` Whether the file still needs to be saved.
`static AVFile`	`parseFileWithAbsoluteLocalPath(String name, String absoluteLocalFilePath)` Deprecated. Please use #`withAbsoluteLocalPath(String, String)`
`static AVFile`	`parseFileWithAVObject(AVObject obj)` Deprecated. Please use #`withAVObject(AVObject)`
`static AVFile`	`parseFileWithFile(String name, File file)` Deprecated. Please use #`withFile(String, File)`
`static AVFile`	`parseFileWithObjectId(String objectId)` Deprecated. Please use #`withObjectId(String)`
`static void`	`parseFileWithObjectIdInBackground(String objectId, GetFileCallback<AVFile> cb)` Deprecated. Please use #`withObjectIdInBackground(String, GetFileCallback)`
`Object`	`removeMetaData(String key)` Remove file meta data.
`void`	`save()` Saves the file to the AVOSCloud cloud synchronously.
`void`	`saveInBackground()` Saves the file to the AVOSCloud cloud in a background thread.
`void`	`saveInBackground(SaveCallback callback)` Saves the file to the AVOSCloud cloud in a background thread.
`void`	`saveInBackground(SaveCallback saveCallback, ProgressCallback progressCallback)` Saves the file to the AVOSCloud cloud in a background thread.
`void`	`setACL(AVACL acl)`
`void`	`setBucket(String bucket)`
`void`	`setObjectId(String objectId)` Set the file objectId.
`protected org.json.JSONObject`	`toJSONObject()`
`static AVFile`	`withAbsoluteLocalPath(String name, String absoluteLocalFilePath)` Creates a new file from local file path.
`static AVFile`	`withAVObject(AVObject obj)` Construct a AVFile from AVObject.
`static AVFile`	`withFile(String name, File file)` Creates a new file from java.io.File object.
`static AVFile`	`withObjectId(String objectId)` Retrieve a AVFile object by object id from AVOSCloud.If the file is not found,it will throw java.io.FileNotFoundException.
`static void`	`withObjectIdInBackground(String objectId, GetFileCallback<AVFile> cb)` Retrieve a AVFile object by object id from AVOSCloud in background.If the file is not found,it will call the callback with java.io.FileNotFoundException.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AVFile
```
public AVFile()
```
  - AVFile
```
@Deprecated
public AVFile(byte[] data)
```
    Deprecated.
    
    Creates a new file from a byte array.
    
    Parameters:
    
    data - The file's data. 请注明文件名
  - AVFile
```
public AVFile(String name,
              String url,
              Map<String,Object> metaData)
```
    创建一个基于网络文件的AVFile对象
    
    Parameters:
    
    name - 文件名
    
    url - 网络文件的url
    
    metaData - 网络文件的元信息，可以为空
  - AVFile
```
public AVFile(String name,
              byte[] data)
```
    Creates a new file from a byte array and a name. Giving a name with a proper file extension (e.g. ".png") is ideal because it allows AVOSCloud to deduce the content type of the file and set appropriate HTTP headers when it is fetched.
    
    Parameters:
    
    name - The file's name, ideally with extension.
    
    data - The file's data
  - AVFile
```
protected AVFile(String name,
                 String url)
```
- Method Detail
  - getObjectId
```
public String getObjectId()
```
    Returns the file object Id.
    
    Returns:
    
    The file object id.
  - setObjectId
```
public void setObjectId(String objectId)
```
    Set the file objectId.
    
    Parameters:
    
    objectId - file object id.
  - parseFileWithObjectIdInBackground
```
@Deprecated
public static void parseFileWithObjectIdInBackground(String objectId,
                                                                 GetFileCallback<AVFile> cb)
```
    Deprecated. Please use #withObjectIdInBackground(String, GetFileCallback)
    
    Retrieve a AVFile object by object id from AVOSCloud in background.If the file is not found,it will call the callback with java.io.FileNotFoundException.
    
    Parameters:
    
    objectId - The file object id.
    
    cb - The GetFileCallback instance.
    
    Since:
    
    1.3.4
  - withObjectIdInBackground
```
public static void withObjectIdInBackground(String objectId,
                                            GetFileCallback<AVFile> cb)
```
    Retrieve a AVFile object by object id from AVOSCloud in background.If the file is not found,it will call the callback with java.io.FileNotFoundException.
    
    Parameters:
    
    objectId - The file object id.
    
    cb - The GetFileCallback instance.
    
    Since:
    
    2.0.2
  - parseFileWithObjectId
```
@Deprecated
public static AVFile parseFileWithObjectId(String objectId)
                                                throws AVException,
                                                       FileNotFoundException
```
    Deprecated. Please use #withObjectId(String)
    
    Retrieve a AVFile object by object id from AVOSCloud.If the file is not found,it will throw java.io.FileNotFoundException.
    
    Parameters:
    
    objectId - objectId in _File table
    
    Returns:
    
    AVFile AVFile instance
    
    Throws:
    
    AVException - exception if _File table object failed to transfer to AVFile object
    
    FileNotFoundException - exception if objectId is not invalid
    
    Since:
    
    1.3.4
  - withObjectId
```
public static AVFile withObjectId(String objectId)
                           throws AVException,
                                  FileNotFoundException
```
    Retrieve a AVFile object by object id from AVOSCloud.If the file is not found,it will throw java.io.FileNotFoundException.
    
    Parameters:
    
    objectId - objectId in _File table
    
    Returns:
    
    AVFile AVFile instance
    
    Throws:
    
    AVException - excpetion if _File table object failed to transfer to AVFile object
    
    FileNotFoundException - exception if objectId is not invalid
    
    Since:
    
    2.0.2
  - parseFileWithAVObject
```
@Deprecated
public static AVFile parseFileWithAVObject(AVObject obj)
```
    Deprecated. Please use #withAVObject(AVObject)
    
    Construct a AVFile from AVObject.
    
    Parameters:
    
    obj - The parse object.
    
    Returns:
    
    The parse file object.
    
    Since:
    
    1.3.4
  - withAVObject
```
public static AVFile withAVObject(AVObject obj)
```
    Construct a AVFile from AVObject.
    
    Parameters:
    
    obj - The parse object.
    
    Returns:
    
    The parse file object.
    
    Since:
    
    2.0.2
  - parseFileWithAbsoluteLocalPath
```
@Deprecated
public static AVFile parseFileWithAbsoluteLocalPath(String name,
                                                                String absoluteLocalFilePath)
                                                         throws Exception
```
    Deprecated. Please use #withAbsoluteLocalPath(String, String)
    
    Creates a new file from local file path. Giving a name with a proper file extension (e.g. ".png") is ideal because it allows AVOSCloud to deduce the content type of the file and set appropriate HTTP headers when it is fetched.
    
    Parameters:
    
    name - The file's name, ideally with extension.
    
    absoluteLocalFilePath - The file's absolute path.
    
    Returns:
    
    AVFile AVFile instance
    
    Throws:
    
    Exception - exception if file not found on path
  - withAbsoluteLocalPath
```
public static AVFile withAbsoluteLocalPath(String name,
                                           String absoluteLocalFilePath)
                                    throws FileNotFoundException
```
    Creates a new file from local file path. Giving a name with a proper file extension (e.g. ".png") is ideal because it allows AVOSCloud to deduce the content type of the file and set appropriate HTTP headers when it is fetched.
    
    Parameters:
    
    name - The file's name, ideally with extension.
    
    absoluteLocalFilePath - The file's absolute path.
    
    Returns:
    
    AVFile AVFile instance
    
    Throws:
    
    FileNotFoundException - exception if file not found
    
    Since:
    
    2.0.2
  - parseFileWithFile
```
@Deprecated
public static AVFile parseFileWithFile(String name,
                                                   File file)
                                            throws FileNotFoundException
```
    Deprecated. Please use #withFile(String, File)
    
    Creates a new file from java.io.File object.
    
    Parameters:
    
    name - The file's name, ideally with extension.
    
    file - The file object.
    
    Returns:
    
    AVFile AVFile instance
    
    Throws:
    
    FileNotFoundException
    
    Since:
    
    1.3.4
  - withFile
```
public static AVFile withFile(String name,
                              File file)
                       throws FileNotFoundException
```
    Creates a new file from java.io.File object.
    
    Parameters:
    
    name - The file's name, ideally with extension.
    
    file - The file object.
    
    Returns:
    
    AVFile AVFile instance
    
    Throws:
    
    FileNotFoundException - exception if file not found
    
    Since:
    
    2.0.2
  - getMetaData
```
public HashMap<String,Object> getMetaData()
```
    Returns the file's metadata map.
    
    Returns:
    
    The file's metadata map.
    
    Since:
    
    1.3.4
  - addMetaData
```
public Object addMetaData(String key,
                          Object val)
```
    Added meta data to file.
    
    Parameters:
    
    key - The meta data's key.
    
    val - The meta data's value.
    
    Returns:
    
    The old metadata value.
    
    Since:
    
    1.3.4
  - getMetaData
```
public Object getMetaData(String key)
```
    Returns the metadata value by key.
    
    Parameters:
    
    key - The metadata key
    
    Returns:
    
    The value.
    
    Since:
    
    1.3.4
  - getSize
```
public int getSize()
```
    Returns the file size in bytes.
    
    Returns:
    
    File size in bytes
    
    Since:
    
    1.3.4
  - getOwnerObjectId
```
public String getOwnerObjectId()
```
    Returns the file's owner
    
    Returns:
    
    File's owner
    
    Since:
    
    1.3.4
  - removeMetaData
```
public Object removeMetaData(String key)
```
    Remove file meta data.
    
    Parameters:
    
    key - The meta data's key
    
    Returns:
    
    The metadata value.
    
    Since:
    
    1.3.4
  - clearMetaData
```
public void clearMetaData()
```
    Clear file metadata.
  - getName
```
public String getName()
```
    The filename. Before save is called, this is just the filename given by the user (if any). After save is called, that name gets prefixed with a unique identifier.
    
    Returns:
    
    The file's name.
  - getOriginalName
```
public String getOriginalName()
```
    Returns:
    
    get file name
  - getMimeType
```
public static String getMimeType(String url)
```
  - isDirty
```
public boolean isDirty()
```
    Whether the file still needs to be saved.
    
    Returns:
    
    Whether the file needs to be saved.
  - isDataAvailable
```
@Deprecated
public boolean isDataAvailable()
```
    Deprecated.
    
    Whether the file has available data.
    
    Returns:
    
    Whether the file has available data.
  - getUrl
```
public String getUrl()
```
    This returns the url of the file. It's only available after you save or after you get the file from a AVObject.
    
    Returns:
    
    The url of the file.
  - getThumbnailUrl
```
public String getThumbnailUrl(boolean scaleToFit,
                              int width,
                              int height)
```
    Returns a thumbnail image url using QiNiu endpoints.
    
    Parameters:
    
    scaleToFit - Whether to scale the image
    
    width - The thumbnail image's width
    
    height - The thumbnail image'height
    
    Returns:
    
    thumbnail url
    
    See Also:
    
    getThumbnailUrl(boolean, int, int, int, String)
  - getThumbnailUrl
```
public String getThumbnailUrl(boolean scaleToFit,
                              int width,
                              int height,
                              int quality,
                              String fmt)
```
    返回缩略图URl 这个服务仅仅适用于保存在Qiniu的图片
    
    Parameters:
    
    scaleToFit - Whether to scale the image
    
    width - The thumbnail image's width
    
    height - The thumbnail image'height
    
    quality - The thumbnail image quality in 1 - 100.
    
    fmt - The thumbnail image format such as 'jpg','gif','png','tif' etc.
    
    Returns:
    
    thumbnail url
  - save
```
public void save()
          throws AVException
```
    Saves the file to the AVOSCloud cloud synchronously.
    
    Throws:
    
    AVException - exception during save
  - saveInBackground
```
public void saveInBackground(SaveCallback saveCallback,
                             ProgressCallback progressCallback)
```
    Saves the file to the AVOSCloud cloud in a background thread. progressCallback is guaranteed to be called with 100 before saveCallback is called.
    
    Parameters:
    
    saveCallback - A SaveCallback that gets called when the save completes.
    
    progressCallback - A ProgressCallback that is called periodically with progress updates.
  - saveInBackground
```
public void saveInBackground(SaveCallback callback)
```
    Saves the file to the AVOSCloud cloud in a background thread.
    
    Parameters:
    
    callback - A SaveCallback that gets called when the save completes.
  - saveInBackground
```
public void saveInBackground()
```
    Saves the file to the AVOSCloud cloud in a background thread.
  - getData
```
@Deprecated
public byte[] getData()
                           throws AVException
```
    Deprecated.
    
    Synchronously gets the data for this object. You probably want to use AVFile.getDataInBackground(com.parse.GetDataCallback, com.parse.ProgressCallback) instead unless you're already in a background thread.
    
    Returns:
    
    file data
    
    Throws:
    
    AVException - exception during file data retrieve
  - getDataInBackground
```
public void getDataInBackground(GetDataCallback dataCallback,
                                ProgressCallback progressCallback)
```
    Gets the data for this object in a background thread. progressCallback is guaranteed to be called with 100 before dataCallback is called.
    
    Parameters:
    
    dataCallback - A GetDataCallback that is called when the get completes.
    
    progressCallback - A ProgressCallback that is called periodically with progress updates.
  - getDataInBackground
```
public void getDataInBackground(GetDataCallback dataCallback)
```
    Gets the data for this object in a background thread.
    
    Parameters:
    
    dataCallback - A GetDataCallback that is called when the get completes.
  - cancel
```
public void cancel()
```
    Cancels the current network request and callbacks whether it's uploading or fetching data from the server.
  - delete
```
public void delete()
            throws AVException
```
    Throws:
    
    AVException - exception during delete
    
    Since:
    
    1.3.4
    
    See Also:
    
    AVObject.delete()
  - deleteEventually
```
public void deleteEventually()
```
    Since:
    
    1.3.4
    
    See Also:
    
    AVObject.deleteEventually()
  - deleteEventually
```
public void deleteEventually(DeleteCallback callback)
```
    Parameters:
    
    callback - callback
    
    Since:
    
    1.3.4
    
    See Also:
    
    AVObject.deleteEventually(DeleteCallback callback)
  - deleteInBackground
```
public void deleteInBackground()
```
    Since:
    
    1.3.4
    
    See Also:
    
    AVObject.deleteInBackground()
  - deleteInBackground
```
public void deleteInBackground(DeleteCallback callback)
```
    Parameters:
    
    callback - callback.done(e) is called when the delete completes
    
    Since:
    
    1.3.4
    
    See Also:
    
    AVObject.deleteInBackground(DeleteCallback callback)
  - getUploader
```
public Uploader getUploader(SaveCallback saveCallback,
                            ProgressCallback progressCallback)
```
  - getBucket
```
public String getBucket()
```
  - setBucket
```
public void setBucket(String bucket)
```
  - getACL
```
protected AVACL getACL()
```
    获取AVFile的ACL
    
    Returns:
    
    AVACL for AVFile object
    
    Since:
    
    2.6.9
  - setACL
```
public void setACL(AVACL acl)
```
  - toJSONObject
```
protected org.json.JSONObject toJSONObject()
```

Class AVFile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AVFile

AVFile

AVFile

AVFile

AVFile

Method Detail

getObjectId

setObjectId

parseFileWithObjectIdInBackground

withObjectIdInBackground

parseFileWithObjectId

withObjectId

parseFileWithAVObject

withAVObject

parseFileWithAbsoluteLocalPath

withAbsoluteLocalPath

parseFileWithFile

withFile

getMetaData

addMetaData

getMetaData

getSize

getOwnerObjectId

removeMetaData

clearMetaData

getName

getOriginalName

getMimeType

isDirty

isDataAvailable

getUrl

getThumbnailUrl

getThumbnailUrl

save

saveInBackground

saveInBackground

saveInBackground

getData

getDataInBackground

getDataInBackground

cancel

delete

deleteEventually

deleteEventually

deleteInBackground

deleteInBackground

getUploader

getBucket

setBucket

getACL

setACL

toJSONObject