# Class FileMessage

文件消息

#### Version

1.0.0

#### Hierarchy (View Summary)

- MediaMessageContent
  - FileMessage

- Defined in message/content/media/FileMessage.ts:24

##### Index

### Constructors

constructor

### Properties

name
localPath
remoteUrl
extra?
userInfo?
mentionedInfo?
rawString?
destructDuration?
size
type

### Methods

getCorrectedLocalPath
encodeBaseData
decodeBaseData
encode
decode
getClassName
getSearchableWord

## Constructors

### constructor

- new FileMessage(): FileMessage

  无参构造方法

  #### Returns FileMessage

  Overrides MediaMessageContent.constructor

  - Defined in message/content/media/FileMessage.ts:37

## Properties

### name

name: string = ''

媒体资源的名称

Inherited from MediaMessageContent.name

- Defined in message/content/MediaMessageContent.ts:124

### localPath

localPath: string = ''

媒体资源的本地路径

Inherited from MediaMessageContent.localPath

- Defined in message/content/MediaMessageContent.ts:128

### remoteUrl

remoteUrl: string = ''

媒体资源的远端地址

Inherited from MediaMessageContent.remoteUrl

- Defined in message/content/MediaMessageContent.ts:132

### `Optional` extra

extra?: string

消息的附加信息，会随着消息发送出去

#### See

Message.extra

Inherited from MediaMessageContent.extra

- Defined in message/content/MessageContent.ts:120

### `Optional` userInfo

userInfo?: UserInfo

消息携带的用户信息

Inherited from MediaMessageContent.userInfo

- Defined in message/content/MessageContent.ts:124

### `Optional` mentionedInfo

mentionedInfo?: MentionedInfo

消息的 @ 信息

Inherited from MediaMessageContent.mentionedInfo

- Defined in message/content/MessageContent.ts:128

### `Optional` rawString

rawString?: string

消息的原始内容

SDK 执行消息的 decode 方法正常时，会将数据解析到消息的各个字段，rawString 将会为空

如果 decode 方法异常时会将消息的原始数据保存在 rawString 中

Inherited from MediaMessageContent.rawString

- Defined in message/content/MessageContent.ts:137

### `Optional` destructDuration

destructDuration?: number

阅后即焚时长，单位秒

    destructDuration <= 0 代表是普通消息
    destructDuration > 0 代表是阅后即焚消息，该消息已读后，经过 destructDuration 时间后销毁

#### Version

1.3.0

Inherited from MediaMessageContent.destructDuration

- Defined in message/content/MessageContent.ts:147

### size

size: number = 0

文件大小，单位为 Byte

- Defined in message/content/media/FileMessage.ts:28

### type

type: string = ''

文件类型

- Defined in message/content/media/FileMessage.ts:32

## Methods

### getCorrectedLocalPath

- getCorrectedLocalPath(localPath: string): string

  获取正常的 localPath ，去掉 file://

  在鸿蒙系统内部，沙盒路径需要用 file:// 开头才能被 fs 识别

  原生层使用不能以 file:// 开头

  #### Parameters

  - localPath: string

  #### Returns string

  Inherited from MediaMessageContent.getCorrectedLocalPath

  - Defined in message/content/MediaMessageContent.ts:144

### encodeBaseData

- encodeBaseData(): HashMap<string, Object>

  将基类的基础数据保存到 map 中

  #### Returns HashMap<string, Object>

  Inherited from MediaMessageContent.encodeBaseData

  - Defined in message/content/MessageContent.ts:195

### decodeBaseData

- decodeBaseData(map: HashMap<string, Object>): void

  将基类的基础数据从 map 中解析出来

  #### Parameters

  - map: HashMap<string, Object>

  #### Returns void

  Inherited from MediaMessageContent.decodeBaseData

  - Defined in message/content/MessageContent.ts:216

### encode

- encode(): string

  编码方法，将消息转为 json 字符串

  #### Returns string

  json 字符串

  Overrides MediaMessageContent.encode

  - Defined in message/content/media/FileMessage.ts:45

### decode

- decode(contentString: string): void

  解码方法，将 json 字符串转为消息

  #### Parameters

  - contentString: string

    json 字符串

  #### Returns void

  Overrides MediaMessageContent.decode

  - Defined in message/content/media/FileMessage.ts:70

### getClassName

- getClassName(): string

  获取类名

  #### Returns string

  类名

  Overrides MediaMessageContent.getClassName

  - Defined in message/content/media/FileMessage.ts:95

### getSearchableWord

- getSearchableWord(): any

  实现搜索方法

  #### Returns any

  需要搜索的内容

  Overrides MediaMessageContent.getSearchableWord

  - Defined in message/content/media/FileMessage.ts:103