Harmony

Document

Index

---

Accessors

---

• docData

Methods

addDoc	addPage	addShape
appendShape	changePage	off
on	one	removeDoc
removePage	removeShapes	requestAllDocs
requestAllShapes	requestRemark	sendLaser
setPageUrlFormat	setWhiteboardImageConfig	updateDoc
updateShapes

Accessors

---

docData
获取 doc 数据对象

get docData(): DocData‹›

返回

• DocData‹›

Methods

---

addDoc
向房间内添加一个文档

addDoc(doc: UploadDoc): Promise‹Doc›

参数

Name	Type	Description
doc	UploadDoc	文档数据

返回

• Promise‹Doc›

---

addPage
添加一页白板

addPage(): Promise‹object›

返回

• Promise‹object›

---

addShape
添加一个标注

addShape(docId: string, page: number, shape: ShapeSignalData): Promise‹object›

参数

Name	Type	Description
docId	string	文档 id
page	number	文档页码
shape	ShapeSignalData	标注

返回

• Promise‹object›

---

appendShape
追加一个标注

appendShape(docId: string, page: number, shape: ShapeSignalData): Promise‹object›

参数

Name	Type	Description
docId	string	文档 id
page	number	文档页码
shape	ShapeSignalData	标注

返回

• Promise‹object›

---

changePage
同步翻页

changePage(docId: string, page: number, step: number, event?: PPTEvent): Promise‹void›

参数

Name	Type	Default	Description
docId	string	-	翻页的文档 id
page	number	-	翻到哪一个页码
step	number	0	翻到哪一步（动态文档）
event?	PPTEvent	-	触发一个事件

返回

• Promise‹void›

---

off
取消事件监听

off(type: string, listener?: Function): this

• Inherited from Model.off

参数

Name	Type	Description
type	string	事件类型
listener?	Function	绑定函数

返回

• this

---

on
设置事件监听

on(type: string, listener: Function, options: EmitterOptions): this

• Inherited from Model.on

参数

Name	Type	Description
type	string	事件类型
listener?	Function	监听函数
options	EmitterOptions	监听选项

返回

• this

---

one
设置一次事件监听

one(type: string, listener: Function, options: EmitterOptions): this

• Inherited from Model.one

参数

Name	Type	Description
type	string	事件类型
listener?	Function	监听函数
options	EmitterOptions	监听选项

返回

• this

---

removeDoc
移除文档

removeDoc(docId: string): Promise‹void | Doc›

参数

Name	Type	Description
docId	string	需要移除的文档 id

返回

• Promise‹void | Doc›

---

removePage
删除一页白板

removePage(page: number): Promise‹object›

参数

Name	Type	Description
page	number	删除的 page index

返回

• Promise‹object›

---

removeShapes
移除标注

removeShapes(docId: string, page: number, shapeId: string): Promise‹object›

参数

Name	Type	Description
docId	string	文档 id
page	number	文档页码
shapeId	string	需要移除的标注 id，通过 ',' 拼接

返回

• Promise‹object›

---

requestAllDocs
请求所有文档

requestAllDocs(): Promise‹object›

返回

• Promise‹object›

---

requestAllShapes
请求某一页的所有标注

requestAllShapes(docId: string, page: number): Promise‹ShapeSignalData[]›

参数

Name	Type	Description
docId	string	文档 id
page	number	文档页码
shapeId	string	需要移除的标注 id，通过 ',' 拼接

返回

• Promise‹ShapeSignalData[]›

---

requestRemark
请求水印

equestRemark(docId: string): Promise‹object›

Name	Type
docId	string

返回

• Promise‹object›

---

sendLaser
发送激光笔坐标

sendLaser(laser: Laser): void  

参数

Name	Type	Description
laser	Laser	激光坐标

返回

• void

---

setPageUrlFormat
设置文档页 url 格式器

setPageUrlFormat(pageUrlFormat: function): void  

参数

▪ pageUrlFormat: function ▸ (prefix: string, page: number, doc: Doc): string

Name	Type
prefix	string
page	number
doc	Doc

返回

• void

---

setWhiteboardImageConfig
设置自定义白板图片

setWhiteboardImageConfig(options: WhiteboardImageConfig): void  

参数

Name	Type	Description
options	WhiteboardImageConfig	白板配置

返回

• void

---

updateDoc
更新房间内的文档

updateDoc(data: object): Promise‹Doc›

参数

• data: object(更新字段)

Name	Type
docId	string
extra	Doc["extra"]

返回

• Promise‹Doc›

---

updateShapes
更新标注

updateShapes(docId: string, page: number, shapeList: ShapeSignalData[]): Promise‹object›

参数

Name	Type	Description
docId	string	文档 id
page	number	文档页码
shapeList	ShapeSignalData[]	更新的标注数组

返回

• Promise‹object›

DocumentEvents

Index

---

DOC_ALL	DOC_ADDED	DOC_UPDATED
DOC_REMOVED	PAGE_ADDED	PAGE_CHANGED
PAGE_REMOVED	SHAPE_ADDED	SHAPE_APPENDED
SHAPE_UPDATED	SHAPE_REMOVED	LASER_RECEIVED

Variables

---

收到所有文档

client.on('doc-all', (event) => {
});

---

添加文档

client.on('doc-added', (event) => {
});

---

更新文档

client.on('doc-updated', (event) => {
});

---

移除文档

client.on('doc-removed', (event) => {
});

---

添加白板

client.on('page-added', (event) => {
});

---

翻页

client.on('page-changed', (event) => {
});

---

添加白板

client.on('page-added', (event) => {
});

---

删除白板

client.on('page-removed', (event) => {
});

---

添加标注

client.on('shape-added', (event) => {
});

---

追加标注

client.on('shape-appended', (event) => {
});

---

更新标注

client.on('shape-updated', (event) => {
});

---

移除标注

client.on('shape-removed', (event) => {
});

---

收到激光笔

client.on('laser-received', (event) => {
});