讯飞文档开发者中心

# API列表

# 激活协作

# 功能概述

文档激活协作模块，使得文档可以在线编辑，多人多端同时协作。

# 接口声明

Future<dynamic> activeCollaboration(
      String fid,
      String accessToken,
      String wsUrl,
      String snapshot,
      String inflightOp,
      String pendingOps) async

# 参数说明

fid： 文档标识，

accessToken：用户令牌，

wsUrl：协作连接的url，

snapshot：当前文档的快照信息，

inflightOp：当前文档正在提交的op操作缓存，

pendingOps：当前文档等待提交的op操作缓存。

# 返回值说明

无返回值。

# 调用时机

文档编辑器加载完成后，通过编辑器视图实例的collaboration属性的方法直接调用。

# 调用示例

editorKey.currentState.activeCollaboration("10EX", "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjIjoiN2U2ZTgwMzUiLCJzIjoxNjM2MzQ3MDc2NTQwLCJ0IjoiQSIsInUiOiIxNjI4MjM1NjI2NDU4IiwiaXNzIjoiYXV0aDAiLCJleHAiOjE2MzY0MzM0NzZ9.Z7oJyiuT6tKjeb1X4QIKzDiV6eGJ4-4_JDo8VZCs2Xc", "wss://devopenapi.iflydocs.com", "", "", "");

# 键盘设置

# 功能概述

隐藏或显示编辑器系统键盘。

# 接口声明

void hideKeyboard(bool isHide)

# 参数说明

isHide： 是否隐藏。

# 返回值说明

无返回值。

# 调用时机

文档编辑器加载完成后，用于需要自定义键盘时。

# 调用示例

editorKey.currentState.hideKeyboard(true);

# 聚焦与失焦

# 功能概述

​ 调整编辑器聚焦与失焦。

# 接口声明

void setFocus(bool isFocus)

# 参数说明

isFocus： 是否聚焦。

# 返回值说明

无返回值。

# 调用时机

文档编辑器加载完成后需要时。

# 调用示例

editorKey.currentState.setFocus(true);

# 加粗

# 功能概述

​ 调整编辑器文本加粗。

# 接口声明

void setBold(bool isBold)

# 参数说明

isBold： 是否加粗。

# 返回值说明

无返回值。

# 调用时机

文档编辑器加载完成后需要时。

# 调用示例

editorKey.currentState.setBold(true);

# 斜体

# 功能概述

​ 调整编辑器文本斜体。

# 接口声明

void setItalic(bool isItalic)

# 参数说明

isItalic： 是否斜体。

# 返回值说明

无返回值。

# 调用时机

文档编辑器加载完成后需要时。

# 调用示例

editorKey.currentState.setItalic(true);

# 下划线

# 功能概述

​ 调整编辑器文本下划线。

# 接口声明

void setUnderline(bool isUnderline)

# 参数说明

isUnderline： 是否下划线。

# 返回值说明

无返回值。

# 调用时机

文档编辑器加载完成后需要时。

# 调用示例

editorKey.currentState.setUnderline(true);

# 删除线

# 功能概述

​ 调整编辑器文本删除线。

# 接口声明

void setStrike(bool strike)

# 参数说明

strike： 是否删除线。

# 返回值说明

无返回值。

# 调用时机

文档编辑器加载完成后需要时。

# 调用示例

editorKey.currentState.setStrike(true);

# 背景颜色

# 功能概述

​ 调整编辑器文本背景颜色。

# 接口声明

void setBackgroundColor(EditorColorStyle backgroundColor)

# 参数说明

backgroundColor：颜色值枚举。

# 返回值说明

无返回值。

# 调用时机

文档编辑器加载完成后需要时。

# 调用示例

editorKey.currentState.setBackgroundColor(EditorColorStyle.EditorColorStandardYellow)

# 字体上下标

# 功能概述

​ 调整编辑器文本上下标的位置。

# 接口声明

void setScript(EditorScriptStyle script)

# 参数说明

script：上下标样式枚举。

# 返回值说明

无返回值。

# 调用时机

文档编辑器加载完成后需要时。

# 调用示例

editorKey.currentState.setScript(EditorScriptStyle.EditorScriptStyleSup)

# 标题

# 功能概述

​ 调整编辑器文本标题。

# 接口声明

