FileAttachment

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

All Implemented Interfaces:

MsgAttachment, java.io.Serializable

Direct Known Subclasses:

AudioAttachment, ImageAttachment, VideoAttachment
```
public class FileAttachment
extends java.lang.Object
implements MsgAttachment
```
File attachment class File description

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`displayName` File display name
`protected java.lang.String`	`extension` File extension
`protected boolean`	`forceUpload` If the same file already exists on the server, specify whether to upload forcibly.
`protected java.lang.String`	`md5` MD5 value of the file content
`protected java.lang.String`	`nosTokenSceneKey` NOS token used for uploading files.
`protected java.lang.String`	`path` File path
`protected long`	`size` File size
`protected java.lang.String`	`url` File download URL

Constructor Summary

Constructors
Constructor and Description

FileAttachment()

FileAttachment(java.lang.String attach)

Constructors
Constructor and Description
`FileAttachment()`
`FileAttachment(java.lang.String attach)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getDisplayName()` Get the display name of a file.
`long`	`getExpire()`
`java.lang.String`	`getExtension()` Get the file extension
`java.lang.String`	`getFileName()` Get the file name
`java.lang.String`	`getMd5()` Get the MD5 value of the file content
`java.lang.String`	`getNosTokenSceneKey()` Get the NOS token for uploading files
`java.lang.String`	`getPath()` Get the local file path.
`java.lang.String`	`getPathForSave()` Get the file path for save.
`long`	`getSize()` Get the size of a file in bytes
`java.lang.String`	`getThumbPath()` Get the local file path of the thumbnail.
`java.lang.String`	`getThumbPathForSave()` Get the path for saving thumbnails
`java.lang.String`	`getUrl()` Get the download URL of a file on the server.
`boolean`	`isForceUpload()` Check if the file are forcibly upload again
`protected void`	`load(JSONObject json)`
`protected void`	`save(JSONObject json)`
`void`	`setDisplayName(java.lang.String displayName)` Set the display name of a file
`void`	`setExtension(java.lang.String extension)` Set the file extension
`void`	`setForceUpload(boolean forceUpload)` Set to forcibly upload again.
`void`	`setMd5(java.lang.String md5)` Set the MD5 value of the file content
`void`	`setNosTokenSceneKey(java.lang.String nosTokenSceneKey)` Set the NOS token for uploading files
`void`	`setPath(java.lang.String path)` Set the file path
`void`	`setSize(long size)` Set the size of a file in bytes
`void`	`setUrl(java.lang.String url)` Set the download URL of a file stored on the server
`protected NimStorageType`	`storageType()`
`java.lang.String`	`toJson(boolean send)` Serialize message attachment to strings and store the strings in the message database or send them to the server.

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

- Field Detail
  - path
```
protected java.lang.String path
```
    File path
  - size
```
protected long size
```
    File size
  - md5
```
protected java.lang.String md5
```
    MD5 value of the file content
  - url
```
protected java.lang.String url
```
    File download URL
  - displayName
```
protected java.lang.String displayName
```
    File display name
  - extension
```
protected java.lang.String extension
```
    File extension
  - nosTokenSceneKey
```
protected java.lang.String nosTokenSceneKey
```
    NOS token used for uploading files. The default value is NimNosSceneKeyConstant#NIM_DEFAULT_IM
  - forceUpload
```
protected boolean forceUpload
```
    If the same file already exists on the server, specify whether to upload forcibly. The default value is false.
- Constructor Detail
  - FileAttachment
```
public FileAttachment()
```
  - FileAttachment
```
public FileAttachment(java.lang.String attach)
```
- Method Detail
  - getPath
```
public java.lang.String getPath()
```
    Get the local file path. If the file does not exit, null is returned.
    
    Returns:
    
    The file path
  - getPathForSave
```
public java.lang.String getPathForSave()
```
    Get the file path for save.
    
    Returns:
    
    The file path
  - getThumbPath
