AVFile (storage core library 7.2.1 API)

java.lang.Object
- cn.leancloud.AVObject
- - cn.leancloud.AVFile

public final class AVFile
extends AVObject

嵌套类概要
- 从类继承的嵌套类/接口 cn.leancloud.AVObject
  AVObject.Hook

字段概要

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

static String CLASS_NAME
- 从类继承的字段 cn.leancloud.AVObject
  acl, className, endpointClassName, KEY_ACL, KEY_CLASSNAME, KEY_CREATED_AT, KEY_IGNORE_HOOKS, KEY_OBJECT_ID, KEY_UPDATED_AT, logger, objectId, operations, serverData, totallyOverwrite, UUID_LEN

字段
限定符和类型	字段和说明
`static String`	`CLASS_NAME`

构造器概要

构造器
限定符	构造器和说明
	`AVFile()` default constructor.
	`AVFile(String name, byte[] data)` constructor with name and data.
	`AVFile(String name, File localFile)` constructor with name and local file.
	`AVFile(String name, String url)` constructor with name and external url.
	`AVFile(String name, String url, Map<String,Object> metaData)` constructor with name and external url.
`protected`	`AVFile(String name, String url, Map<String,Object> metaData, boolean external)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addMetaData(String key, Object val)` Add new meta data.
`void`	`clearMetaData()` Cleanup meta data.
`boolean`	`equals(Object o)`
`Object`	`get(String key)` Get file attribute.
`String`	`getBucket()` Get file bucket.
`byte[]`	`getData()` Get data in blocking mode.
`io.reactivex.Observable<byte[]>`	`getDataInBackground()` Get data in async mode.
`InputStream`	`getDataStream()` Get data stream in blocking mode.
`io.reactivex.Observable<InputStream>`	`getDataStreamInBackground()` Get data stream in async mode.
`String`	`getKey()` Get file key.
`Map<String,Object>`	`getMetaData()` Get file meta data.
`Object`	`getMetaData(String key)` Get file meta data.
`String`	`getMimeType()` Get file mime type.
`String`	`getName()` Get file name.
`String`	`getProvider()` Get file provider.
`int`	`getSize()` Get file size.
`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)` Returns a thumbnail image url using QiNiu endpoints.
`String`	`getUrl()` Get file url.
`int`	`hashCode()`
`void`	`increment(String key)` Increment file attribute.
`void`	`increment(String key, Number value)` Increment file attribute.
`void`	`put(String key, Object value)` Set file attribute.
`void`	`remove(String key)` Remove file attribute.
`Object`	`removeMetaData(String key)` Remove file meta data.
`void`	`save()` save to cloud.
`void`	`save(AVUser asAuthenticatedUser)` save to cloud
`void`	`saveEventually()` Save eventually(not supported).
`void`	`saveEventually(AVUser asAuthenticatedUser)` Save eventually(not supported).
`io.reactivex.Observable<AVFile>`	`saveInBackground()` save to cloud backend.
`io.reactivex.Observable<AVFile>`	`saveInBackground(AVUser asAuthenticatedUser, boolean keepFileName)` save to cloud in background.
`void`	`saveInBackground(AVUser asAuthenticatedUser, boolean keepFileName, ProgressCallback progressCallback)` save to cloud in background.
`io.reactivex.Observable<AVFile>`	`saveInBackground(boolean keepFileName)` save to cloud backend.
`void`	`saveInBackground(boolean keepFileName, ProgressCallback progressCallback)` save to cloud backend.
`void`	`saveInBackground(ProgressCallback progressCallback)` save to cloud backend.
`void`	`setMetaData(Map<String,Object> metaData)` Set file meta data.
`void`	`setMimeType(String mimeType)` Set file mime type.
`void`	`setName(String name)` Set file name.
`static void`	`setUploadHeader(String key, String value)`
`Map<String,Object>`	`toMap()` Get map data of current file.
`static AVFile`	`withAbsoluteLocalPath(String name, String absoluteLocalFilePath)` Generate File instance with local path.
`static AVFile`	`withFile(String name, File file)` Generate File instance with local file.
`static io.reactivex.Observable<AVFile>`	`withObjectIdInBackground(String objectId)` Get AVFile instance from objectId.

