AVFile (AVOS Cloud Android SDK)

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

```
public final class AVFile
extends java.lang.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();
 
```

字段概要

字段
限定符和类型字段和说明

static java.lang.String AVFILE_ENDPOINT

static java.lang.String DEFAULTMIMETYPE

字段
限定符和类型	字段和说明
`static java.lang.String`	`AVFILE_ENDPOINT`
`static java.lang.String`	`DEFAULTMIMETYPE`

构造器概要

构造器
构造器和说明
`AVFile()`
`AVFile(byte[] data)` 已过时。
`AVFile(java.lang.String name, byte[] data)` Creates a new file from a byte array and a name.
`AVFile(java.lang.String name, java.lang.String url, java.util.Map<java.lang.String,java.lang.Object> metaData)` 创建一个基于网络文件的AVFile对象

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`java.lang.Object`	`addMetaData(java.lang.String key, java.lang.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.
`static java.lang.String`	`className()`
`static void`	`clearAllCachedFiles()` clear all cached files
`void`	`clearCachedFile()` clear cached file for this file.
`static void`	`clearCacheMoreThanDays(int days)` clear cached files which created before x days.
`void`	`clearMetaData()` Clear file metadata.
`void`	`delete()`
`void`	`deleteEventually()`
`void`	`deleteEventually(DeleteCallback callback)`
`void`	`deleteInBackground()`
`void`	`deleteInBackground(DeleteCallback callback)`
`AVACL`	`getACL()` 获取AVFile的ACL
`java.lang.String`	`getBucket()`
`byte[]`	`getData()` 已过时。
`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. progressCallback is guaranteed to be called with 100 before dataCallback is called.
`java.io.InputStream`	`getDataStream()` Synchronously gets the data input stream for this object.
`void`	`getDataStreamInBackground(GetDataStreamCallback callback)` Gets the data input stream for this object in a background thread.
`void`	`getDataStreamInBackground(GetDataStreamCallback callback, ProgressCallback progressCallback)` Gets the data input stream for this object in a background thread. progressCallback is guaranteed to be called with 100 before dataStreamCallback is called.
`java.util.HashMap<java.lang.String,java.lang.Object>`	`getMetaData()` Returns the file's metadata map.
`java.lang.Object`	`getMetaData(java.lang.String key)` Returns the metadata value by key.
`static java.lang.String`	`getMimeType(java.lang.String url)` 已过时。 replaced by `AVUtils#getMimeTypeFromLocalFile(String)` or `AVUtils#getMimeTypeFromUrl(String)`
`java.lang.String`	`getName()` The filename.
`java.lang.String`	`getObjectId()` Returns the file object Id.
`java.lang.String`	`getOriginalName()`
`java.lang.String`	`getOwnerObjectId()` Returns the file's owner
`int`	`getSize()` Returns the file size in bytes.
`java.lang.String`	`getThumbnailUrl(boolean scaleToFit, int width, int height)` Returns a thumbnail image url using QiNiu endpoints.
`java.lang.String`	`getThumbnailUrl(boolean scaleToFit, int width, int height, int quality, java.lang.String fmt)` 返回缩略图URl 这个服务仅仅适用于保存在Qiniu的图片
`Uploader`	`getUploader(SaveCallback saveCallback, ProgressCallback progressCallback)`
`java.lang.String`	`getUrl()` This returns the url of the file.
`boolean`	`isDataAvailable()` 已过时。
`boolean`	`isDirty()` Whether the file still needs to be saved.
`static AVFile`	`parseFileWithAbsoluteLocalPath(java.lang.String name, java.lang.String absoluteLocalFilePath)` 已过时。 Please use #`withAbsoluteLocalPath(String, String)`
`static AVFile`	`parseFileWithAVObject(AVObject obj)` 已过时。 Please use #`withAVObject(AVObject)`
`static AVFile`	`parseFileWithFile(java.lang.String name, java.io.File file)` 已过时。 Please use #`withFile(String, File)`
`static AVFile`	`parseFileWithObjectId(java.lang.String objectId)` 已过时。 Please use #`withObjectId(String)`
`static void`	`parseFileWithObjectIdInBackground(java.lang.String objectId, GetFileCallback<AVFile> cb)` 已过时。 Please use #`withObjectIdInBackground(String, GetFileCallback)`
`java.lang.Object`	`removeMetaData(java.lang.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. progressCallback is guaranteed to be called with 100 before saveCallback is called.
`void`	`setACL(AVACL acl)`
`void`	`setBucket(java.lang.String bucket)`
`void`	`setName(java.lang.String name)`
`void`	`setObjectId(java.lang.String objectId)` Set the file objectId.
`static void`	`setUploadHeader(java.lang.String key, java.lang.String value)` set http header while uploading.
`void`	`setUrl(java.lang.String url)`
`static AVFile`	`withAbsoluteLocalPath(java.lang.String name, java.lang.String absoluteLocalFilePath)` Creates a new file from local file path.
`static AVFile`	`withAVObject(AVObject obj)` Construct a AVFile from AVObject.
`static AVFile`	`withFile(java.lang.String name, java.io.File file)` Creates a new file from java.io.File object.
`static AVFile`	`withObjectId(java.lang.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(java.lang.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.

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - DEFAULTMIMETYPE
```
public static java.lang.String DEFAULTMIMETYPE
```
  - AVFILE_ENDPOINT
```
public static final java.lang.String AVFILE_ENDPOINT
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - AVFile
```
public AVFile()
```
  - AVFile
```
@Deprecated
public AVFile(byte[] data)
```
    已过时。
    
    Creates a new file from a byte array.
    
    参数:
    
    data - The file's data. 请注明文件名
  - AVFile
```
public AVFile(java.lang.String name,
              java.lang.String url,
              java.util.Map<java.lang.String,java.lang.Object> metaData)
```
    创建一个基于网络文件的AVFile对象
    
    参数:
    
    name - 文件名
    
    url - 网络文件的url
    
    metaData - 网络文件的元信息，可以为空
  - AVFile
```
public AVFile(java.lang.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.
    
    参数:
    
    name - The file's name, ideally with extension.
    
    data - The file's data
- 方法详细资料
  - setUploadHeader
```
public static void setUploadHeader(java.lang.String key,
                                   java.lang.String value)
```
    set http header while uploading.
    
    参数:
    
    key - - header name
    
    value - - header value
  - getObjectId
```
public java.lang.String getObjectId()
```
    Returns the file object Id.
    
    返回:
    
    The file object id.
  - setObjectId
```
public void setObjectId(java.lang.String objectId)
```
    Set the file objectId.
    
    参数:
    
    objectId - file object id.
  - parseFileWithObjectIdInBackground
```
@Deprecated
public static void parseFileWithObjectIdInBackground(java.lang.String objectId,
                                                                 GetFileCallback<AVFile> cb)
```
    已过时。 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.
    
    参数:
    
    objectId - The file object id.
    
    cb - The GetFileCallback instance.
    
    从以下版本开始:
    
    1.3.4
  - withObjectIdInBackground
```
public static void withObjectIdInBackground(java.lang.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.
    
    参数:
    
    objectId - The file object id.
    
    cb - The GetFileCallback instance.
    
    从以下版本开始:
    
    2.0.2
  - parseFileWithObjectId
```
@Deprecated
public static AVFile parseFileWithObjectId(java.lang.String objectId)
                                                throws AVException,
                                                       java.io.FileNotFoundException
```
    已过时。 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.
    
    参数:
    
    objectId -
    
    返回:
    
    抛出:
    
    AVException - ,FileNotFoundException
    
    java.io.FileNotFoundException
    
    从以下版本开始:
    
    1.3.4
  - withObjectId
```
public static AVFile withObjectId(java.lang.String objectId)
                           throws AVException,
                                  java.io.FileNotFoundException
```
    Retrieve a AVFile object by object id from AVOSCloud.If the file is not found,it will throw java.io.FileNotFoundException.
    
    参数:
    
    objectId -
    
    返回:
    
    抛出:
    
    AVException - ,FileNotFoundException
    
    java.io.FileNotFoundException
    
    从以下版本开始:
    
    2.0.2
  - parseFileWithAVObject
```
@Deprecated
public static AVFile parseFileWithAVObject(AVObject obj)
```
    已过时。 Please use #withAVObject(AVObject)
    
    Construct a AVFile from AVObject.
    
    参数:
    
    obj - The AVObject.
    
    返回:
    
    The file object.
    
    从以下版本开始:
    
    1.3.4
  - withAVObject
```
public static AVFile withAVObject(AVObject obj)
```
    Construct a AVFile from AVObject.
    
    参数:
    
    obj - The object.
    
    返回:
    
    The file object.
    
    从以下版本开始:
    
    2.0.2
  - parseFileWithAbsoluteLocalPath
```
@Deprecated
public static AVFile parseFileWithAbsoluteLocalPath(java.lang.String name,
                                                                java.lang.String absoluteLocalFilePath)
                                                         throws java.lang.Exception
```
    已过时。 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.
    
    参数:
    
    name - The file's name, ideally with extension.
    
    absoluteLocalFilePath - The file's absolute path.
    
    抛出:
    
    java.lang.Exception
  - withAbsoluteLocalPath
```
public static AVFile withAbsoluteLocalPath(java.lang.String name,
                                           java.lang.String absoluteLocalFilePath)
                                    throws java.io.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.
    
    参数:
    
    name - The file's name, ideally with extension.
    
    absoluteLocalFilePath - The file's absolute path.
    
    抛出:
    
    java.io.FileNotFoundException
    
    从以下版本开始:
    
    2.0.2
  - parseFileWithFile
```
@Deprecated
public static AVFile parseFileWithFile(java.lang.String name,
                                                   java.io.File file)
                                            throws java.io.FileNotFoundException
```
    已过时。 Please use #withFile(String, File)
    
    Creates a new file from java.io.File object.
    
    参数:
    
    name - The file's name, ideally with extension.
    
    file - The file object.
    
    返回:
    
    抛出:
    
    java.io.FileNotFoundException
    
    java.io.IOException
    
    从以下版本开始:
    
    1.3.4
  - withFile
```
public static AVFile withFile(java.lang.String name,
                              java.io.File file)
                       throws java.io.FileNotFoundException
```
    Creates a new file from java.io.File object.
    
    参数:
    
    name - The file's name, ideally with extension.
    
    file - The file object.
    
    返回:
    
    抛出:
    
    java.io.FileNotFoundException
    
    java.io.IOException
    
    从以下版本开始:
    
    2.0.2
  - getMetaData
```
public java.util.HashMap<java.lang.String,java.lang.Object> getMetaData()
```
    Returns the file's metadata map.
    
    返回:
    
    The file's metadata map.
    
    从以下版本开始:
    
    1.3.4
  - addMetaData
```
public java.lang.Object addMetaData(java.lang.String key,
                                    java.lang.Object val)
```
    Added meta data to file.
    
    参数:
    
    key - The meta data's key.
    
    val - The meta data's value.
    
    返回:
    
    The old metadata value.
    
    从以下版本开始:
    
    1.3.4
  - getMetaData
```
public java.lang.Object getMetaData(java.lang.String key)
```
    Returns the metadata value by key.
    
    参数:
    
    key - The metadata key
    
    返回:
    
    The value.
    
    从以下版本开始:
    
    1.3.4
  - getSize
```
public int getSize()
```
    Returns the file size in bytes.
    
    返回:
    
    File size in bytes
    
    从以下版本开始:
    
    1.3.4
  - getOwnerObjectId
```
public java.lang.String getOwnerObjectId()
```
    Returns the file's owner
    
    返回:
    
    File's owner
    
    从以下版本开始:
    
    1.3.4
  - removeMetaData
```
public java.lang.Object removeMetaData(java.lang.String key)
```
    Remove file meta data.
    
    参数:
    
    key - The meta data's key
    
    返回:
    
    The metadata value.
    
    从以下版本开始:
    
    1.3.4
  - clearMetaData
```
public void clearMetaData()
```
    Clear file metadata.
  - getName
```
public java.lang.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.
    
    返回:
    
    The file's name.
  - getOriginalName
```
public java.lang.String getOriginalName()
```
    返回:
  - setName
```
public void setName(java.lang.String name)
```
    参数:
    
    name -
  - getMimeType
```
public static java.lang.String getMimeType(java.lang.String url)
```
    已过时。 replaced by AVUtils#getMimeTypeFromLocalFile(String) or AVUtils#getMimeTypeFromUrl(String)
    
    参数:
    
    url -
    
    返回:
  - isDirty
```
public boolean isDirty()
```
    Whether the file still needs to be saved.
    
    返回:
    
    Whether the file needs to be saved.
  - isDataAvailable
```
@Deprecated
public boolean isDataAvailable()
```
    已过时。
    
    Whether the file has available data.
  - getUrl
```
public java.lang.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.
    
    返回:
    
    The url of the file.
  - getThumbnailUrl
```
public java.lang.String getThumbnailUrl(boolean scaleToFit,
                                        int width,
                                        int height)
```
    Returns a thumbnail image url using QiNiu endpoints.
    
    参数:
    
    scaleToFit -
    
    width -
    
    height -
    
    返回:
    
    另请参阅:
    
    getThumbnailUrl(boolean, int, int, int, String)
  - getThumbnailUrl
```
public java.lang.String getThumbnailUrl(boolean scaleToFit,
                                        int width,
                                        int height,
                                        int quality,
                                        java.lang.String fmt)
```
    返回缩略图URl 这个服务仅仅适用于保存在Qiniu的图片
    
    参数:
    
    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.
    
    返回:
  - setUrl
```
public void setUrl(java.lang.String url)
```
  - save
```
public void save()
          throws AVException
```
    Saves the file to the AVOSCloud cloud synchronously.
    
    抛出:
    
    AVException
  - 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.
    
    参数:
    
    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.
    
    参数:
    
    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
```
    已过时。
    
    Synchronously gets the data for this object. You probably want to use getDataInBackground(GetDataCallback) instead unless you're already in a background thread. Notice: for large file(above 20MB), it is dangerous to read whole data once time, instead of, you should use getDataStream() to read the content.
    
    抛出:
    
    AVException
  - getDataStream
```
public java.io.InputStream getDataStream()
                                  throws AVException
```
    Synchronously gets the data input stream for this object. You probably want to use getDataStreamInBackground(GetDataStreamCallback) instead unless you're already in a background thread. Notice: You need to close the input stream after reading content from it.
    
    抛出:
    
    AVException
  - 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. Notice: for large file(above 20MB), it is dangerous to read whole data once time, instead of, you should use getDataStreamInBackground(GetDataStreamCallback, ProgressCallback) to read the content.
    
    参数:
    
    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. Notice: for large file(above 20MB), it is dangerous to read whole data once time, instead of, you should use getDataStreamInBackground(GetDataStreamCallback) to read the content.
    
    参数:
    
    dataCallback - A GetDataCallback that is called when the get completes.
  - getDataStreamInBackground
```
public void getDataStreamInBackground(GetDataStreamCallback callback)
```
    Gets the data input stream for this object in a background thread. Notice: You need to close the input stream after reading content from it.
    
    参数:
    
    callback - A GetDataStreamCallback that is called when the get completes.
  - getDataStreamInBackground
```
public void getDataStreamInBackground(GetDataStreamCallback callback,
                                      ProgressCallback progressCallback)
```
    Gets the data input stream for this object in a background thread. progressCallback is guaranteed to be called with 100 before dataStreamCallback is called. Caution: You need to close the input stream after reading content from it.
    
    参数:
    
    callback - A GetDataStreamCallback that is called when the get completes.
    
    progressCallback - A ProgressCallback that is called periodically with progress updates.
  - 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
```
    抛出:
    
    AVException
    
    从以下版本开始:
    
    1.3.4
    
    另请参阅:
    
    AVObject.delete()
  - deleteEventually
```
public void deleteEventually()
```
    从以下版本开始:
    
    1.3.4
    
    另请参阅:
    
    AVObject.deleteEventually()
  - deleteEventually
```
public void deleteEventually(DeleteCallback callback)
```
    参数:
    
    callback -
    
    从以下版本开始:
    
    1.3.4
    
    另请参阅:
    
    AVObject.deleteEventually(DeleteCallback callback);
  - deleteInBackground
```
public void deleteInBackground()
```
    从以下版本开始:
    
    1.3.4
    
    另请参阅:
    
    AVObject.deleteInBackground();
  - deleteInBackground
```
public void deleteInBackground(DeleteCallback callback)
```
    参数:
    
    callback -
    
    从以下版本开始:
    
    1.3.4
    
    另请参阅:
    
    AVObject.deleteInBackground(DeleteCallback callback);
  - className
```
public static java.lang.String className()
```
  - getUploader
```
public Uploader getUploader(SaveCallback saveCallback,
                            ProgressCallback progressCallback)
```
  - getBucket
```
public java.lang.String getBucket()
```
  - setBucket
```
public void setBucket(java.lang.String bucket)
```
  - getACL
```
public AVACL getACL()
```
    获取AVFile的ACL
    
    从以下版本开始:
    
    2.6.9
  - setACL
```
public void setACL(AVACL acl)
```
  - clearCachedFile
```
public void clearCachedFile()
```
    clear cached file for this file.
  - clearAllCachedFiles
```
public static void clearAllCachedFiles()
```
    clear all cached files
  - clearCacheMoreThanDays
```
public static void clearCacheMoreThanDays(int days)
```
    clear cached files which created before x days.
    
    参数:
    
    days - - peroid from now.

类 AVFile

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

DEFAULTMIMETYPE

AVFILE_ENDPOINT

构造器详细资料

AVFile

AVFile

AVFile

AVFile

方法详细资料

setUploadHeader

getObjectId

setObjectId

parseFileWithObjectIdInBackground

withObjectIdInBackground

parseFileWithObjectId

withObjectId

parseFileWithAVObject

withAVObject

parseFileWithAbsoluteLocalPath

withAbsoluteLocalPath

parseFileWithFile

withFile

getMetaData

addMetaData

getMetaData

getSize

getOwnerObjectId

removeMetaData

clearMetaData

getName

getOriginalName

setName

getMimeType

isDirty

isDataAvailable

getUrl

getThumbnailUrl

getThumbnailUrl

setUrl

save

saveInBackground

saveInBackground

saveInBackground

getData

getDataStream

getDataInBackground

getDataInBackground

getDataStreamInBackground

getDataStreamInBackground

cancel

delete

deleteEventually

deleteEventually

deleteInBackground

deleteInBackground

className

getUploader

getBucket

setBucket

getACL

setACL

clearCachedFile

clearAllCachedFiles

clearCacheMoreThanDays