void setHeaderStyle(EditorHeaderStyle headerStyle)

# 参数说明

headerStyle：标题样式枚举。

# 返回值说明

无返回值。

# 调用时机

文档编辑器加载完成后需要时。

# 调用示例

editorKey.currentState.setHeaderStyle(EditorHeaderStyle.EditorHeaderStyle1)

# 文本字体大小

# 功能概述

​ 调整编辑器文本字体大小。

# 接口声明

void setFontSize(EditorFontSize fontSize)

# 参数说明

fontSize：字体大小样式枚举。

# 返回值说明

无返回值。

# 调用时机

文档编辑器加载完成后需要时。

# 调用示例

editorKey.currentState.setFontSize(EditorFontSize.EditorFontSize11)

# 文本字体颜色

# 功能概述

​ 调整编辑器文本字体颜色。

# 接口声明

void setColor(EditorColorStyle fontColor)

# 参数说明

fontColor：字体颜色样式枚举。

# 返回值说明

无返回值。

# 调用时机

文档编辑器加载完成后需要时。

# 调用示例

editorKey.currentState.setColor(EditorColorStyle.EditorColorStandardGrey)

# 文本段落对齐

# 功能概述

​ 调整编辑器文本段落对齐。

# 接口声明

void setAlignSyle(EditorAlignStyle alignSyle)

# 参数说明

alignSyle：字体段落对齐样式枚举。

# 返回值说明

无返回值。

# 调用时机

文档编辑器加载完成后需要时。

# 调用示例

editorKey.currentState.setAlignSyle(EditorAlignStyle.EditorAlignLeft)

# 文本列表

# 功能概述

​ 调整编辑器文本列表。

# 接口声明

void setListStyle(EditorListStyle listStyle)

# 参数说明

listStyle：文本列表样式枚举。

# 返回值说明

无返回值。

# 调用时机

文档编辑器加载完成后需要时。

# 调用示例

editorKey.currentState.setListStyle(EditorListStyle.EditorListStyleOrdered)

# 文本待办事项

# 功能概述

​ 调整编辑器文本待办事项。

# 接口声明

void setTagList(EditorToDoListStyle tagList)

# 参数说明

tagList：文本待办事项样式枚举。

# 返回值说明

无返回值。

# 调用时机

文档编辑器加载完成后需要时。

# 调用示例

editorKey.currentState.setTagList(EditorToDoListStyle.EditorToDoListStyleChecked)

# 文本缩进/退

# 功能概述

​ 调整编辑器文本缩进退。

# 接口声明

void changeIndent(EditorIndentStyle indent)

# 参数说明

indent：文本缩进样式枚举。

# 返回值说明

无返回值。

# 调用时机

文档编辑器加载完成后需要时。

# 调用示例

editorKey.currentState.changeIndent(EditorIndentStyle.EditorIndentStyleAdd)

# 文本设置行高

# 功能概述

​ 调整编辑器文本设置行高。

# 接口声明

void setLineHeight(EditorLineHeight lineHeight)

# 参数说明

indent：文本设置行高样式枚举。

# 返回值说明

无返回值。

# 调用时机

文档编辑器加载完成后需要时。

# 调用示例

editorKey.currentState.setLineHeight(EditorLineHeight.EditorLineHeight1)

# 文本插入分割线

# 功能概述

​ 调整编辑器文本插入分隔线。

# 接口声明

void insertDivide()

# 参数说明

无。

# 返回值说明

无返回值。

# 调用时机

文档编辑器加载完成后需要时。

# 调用示例

editorKey.currentState.insertDivide()

# 文本设置引用

# 功能概述

​ 调整编辑器文本设置引用。

# 接口声明

void setBlockQuote()

# 参数说明

无。

# 返回值说明

无返回值。

# 调用时机

文档编辑器加载完成后需要时。

# 调用示例

editorKey.currentState.setBlockQuote()

# 文本设置代码块

# 功能概述

​ 调整编辑器文本设置代码块。

# 接口声明

void setCodeBlock()

# 参数说明

无。

# 返回值说明

无返回值。

# 调用时机

文档编辑器加载完成后需要时。

# 调用示例

editorKey.currentState.setCodeBlock()

# 文本设置链接

# 功能概述

​ 调整编辑器文本设置链接。

# 接口声明