从类继承的方法 cn.leancloud.AVObject
abortOperations, add, addAll, addAllUnique, addNewOperation, addUnique, bitAnd, bitOr, bitXor, cast, containsKey, createWithoutData, createWithoutData, decrement, decrement, delete, delete, deleteAll, deleteAll, deleteAllInBackground, deleteAllInBackground, deleteEventually, deleteEventually, deleteInBackground, deleteInBackground, disableAfterHook, disableBeforeHook, extractCascadingObjects, extractUnsavedFiles, fetch, fetch, fetch, fetchIfNeeded, fetchIfNeededInBackground, fetchIfNeededInBackground, fetchIfNeededInBackground, fetchInBackground, fetchInBackground, fetchInBackground, generateACLFromServerData, generateCascadingSaveObjects, generateChangedParam, getACL, getAVFile, getAVGeoPoint, getAVObject, getBoolean, getBytes, getClassName, getCreatedAt, getCreatedAtString, getDate, getDouble, getInt, getJSONArray, getJSONObject, getList, getLong, getNumber, getObjectId, getQuery, getRelation, getRequestMethod, getRequestRawEndpoint, getServerData, getString, getUnsavedFiles, getUpdatedAt, getUpdatedAtString, getUuid, has, hasCircleReference, ignoreHook, internalClassName, internalGet, internalId, internalPut, isDataAvailable, isFetchWhenSave, onDataSynchronized, onSaveFailure, onSaveSuccess, parseAVObject, refresh, refresh, refresh, refreshInBackground, refreshInBackground, refreshInBackground, refreshInBackground, registerSubclass, removeAll, removeOperationForKey, resetAll, resetByRawData, resetServerData, saveAll, saveAll, saveAllInBackground, saveAllInBackground, saveInBackground, saveInBackground, saveInBackground, setACL, setClassName, setFetchWhenSave, setObjectId, toJSONObject, toJSONString, toString, validFieldName, verifyInternalId

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - CLASS_NAME
```
public static final String CLASS_NAME
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - AVFile
```
public AVFile()
```
    default constructor.
  - AVFile
```
public AVFile(String name,
              byte[] data)
```
    constructor with name and data.
    
    参数:
    
    name - file name.
    
    data - binary data.
  - AVFile
```
public AVFile(String name,
              File localFile)
```
    constructor with name and local file.
    
    参数:
    
    name - file name.
    
    localFile - local file.
  - AVFile
```
public AVFile(String name,
              String url)
```
    constructor with name and external url.
    
    参数:
    
    name - file name.
    
    url - external url.
  - AVFile
```
public AVFile(String name,
              String url,
              Map<String,Object> metaData)
```
    constructor with name and external url.
    
    参数:
    
    name - file name
    
    url - external url.
    
    metaData - additional attributes.
  - AVFile
```
protected AVFile(String name,
                 String url,
                 Map<String,Object> metaData,
                 boolean external)
```
- 方法详细资料
  - setUploadHeader
```
public static void setUploadHeader(String key,
                                   String value)
```
  - equals
```
public boolean equals(Object o)
```
    覆盖:
    
    equals 在类中 AVObject
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 AVObject
  - withObjectIdInBackground
```
public static io.reactivex.Observable<AVFile> withObjectIdInBackground(String objectId)
```
    Get AVFile instance from objectId.
    
    参数:
    
    objectId - file objectId.
    
    返回:
    
    observable instance.
  - getName
```
public String getName()
```
    Get file name.
    
    返回:
    
    file name.
  - setName
```
public void setName(String name)
```
    Set file name.
    
    参数:
    
    name - file name.
  - getMetaData
```
public Map<String,Object> getMetaData()
```
    Get file meta data.
    
    返回:
    
    meta data.
  - setMetaData
```
public void setMetaData(Map<String,Object> metaData)
```
    Set file meta data.
    
    参数:
    
    metaData - meta data.
  - addMetaData
```
public void addMetaData(String key,
                        Object val)