```
public java.lang.String getThumbPath()
```
    Get the local file path of the thumbnail. If the thumbnail does not exist, null is returned.
    
    Returns:
    
    The file path
  - getThumbPathForSave
```
public java.lang.String getThumbPathForSave()
```
    Get the path for saving thumbnails
    
    Returns:
    
    The file path
  - setPath
```
public void setPath(java.lang.String path)
```
    Set the file path
    
    Parameters:
    
    path - The file path
  - getSize
```
public long getSize()
```
    Get the size of a file in bytes
    
    Returns:
    
    The size of a file
  - setSize
```
public void setSize(long size)
```
    Set the size of a file in bytes
    
    Parameters:
    
    size - The size of a file
  - getMd5
```
public java.lang.String getMd5()
```
    Get the MD5 value of the file content
    
    Returns:
    
    MD5 value
  - setMd5
```
public void setMd5(java.lang.String md5)
```
    Set the MD5 value of the file content
    
    Parameters:
    
    md5 - MD5 value
  - getUrl
```
public java.lang.String getUrl()
```
    Get the download URL of a file on the server. If the file is not uploaded, null is returned.
    
    Returns:
    
    URL on the origin
  - setUrl
```
public void setUrl(java.lang.String url)
```
    Set the download URL of a file stored on the server
    
    Parameters:
    
    url -
  - getExtension
```
public java.lang.String getExtension()
```
    Get the file extension
    
    Returns:
    
    The file extension
  - setExtension
```
public void setExtension(java.lang.String extension)
```
    Set the file extension
    
    Parameters:
    
    extension - The file extension
  - getFileName
```
public java.lang.String getFileName()
```
    Get the file name
    
    Returns:
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Get the display name of a file. The display name can be different from the file name and used for display on UI.
    
    Returns:
    
    Display name
  - setDisplayName
```
public void setDisplayName(java.lang.String displayName)
```
    Set the display name of a file
    
    Parameters:
    
    displayName - The display name
  - getNosTokenSceneKey
```
public java.lang.String getNosTokenSceneKey()
```
    Get the NOS token for uploading files
    
    Returns:
    
    nos scene
  - setNosTokenSceneKey
```
public void setNosTokenSceneKey(java.lang.String nosTokenSceneKey)
```
    Set the NOS token for uploading files
    
    Parameters:
    
    nosTokenSceneKey -
  - getExpire
```
public long getExpire()
```
  - isForceUpload
```
public boolean isForceUpload()
```
    Check if the file are forcibly upload again
    
    Returns:
    
    force upload
  - setForceUpload
```
public void setForceUpload(boolean forceUpload)
```
    Set to forcibly upload again. The default value is false
    
    Parameters:
    
    forceUpload - Specify whether to forcibly upload again
  - storageType
```
protected NimStorageType storageType()
```
  - save
```
protected void save(JSONObject json)
```
  - load
```
protected void load(JSONObject json)
```
  - toJson
```
public java.lang.String toJson(boolean send)
```
    Description copied from interface: MsgAttachment
    
    Serialize message attachment to strings and store the strings in the message database or send them to the server.
    
    Specified by:
    
    toJson in interface MsgAttachment
    
    Parameters:
    
    send - If attachments are required to be stored in local storage and not to be sent to the server. The parameter can be specified.
    
    Returns:

Class FileAttachment

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

path

size

md5

url

displayName

extension

nosTokenSceneKey

forceUpload

Constructor Detail

FileAttachment

FileAttachment

Method Detail

getPath

getPathForSave

getThumbPath

getThumbPathForSave

setPath

getSize

setSize

getMd5

setMd5

getUrl

setUrl

getExtension

setExtension

getFileName

getDisplayName

setDisplayName

getNosTokenSceneKey

setNosTokenSceneKey

getExpire

isForceUpload

setForceUpload

storageType

save

load

toJson