void setLink(String linkName,String linkAddress)

# 参数说明

linkName：链接名称； linkAddress：链接地址 url。

# 返回值说明

无返回值。

# 调用时机

文档编辑器加载完成后需要时。

# 调用示例

editorKey.currentState.setLink('百度','http://www.baidu.com')

# 文字文档刷新用户Token

# 功能概述

​ 文字文档刷新用户Token。

# 接口声明

void refreshToken(String newAccessToken)

# 参数说明

newAccessToken：新的token令牌。

# 返回值说明

无返回值。

# 调用时机

文档编辑器token失效后，重新加载。

# 调用示例

editorKey.currentState.refreshToken('xxx令牌xx')

# 文字文档刷新文档fid

# 功能概述

​ 文字文档刷新文档fid。

# 接口声明

void refreshFid(String newFid)

# 参数说明

newFid：文档fid

# 返回值说明

无返回值。

# 调用时机

文档编辑器重新刷新fid。

# 调用示例

editorKey.currentState.refreshFid('xxxfidxx')

# 文字文档关闭websocket并得到缓存数据

# 功能概述

​ 文字文档关闭websocket并得到缓存数据

# 接口声明

Future<dynamic> closeWebsocketAndGetCacheData()

# 参数说明

无

# 返回值说明

Future<dynamic>，接受编辑器返回的数据。

# 调用时机

文档编辑器关闭时调用。

# 调用示例

editorKey.currentState.closeWebsocketAndGetCacheData().then((value){
      //处理数据
})

# 文字文档历史记录还原

# 功能概述

​ 文字文档历史记录还原

# 接口声明

void revertHistoryVersion(String targetVersion)

# 参数说明

targetVersion：目标历史记录的版本号

# 返回值说明

无返回值。

# 调用时机

文档编辑器设置了历史记录的还原。

# 调用示例

editorKey.currentState.revertHistoryVersion(targetVersion)

# 文字文档插入图片占位

# 功能概述

​ 文字文档插入图片占位

# 接口声明

void insertImagePlaceholder(String objectId, String localPath )

# 参数说明

objectId：图片的objectId； localPath：图片资源的url。

# 返回值说明

无返回值。

# 调用时机

文档编辑器插入图片时。

# 调用示例

editorKey.currentState.insertImagePlaceholder(String objectId, String localPath )

# 文字文档更新图片上传进度

# 功能概述

​ 文字文档更新图片上传进度

# 接口声明

void updateImageStatus(String objectId, String localPath, int nowProgress, int width,int height, int size )

# 参数说明

objectId：图片的objectId； localPath：图片资源的url； nowProgress：当前的更新进度； width：图片的宽度； height：图片的高度； size：图片的大小。

# 返回值说明

无返回值。

# 文字文档加载图片

# 功能概述

​ 文字文档加载图片

# 接口声明

void loadImage(String objectId, String localPath)

# 参数说明

objectId：图片的objectId； localPath：图片资源的url。

# 返回值说明

无返回值。

# 文字文档获取所有的图片

# 功能概述

​ 文字文档获取所有的图片

# 接口声明

Future<String> getImageList()

# 参数说明

无

# 返回值说明

Future<String> 文档内的所有图片。

# 文字文档插入音频占位

# 功能概述

​ 文字文档插入音频占位

# 接口声明

insertAudio(String objectId, String fileName,int fileSize )

# 参数说明

objectId：音频的objectId； fileName：音频的名称。

# 返回值说明

无。

# 文字文档音频上传进度

# 功能概述

​ 文字文档音频上传进度

# 接口声明

updateAudioStatus(String objectId, String name, int size , int nowProgress,String status)

# 参数说明

objectId：音频的objectId； name：音频名称； nowProgress：当前的更新进度； status：进度状态 success，fail，progress。

# 返回值说明

无。

# 文字文档加载音频

# 功能概述

​ 文字文档加载音频

# 接口声明

void audioObjectId2src(String objectId, String localPath)

# 参数说明

objectId：音频的objectId； localPath：音频资源的url。

# 返回值说明

无返回值。

# 文字文档音频重命名

# 功能概述

​ 文字文档音频重命名

# 接口声明

void renameAudio(String objectId, String name)

# 参数说明

objectId：音频的objectId； name：音频的重命名名称。

