FileAttachment

java.lang.Object
- com.netease.nimlib.sdk.msg.attachment.FileAttachment

所有已实现的接口:

MsgAttachment, java.io.Serializable

直接已知子类:

AudioAttachment, ImageAttachment, VideoAttachment
```
public class FileAttachment
extends java.lang.Object
implements MsgAttachment
```
带有文件的附件类型的基类描述文件的相关信息

另请参阅:

序列化表格

字段概要

字段
限定符和类型	字段和说明
`protected java.lang.String`	`displayName` 文件显示名
`protected java.lang.String`	`extension` 文件后缀名
`protected boolean`	`forceUpload` 如果服务器存在相同的附件文件，是否强制重新上传，默认false
`protected java.lang.String`	`md5` 文件内容的MD5
`protected java.lang.String`	`nosTokenSceneKey` 上传文件时用的对token对应的场景，默认`NimNosSceneKeyConstant#NIM_DEFAULT_IM`
`protected java.lang.String`	`path` 文件路径
`protected long`	`size` 文件大小
`protected java.lang.String`	`url` 文件下载地址

构造器概要

构造器
构造器和说明

FileAttachment()

FileAttachment(java.lang.String attach)

构造器
构造器和说明
`FileAttachment()`
`FileAttachment(java.lang.String attach)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`java.lang.String`	`getDisplayName()` 获取文件的显示名。
`long`	`getExpire()`
`java.lang.String`	`getExtension()` 获取文件后缀名
`java.lang.String`	`getFileName()` 获取文件名。
`java.lang.String`	`getMd5()` 获取文件内容MD5
`java.lang.String`	`getNosTokenSceneKey()` 获取文件上传时的nos scene
`java.lang.String`	`getPath()` 获取文件本地路径，若文件不存在，返回null
`java.lang.String`	`getPathForSave()` 获取用于保存该文件的位置
`long`	`getSize()` 获取文件大小，单位为byte
`java.lang.String`	`getThumbPath()` 获取缩略图文件的本地路径，若文件不存在，返回null
`java.lang.String`	`getThumbPathForSave()` 获取用于保存缩略图文件的位置
`Uri`	`getUri()`
`java.lang.String`	`getUrl()` 获取文件在服务器上的下载url。
`boolean`	`isForceUpload()` 文件是否强制重新上传
`protected void`	`load(JSONObject json)`
`protected void`	`save(JSONObject json)`
`void`	`setDisplayName(java.lang.String displayName)` 设置文件显示名
`void`	`setExtension(java.lang.String extension)` 设置文件后缀名
`void`	`setForceUpload(boolean forceUpload)` 设置文件是否强制重新上传，默认false
`void`	`setMd5(java.lang.String md5)` 设置文件内容MD5
`void`	`setNosTokenSceneKey(java.lang.String nosTokenSceneKey)` 设置文件上传时的nos scene
`void`	`setPath(java.lang.String path)` 设置文件路径
`void`	`setSize(long size)` 设置文件大小，单位为byte
`boolean`	`setUri(Uri uri)` 设置文件uri，仅支持ContentResolver.SCHEME_FILE类型和ContentResolver.SCHEME_CONTENT类型的uri 仅支持发送消息时使用，接收的消息附件不支持uri
`void`	`setUrl(java.lang.String url)` 设置文件在服务器上的下载url
`protected NimStorageType`	`storageType()`
`java.lang.String`	`toJson(boolean send)` 将消息附件序列化为字符串，存储到消息数据库或发送到服务器。

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

- 字段详细资料
  - path
```
protected java.lang.String path
```
    文件路径
  - size
```
protected long size
```
    文件大小
  - md5
```
protected java.lang.String md5
```
    文件内容的MD5
  - url
```
protected java.lang.String url
```
    文件下载地址
  - displayName
```
protected java.lang.String displayName
```
    文件显示名
  - extension
```
protected java.lang.String extension
```
    文件后缀名
  - nosTokenSceneKey
```
protected java.lang.String nosTokenSceneKey
```
    上传文件时用的对token对应的场景，默认NimNosSceneKeyConstant#NIM_DEFAULT_IM
  - forceUpload
```
protected boolean forceUpload
```
    如果服务器存在相同的附件文件，是否强制重新上传，默认false
- 构造器详细资料
  - FileAttachment
```
public FileAttachment()
```
  - FileAttachment
```
public FileAttachment(java.lang.String attach)
```
- 方法详细资料
  - getPath
```
public java.lang.String getPath()
```
    获取文件本地路径，若文件不存在，返回null
    
    返回:
    
    文件路径
  - getPathForSave
```
public java.lang.String getPathForSave()
```
    获取用于保存该文件的位置
    
    返回:
    
    文件路径
  - getThumbPath
```
public java.lang.String getThumbPath()
```
    获取缩略图文件的本地路径，若文件不存在，返回null
    
    返回:
    
    文件路径
  - getThumbPathForSave
```
public java.lang.String getThumbPathForSave()
```
    获取用于保存缩略图文件的位置
    
    返回:
    
    文件路径
  - setPath
```
public void setPath(java.lang.String path)
```
    设置文件路径
    
    参数:
    
    path - 文件路径
  - setUri
```
public boolean setUri(Uri uri)
```
    设置文件uri，仅支持ContentResolver.SCHEME_FILE类型和ContentResolver.SCHEME_CONTENT类型的uri 仅支持发送消息时使用，接收的消息附件不支持uri
    
    参数:
    
    uri -
    
    返回:
    
    false表示不支持的uri
  - getUri
```
public Uri getUri()
```
  - getSize
```
public long getSize()
```
    获取文件大小，单位为byte
    
    返回:
    
    文件大小
  - setSize
```
public void setSize(long size)
```
    设置文件大小，单位为byte
    
    参数:
    
    size - 文件大小
  - getMd5
```
public java.lang.String getMd5()
```
    获取文件内容MD5
    
    返回:
    
    内容MD5
  - setMd5
```
public void setMd5(java.lang.String md5)
```
    设置文件内容MD5
    
    参数:
    
    md5 - 内容MD5
  - getUrl
```
public java.lang.String getUrl()
```
    获取文件在服务器上的下载url。若文件还未上传，返回null
    
    返回:
    
    源站url
  - setUrl
```
public void setUrl(java.lang.String url)
```
    设置文件在服务器上的下载url
    
    参数:
    
    url -
  - getExtension
```
public java.lang.String getExtension()
```
    获取文件后缀名
    
    返回:
    
    后缀名
  - setExtension
```
public void setExtension(java.lang.String extension)
```
    设置文件后缀名
    
    参数:
    
    extension - 后缀名
  - getFileName
```
public java.lang.String getFileName()
```
    获取文件名。
    
    返回:
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    获取文件的显示名。可以和文件名不同，仅用于界面展示
    
    返回:
    
    文件显示名
  - setDisplayName
```
public void setDisplayName(java.lang.String displayName)
```
    设置文件显示名
    
    参数:
    
    displayName - 文件显示名
  - getNosTokenSceneKey
```
public java.lang.String getNosTokenSceneKey()
```
    获取文件上传时的nos scene
    
    返回:
    
    nos scene
  - setNosTokenSceneKey
```
public void setNosTokenSceneKey(java.lang.String nosTokenSceneKey)
```
    设置文件上传时的nos scene
    
    参数:
    
    nosTokenSceneKey -
  - getExpire
```
public long getExpire()
```
  - isForceUpload
```
public boolean isForceUpload()
```
    文件是否强制重新上传
    
    返回:
    
    force upload
  - setForceUpload
```
public void setForceUpload(boolean forceUpload)
```
    设置文件是否强制重新上传，默认false
    
    参数:
    
    forceUpload - 是否强制重新上传
  - storageType
```
protected NimStorageType storageType()
```
  - save
```
protected void save(JSONObject json)
```
  - load
```
protected void load(JSONObject json)
```
  - toJson
```
public java.lang.String toJson(boolean send)
```
    从接口复制的说明: MsgAttachment
    
    将消息附件序列化为字符串，存储到消息数据库或发送到服务器。
    
    指定者:
    
    toJson 在接口中 MsgAttachment
    
    参数:
    
    send - 如果你的附件在本地需要存储额外数据，而这些数据不需要发送到服务器，可依据该参数值区别对待。
    
    返回:

类 FileAttachment

字段概要

构造器概要

方法概要

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

字段详细资料

path

size

md5

url

displayName

extension

nosTokenSceneKey

forceUpload

构造器详细资料

FileAttachment

FileAttachment

方法详细资料

getPath

getPathForSave

getThumbPath

getThumbPathForSave

setPath

setUri

getUri

getSize

setSize

getMd5

setMd5

getUrl

setUrl

getExtension

setExtension

getFileName

getDisplayName

setDisplayName

getNosTokenSceneKey

setNosTokenSceneKey

getExpire

isForceUpload

setForceUpload

storageType

save

load

toJson