```
    Add new meta data.
    
    参数:
    
    key - meta key.
    
    val - meta value.
  - getMetaData
```
public Object getMetaData(String key)
```
    Get file meta data.
    
    参数:
    
    key - meta key.
    
    返回:
    
    meta value.
  - removeMetaData
```
public Object removeMetaData(String key)
```
    Remove file meta data.
    
    参数:
    
    key - meta key.
    
    返回:
    
    old value.
  - clearMetaData
```
public void clearMetaData()
```
    Cleanup meta data.
  - getSize
```
public int getSize()
```
    Get file size.
    
    返回:
    
    file size.
  - getMimeType
```
public String getMimeType()
```
    Get file mime type.
    
    返回:
    
    mime type.
  - setMimeType
```
public void setMimeType(String mimeType)
```
    Set file mime type.
    
    参数:
    
    mimeType - mime type.
  - getKey
```
public String getKey()
```
    Get file key.
    
    返回:
    
    file key.
  - getBucket
```
public String getBucket()
```
    Get file bucket.
    
    返回:
    
    file bucket.
  - getUrl
```
public String getUrl()
```
    Get file url.
    
    返回:
    
    file url.
  - getProvider
```
public String getProvider()
```
    Get file provider.
    
    返回:
    
    file provider.
  - put
```
public void put(String key,
                Object value)
```
    Set file attribute.
    
    覆盖:
    
    put 在类中 AVObject
    
    参数:
    
    key - attribute key.
    
    value - attribute value. notice: UnsupportedOperationException
  - get
```
public Object get(String key)
```
    Get file attribute.
    
    覆盖:
    
    get 在类中 AVObject
    
    参数:
    
    key - attribute key.
    
    返回:
    
    attribute value. notice: UnsupportedOperationException
  - remove
```
public void remove(String key)
```
    Remove file attribute.
    
    覆盖:
    
    remove 在类中 AVObject
    
    参数:
    
    key - attribute key. notice: UnsupportedOperationException
  - increment
```
public void increment(String key)
```
    Increment file attribute.
    
    覆盖:
    
    increment 在类中 AVObject
    
    参数:
    
    key - attribute key. notice: UnsupportedOperationException
  - increment
```
public void increment(String key,
                      Number value)
```
    Increment file attribute.
    
    覆盖:
    
    increment 在类中 AVObject
    
    参数:
    
    key - attribute key.
    
    value - step value. notice: UnsupportedOperationException
  - getThumbnailUrl
```
public String getThumbnailUrl(boolean scaleToFit,
                              int width,
                              int height)
```
    Returns a thumbnail image url using QiNiu endpoints.
    
    参数:
    
    scaleToFit - scale param.
    
    width - width.
    
    height - height.
    
    返回:
    
    new url for thumbnail.
    
    另请参阅:
    
    getThumbnailUrl(boolean, int, int, int, String)
  - getThumbnailUrl
```
public String getThumbnailUrl(boolean scaleToFit,
                              int width,
                              int height,
                              int quality,
                              String fmt)
```
    Returns a thumbnail image url using QiNiu endpoints.
    
    参数:
    
    scaleToFit - scale param.
    
    width - width
    
    height - height
    
    quality - quality.
    
    fmt - format string.
    
    返回:
    
    new url for thumbnail.
  - toMap
```
public Map<String,Object> toMap()
```
    Get map data of current file.
    
    返回:
    
    map data.
  - saveInBackground
```
public void saveInBackground(boolean keepFileName,
                             ProgressCallback progressCallback)
```
    save to cloud backend.
    
    参数:
    
    keepFileName - whether keep file name in url or not.
    
    progressCallback - progress callback.
  - saveInBackground
```
public void saveInBackground(AVUser asAuthenticatedUser,
                             boolean keepFileName,
                             ProgressCallback progressCallback)