# 返回值说明

无返回值。

# 文字文档插入附件占位

# 功能概述

​ 文字文档插入附件占位

# 接口声明

void insertAttachment(String objectId, String fileName,int fileSize )

# 参数说明

objectId：附件的objectId； fileName：附件名称。 fileSize：附件大小。

# 返回值说明

无返回值。

# 文字文档附件上传进度

# 功能概述

​ 文字文档附件上传进度

# 接口声明

void updateAttachmentStatus(String objectId, String name, int size, int nowProgress,String status )

# 参数说明

objectId：附件的objectId； name：附件名称； nowProgress：当前的更新进度； status：进度状态 success，fail，progress。

# 返回值说明

无返回值。

# 文字文档撤销与恢复

# 功能概述

​ 文字文档撤销与恢复

# 接口声明

void undoRedo(bool undoRedo)

# 参数说明

undoRedo：true 撤销，false 恢复。

# 返回值说明

无返回值。

# 文字文档搜索

# 功能概述

​ 文字文档搜索

# 接口声明

void search(String searchText)

# 参数说明

searchText：搜索内容。

# 返回值说明

无返回值。

# 文字文档搜索下一个

# 功能概述

​ 文字文档搜索下一个

# 接口声明

void searchNext()

# 参数说明

无。

# 返回值说明

无返回值。

# 文字文档搜索上一个

# 功能概述

​ 文字文档搜索上一个

# 接口声明

void searchPrev()

# 参数说明

无。

# 返回值说明

无返回值。

# 文字文档搜索清除

# 功能概述

​ 文字文档搜索清除

# 接口声明

void searchClear()

# 参数说明

无。

# 返回值说明

无返回值。

# 文字文档搜索替换

# 功能概述

​ 文字文档搜索替换

# 接口声明

void replace(bool isAll, String text)

# 参数说明

isAll：bool替换所有； text：替换内容。

# 返回值说明

无返回值。

# 文字文档获取预览内容

# 功能概述

​ 文字文档获取预览内容

# 接口声明

Future<String> getPreContent()

# 参数说明

无。

# 返回值说明

Future<String> 预览内容。

# 文字文档清除协作光标

# 功能概述

​ 文字文档清除协作光标

# 接口声明

void setHinddenCollaborateCursor(bool isHide)

# 参数说明

isHide：bool值。

# 返回值说明

无返回值。

# 文字文档滑动到可视区域

# 功能概述

​ 文字文档滑动到可视区域

# 接口声明

void scrollToViewArea()

# 参数说明

无。

# 返回值说明

无返回值。

# 文字文档插入文本

# 功能概述

​ 文字文档插入文本

# 接口声明

appendText({String? text,int index = -1})

# 参数说明

text：插入文本内容； index：指定位置的index。

# 返回值说明

无返回值。

# 文字文档设置选区

# 功能概述

​ 文字文档设置选区

# 接口声明

setSelection({int? index,int? length})

# 参数说明

index：指定位置的index； length: 长度。

# 返回值说明

无返回值。

# 文字文档获得选区

# 功能概述

​ 文字文档获得选区

# 接口声明

Future<dynamic> getSelection()

# 参数说明

无。

# 返回值说明

Future<dynamic> 获得选区内容。

# 文字文档原生执行javascript

# 功能概述

​ 文字文档原生执行javascript

# 接口声明

Future<dynamic> javascriptDo(String jsStr)

# 参数说明

jsStr：原生js语句。

# 返回值说明

Future<dynamic> 获得指定的内容。

# 文字文档删除指定blot

# 功能概述

​ 文字文档删除指定blot

# 接口声明

 deleteObjectId(String objectId)

# 参数说明

objectId：blot的objectid

# 返回值说明

无返回值。

# 文字文档删除文本

# 功能概述

​文字文档删除文本

# 接口声明

deleteText({int? index,int length = 1})

# 参数说明

index：从index删除； length: 删除的长度。

# 返回值说明

无返回值。

# 文字文档背景图片设置

# 功能概述

​ 文字文档背景图片设置，执行设置背景图片

# 接口声明

  editorDivBackground(String picPath)

# 参数说明

参数是图片的地址url picPath:网络图片或本地图片(http协议/file协议)

# 返回值说明

无返回值。

← 历史记录页使用 →