```
    save to cloud in background.
    
    参数:
    
    asAuthenticatedUser - explicit user for request authentication.
    
    keepFileName - whether keep file name in url or not.
    
    progressCallback - progress callback. in general, this method should be invoked in lean engine.
  - saveInBackground
```
public void saveInBackground(ProgressCallback progressCallback)
```
    save to cloud backend.
    
    参数:
    
    progressCallback - progress callback.
  - saveInBackground
```
public io.reactivex.Observable<AVFile> saveInBackground()
```
    save to cloud backend.
    
    覆盖:
    
    saveInBackground 在类中 AVObject
    
    返回:
    
    Observable object.
  - save
```
public void save()
```
    save to cloud.
    
    覆盖:
    
    save 在类中 AVObject
  - save
```
public void save(AVUser asAuthenticatedUser)
```
    save to cloud
    
    覆盖:
    
    save 在类中 AVObject
    
    参数:
    
    asAuthenticatedUser - explicit user for request authentication.
  - saveInBackground
```
public io.reactivex.Observable<AVFile> saveInBackground(boolean keepFileName)
```
    save to cloud backend.
    
    参数:
    
    keepFileName - whether keep file name in url or not.
    
    返回:
    
    Observable object.
  - saveEventually
```
public void saveEventually()
                    throws AVException
```
    Save eventually(not supported).
    
    覆盖:
    
    saveEventually 在类中 AVObject
    
    抛出:
    
    AVException - exception happened. Because that file size is too big, cache the entire data will cost much disk capacity, so we don't support this method at present.
  - saveEventually
```
public void saveEventually(AVUser asAuthenticatedUser)
                    throws AVException
```
    Save eventually(not supported).
    
    覆盖:
    
    saveEventually 在类中 AVObject
    
    参数:
    
    asAuthenticatedUser - explicit user for request authentication.
    
    抛出:
    
    AVException - exception happened. Because that file size is too big, cache the entire data will cost much disk capacity, so we don't support this method at present.
  - saveInBackground
```
public io.reactivex.Observable<AVFile> saveInBackground(AVUser asAuthenticatedUser,
                                                        boolean keepFileName)
```
    save to cloud in background.
    
    参数:
    
    asAuthenticatedUser - explicit user for request authentication.
    
    keepFileName - whether keep file name in url or not.
    
    返回:
    
    Observable object. in general, this method should be invoked in lean engine.
  - getData
```
public byte[] getData()
```
    Get data in blocking mode.
    
    返回:
    
    data bytes.
  - getDataInBackground
```
public io.reactivex.Observable<byte[]> getDataInBackground()
```
    Get data in async mode.
    
    返回:
    
    observable instance.
  - getDataStream
```
public InputStream getDataStream()
                          throws Exception
```
    Get data stream in blocking mode.
    
    返回:
    
    data stream.
    
    抛出:
    
    Exception - for file not found or io problem.
  - getDataStreamInBackground
```
public io.reactivex.Observable<InputStream> getDataStreamInBackground()
```
    Get data stream in async mode.
    
    返回:
    
    observable instance.
  - withAbsoluteLocalPath
```
public static AVFile withAbsoluteLocalPath(String name,
                                           String absoluteLocalFilePath)
                                    throws FileNotFoundException
```
    Generate File instance with local path.
    
    参数:
    
    name - file name
    
    absoluteLocalFilePath - local path.
    
    返回:
    
    file instance.
    
    抛出:
    
    FileNotFoundException - file not found.
  - withFile
```
public static AVFile withFile(String name,
                              File file)
                       throws FileNotFoundException
```
    Generate File instance with local file.
    
    参数:
    
    name - file name.
    
    file - local file.
    
    返回:
    
    file instance.
    
    抛出:
    
    FileNotFoundException - file not found.

类 AVFile

嵌套类概要

从类继承的嵌套类/接口 cn.leancloud.AVObject

字段概要

从类继承的字段 cn.leancloud.AVObject

构造器概要

方法概要

从类继承的方法 cn.leancloud.AVObject

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

字段详细资料

CLASS_NAME

构造器详细资料

AVFile

AVFile

AVFile

AVFile

AVFile

AVFile

方法详细资料

setUploadHeader

equals

hashCode

withObjectIdInBackground

getName

setName

getMetaData

setMetaData

addMetaData

getMetaData

removeMetaData

clearMetaData

getSize

getMimeType

setMimeType

getKey

getBucket

getUrl

getProvider

put

get

remove

increment

increment

getThumbnailUrl

getThumbnailUrl

toMap

saveInBackground

saveInBackground

saveInBackground

saveInBackground

save

save

saveInBackground

saveEventually

saveEventually

saveInBackground

getData

getDataInBackground

getDataStream

getDataStreamInBackground

withAbsoluteLocalPath

withFile