WebPageInfo

类型: interface

页面信息

• API

pageId

类型: string

页面 ID

bkInfo

类型: { bkColor?: string; bkImage?: string; bkImageFillType?: BkFillType; bkImageSize?: BkImageSize; }

背景设置

• 成员

  名称	类型	描述
  bkColor	string	背景颜色
  bkImage	string	背景图片
  bkImageFillType	BkFillType	背景图片填充设置
  bkImageSize	BkImageSize	背景图片尺寸

extra

类型: string

BkFillType

类型: enum

• 成员

BkImageSize

类型: interface

• API

width

类型: number

height

类型: number

WebBoardInfo

类型: interface

白板信息

• API

boardId

类型: number

白板 ID

pages

类型: WebPageInfo[]

页面信息

currentPageId

类型: string

当前页面 ID

status

类型: StatusType

是否可用

controlCount

类型: { [key: string]: number; }

可编辑用户数

boardControlCount

类型: number

可编辑用户数

bkInfo

类型: BackgroundInfoCache

背景设置

StatusType

类型: enum

• 成员

BackgroundInfoCache

类型: interface

默认背景设置

• API

bkColor

类型: string

背景颜色

bkImage

类型: string

背景图片

bkImageFillType

类型: BkFillType

背景图片填充方式

bkImageSize

类型: BkImageSize

背景图片尺寸

LockBoardReason

类型: enum

白板锁定原因

• 成员

ImageLoadStatus

类型: enum

图片加载状态

• 成员

EditMode

类型: enum

是否可编辑

• 成员

IToolMode

画笔工具和形状类型

• 类型

ts TOOL_TYPE | Constant.SHAPE_TYPE | ''

PlaybackState

类型: enum

白板录像回放状态

• 成员

WhiteBoard

类型: class

• API

new WhiteBoard()

• 参数

• options

  类型: { boardRef: WhiteBoardRoom; boardId: number; pages: WebPageInfo[]; canvasConfig: canvasConfig; status: StatusType; }

  • 成员

  名称	类型	描述
  boardRef	WhiteBoardRoom
  boardId	number
  pages	WebPageInfo[]
  canvasConfig	canvasConfig
  status	StatusType

boardId

类型: number

roomId

类型: string

mode

类型: IToolMode

boardRoomRef

类型: WhiteBoardRoom

board

类型: Board

userId

类型: string

pages

类型: WebPageInfo[]

cacheSelectingObj

类型: ObjectParams[]

cacheDrawingObj

类型: Object

cacheManage

类型: ICacheManage

boardImage

类型: ImagePlugin

multiPages

类型: MultiPages

currentPageId

类型: string

status

类型: StatusType

createObjId()

• 类型

ts () => string

getTimestamp()

• 类型

ts () => number

cacheObjFinishReq()

• 类型

ts (cacheSelectingObj: ObjectParams[]) => void

• 参数

• cacheSelectingObj

  类型: ObjectParams[]

selectCacheClean()

• 类型

ts () => void

imageLoad()

• 类型

ts (pageId: string, pages: WebPageInfo[]) => void

• 参数

• pageId

  类型: string

• pages

  类型: WebPageInfo[]

init()

• 类型

ts (currentPageId: string) => void

• 参数

• currentPageId

  类型: string

getPageBkIngo()

• 类型

ts (current_page_info: WebPageInfo) => { bkInfo: { bkColor: string; bkImage: string; bkImageFillType: BkFillType; }; }

• 参数

• current_page_info

  类型: WebPageInfo

initPageInfo()

• 类型

ts (pages: WebPageInfo[], currentPageId: string) => void

• 参数

• pages

  类型: WebPageInfo[]

• currentPageId

  类型: string

setZoom()

• 类型

ts (scale: number) => void

• 参数

• scale

  类型: number

setBackgroundImage()

• 类型

ts (pageId: string, url: string, fillType?: BkFillType) => Promise<void>

• 参数

• pageId

  类型: string

• url

  类型: string

• fillType

  类型: BkFillType

setBackgroundColor()

• 类型

ts (backgroundColor: string) => Promise<void>

• 参数

• backgroundColor

  类型: string

destory()

• 类型

ts () => void

getWhiteBoardObjectById()

• 类型

ts (id: string) => Object

• 参数

• id

  类型: string

getWhiteBoardID()

• 类型

ts () => number

• 返回值

类型: number

getCurrentPageId()

• 类型

ts () => string

• 返回值

类型: string

getWhiteBoardRoomID()

• 类型

ts () => string

• 返回值

类型: string

setEditMode()

• 类型

ts (mode: EditMode) => void

• 参数

• mode

  类型: EditMode

hideDrawing()

• 类型

ts () => void

lockBoard()

• 类型

ts (lock: boolean, reason: LockBoardReason) => void

• 参数

• lock

  类型: boolean

• reason

  类型: LockBoardReason

setEditType()

• 类型

ts (key: IToolMode) => void

• 参数

• key

  类型: IToolMode

enableDrawMode()

• 类型

ts () => void

setDrawMode()

• 类型

ts (param: DrawConf) => void

• 参数

• param

  类型: DrawConf

cancelDrawMode()

• 类型

ts () => void

getCurrentRecord()

• 类型

ts () => RecordCommand

redo()

进行Redo

• 类型

ts () => void

undo()

进行Undo

• 类型

ts () => void

clearPage()

清空白板

• 类型

ts () => void

setShapeColor()

• 类型

ts (color: string) => void

• 参数

• color

  类型: string

setPenColor()

• 类型

ts (color: string) => void

• 参数

• color

  类型: string

setTextColor()

• 类型

ts (color: string) => void

• 参数

• color

  类型: string

setShapeSize()

• 类型

ts (thickness: number) => void

• 参数

• thickness

  类型: number

setPenSize()

• 类型

ts (thickness: number) => void

• 参数

• thickness

  类型: number

setTextFontSize()

设置文本字号大小

• 类型

ts (fontSize: number) => void

• 参数

• in

  类型: number

  size 尺寸

addObjToCanvas()

• 类型

ts ({ shapeType, obj, objId, type, timestamp, zIndex }: any) => void

• 参数

• { shapeType, obj, objId, type, timestamp, zIndex }

  类型: any

reRenderUI()

• 类型

ts (boardId: number, pageId: string, objId: string) => void

• 参数

• boardId

  类型: number

• pageId

  类型: string

• objId

  类型: string

refreshUI()

• 类型

ts () => void

createPages()

• 类型

ts (insertPageId: string, pageConfigs: WebPageInfo[], task_id: string) => void

• 参数

• insertPageId

  类型: string

• pageConfigs

  类型: WebPageInfo[]

• task_id

  类型: string

createPage()

• 类型

ts (insertPageId: string, pageConfig: Partial<WebPageInfo>, options?: { autoFlip: boolean;}) => void

• 参数

• insertPageId

  类型: string

• pageConfig

  类型: Partial<WebPageInfo>

• options

  类型: { autoFlip: boolean; }

  • 成员

  名称	类型	描述
  autoFlip	boolean

flipPage()

• 类型

ts (pageId: string) => void

• 参数

• pageId

  类型: string

getCurrentPageInfo()

• 类型

ts () => WebPageInfo

getAllPageInfo()

• 类型

ts () => WebPageInfo[]

getCurrentPageIndex()

• 类型

ts () => number

getPageInfoByIndex()

• 类型

ts (index: number) => WebPageInfo

• 参数

• index

  类型: number

changePageBackground()

• 类型

ts (params: { pageId: string; color?: string; img?: string; fillType?: BkFillType;}) => void

• 参数

• params

  类型: { pageId: string; color?: string; img?: string; fillType?: BkFillType; }

  • 成员

  名称	类型	描述
  pageId	string
  color	string
  img	string
  fillType	BkFillType

changeBoardBackground()

• 类型

ts (params: BackgroundInfoCache) => void

• 参数

• params

  类型: BackgroundInfoCache

createFilePage()

• 类型

ts (currentPageId: string, pageConfig: { fileImage: string; fileName: string;}[], fillType: BkFillType, file_id: string, options?: CreatePageOptions) => void

• 参数

• currentPageId

  类型: string

• pageConfig

  类型: { fileImage: string; fileName: string; }[]

  • 成员

  名称	类型	描述
  fileImage	string
  fileName	string

• fillType

  类型: BkFillType

• file_id

  类型: string

• options

  类型: CreatePageOptions

removePages()

• 类型

ts (pageIds: string[], isContinuousPages?: boolean) => void

• 参数

• pageIds

  类型: string[]

• isContinuousPages

  类型: boolean

  值: 'false'

getPageInfo()

• 类型

ts () => WebPageInfo[]

clearPageCallback()

• 类型

ts () => void

WhiteBoardRoom

类型: class

白板房间

• API

new WhiteBoardRoom()

• 类型

ts constructor(props: IBoradProps)

• 参数

• props

  类型: IBoradProps

roomId

类型: string

房间 ID

Token

类型: string

动态密钥

byteToken

类型: string

动态密钥

byteAppId

类型: string

AppId

parentBoardId

类型: string

白板 ID

userId

类型: string

用户 ID

AppId

类型: string

AppID

_whiteBoardRoomObj

类型: { [key: string]: WhiteBoard; }

_whiteBoardInfo

类型: { [key: number]: WebBoardInfo; }

_whiteBoardCreateInfo

类型: { [key: number]: ICreateBoard; }

whiteBoard

类型: WhiteBoard

httpClient

类型: HttpClient

timeHelper

类型: TimeHelper

cacheManage

类型: CacheManage

pageSnapShotManage

类型: SnapshotPlugin

userLockObjIds

类型: { [key: string]: string; }

boardRoomOptions

类型: { autoFlip: boolean; }

• 成员

  名称	类型	描述
  autoFlip	boolean

getTimestamp()

• 类型

ts () => number

_sendActionData()

• 类型

ts (params: DataProcessItemSend[], type?: SendType, fileInfo?: { fileId: string;}) => void

• 参数

• params

  类型: DataProcessItemSend[]

• type

  类型: SendType

  值: ' SendType.data'

• fileInfo

  类型: { fileId: string; }

  • 成员

  名称	类型	描述
  fileId	string

processActionCacheWithType()

• 类型

ts (actions: Action[], pageId: string, boardId: number) => void

• 参数

• actions

  类型: Action[]

• pageId

  类型: string

• boardId

  类型: number

_kEditingMessage()

• 类型

ts (res: { command: number; operator: string; data: EditingMessage;}) => void

• 参数

• res

  类型: { command: number; operator: string; data: EditingMessage; }

  • 成员

  名称	类型	描述
  command	number
  operator	string
  data	EditingMessage

processActions()

• 类型

ts (item: Action, action_pageId: string, action_board_id: number, operator?: string) => void

• 参数

• item

  类型: Action

• action_pageId

  类型: string

• action_board_id

  类型: number

• operator

  类型: string

_kGetActionCount()

处理白板action count【本地收到心跳不一致时，请求GetActionCount的相应】

• 类型

ts (res: GetActionCountResponse) => void

• 参数

• res

  类型: GetActionCountResponse

_kHeartBeat()

处理心跳逻辑

• 类型

ts (res: HeartBeatResponse) => void

• 参数

• res

  类型: HeartBeatResponse

_kGetShapeSnapshot()

处理图形快照 【1。首次进房 2. 冲突 3. 心跳包actionAcount不一致】

• 类型

ts (res: GetShapeSnapshotResponse) => void

• 参数

• res

  类型: GetShapeSnapshotResponse

_kEditing()

处理图形编辑响应【发送端】， 如有conflictObjIds，需要处理

• 类型

ts (res: EditingResponse) => void

• 参数

• res

  类型: EditingResponse

createWhiteBoard()

• 类型

ts (boardId: number, page: WebPageInfo, boardBKInfo?: WebPageInfo['bkInfo']) => void

• 参数

• boardId

  类型: number

• page

  类型: WebPageInfo

• boardBKInfo

  类型: { bkColor?: string; bkImage?: string; bkImageFillType?: BkFillType; bkImageSize?: BkImageSize; }

setBoardInfo()

• 类型

ts (boardId: number, boardInfo?: WebBoardInfo) => void

• 参数

• boardId

  类型: number

• boardInfo

  类型: WebBoardInfo

setUserCreateBoardInfo()

• 类型

ts (boardId: number, boardInfo: WebBoardInfo) => void

• 参数

• boardId

  类型: number

• boardInfo

  类型: WebBoardInfo

_kCreateBoard()

处理创建Board响应 【本地创建白板】

• 类型

ts (res: CreateBoardResponse) => Promise<void>

• 参数

• res

  类型: CreateBoardResponse

processBoardInfo()

• 类型

ts (data: { boards: BoardInfo[]; packetId: number;}) => void

• 参数

• data

  类型: { boards: BoardInfo[]; packetId: number; }

  • 成员

  名称	类型	描述
  boards	BoardInfo[]
  packetId	number

initWhiteBoard()

• 类型

ts (boardId: number, pages: WebPageInfo[], currentPageId: string, status: StatusType) => WhiteBoard | undefined

• 参数

• boardId

  类型: number

• pages

  类型: WebPageInfo[]

• currentPageId

  类型: string

• status

  类型: StatusType

• 返回值

类型: WhiteBoard | undefined

getRoomID()

• 类型

ts () => string | undefined

• 返回值

类型: string | undefined

login()

• 类型

ts () => Promise<void>

getBoardInfo()

• 类型

ts () => Promise<GetBoardInfoResponse>

• 返回值

类型: Promise<GetBoardInfoResponse>

joinRoom()

• 类型

ts () => Promise<void>

• 返回值

类型: Promise<void>

leaveRoom()

• 类型

ts () => void

destory()

• 类型

ts () => void

destroyWhiteBoard()

• 类型

ts (white_board: WhiteBoard) => void

• 参数

• white_board

  类型: WhiteBoard

closeAllWhiteBoard()

• 类型

ts () => void

getWhiteBoard()

• 类型

ts (board_id: number) => WhiteBoard

• 参数

• board_id

  类型: number

startPlaybackWhiteBoard()

• 类型

ts () => void

pausePlaybackWhiteBoard()

• 类型

ts () => void

cancelPausePlaybackWhiteBoard()

• 类型

ts () => void

stopPlaybackWhiteBoard()

• 类型

ts () => void

setPlaybackWhiteBoardProgress()

• 类型

ts (progress: number) => void

• 参数

• progress

  类型: number

createTranscodeTask()

• 类型

ts (params: IDocsCreateTranscodeTask) => Promise<any>

• 参数

• params

  类型: IDocsCreateTranscodeTask

• 返回值

类型: Promise<any>

IBoradProps

类型: interface

白板属性

• API

appId

类型: string

每个应用的唯一标识符，由 RTC 控制台随机生成的。不同的 AppId 生成的实例在 RTC 中进行音频通话完全独立，无法互通。

boardViewId

类型: string

视图 DomID

roomId

类型: string

房间 ID

userId

类型: string

用户 ID

token

类型: string

动态密钥

用户登录必须携带的 Token，用于鉴权验证。

登录 Token 与加入房间时必须携带的 Token 不同。测试时可使用控制台生成临时 Token，roomId 填任意值或置空，正式上线需要使用密钥 SDK 在你的服务端生成并下发 Token。

options

类型: { autoFlip: boolean; }

选项

• 成员

  名称	类型	描述
  autoFlip	boolean	是否自动翻页

ICreateBoard

类型: interface

• API

createStatus

类型: ResponseStatus

CreateBoardResponse

类型: interface

• API

status

类型: ResponseStatus

boardId

类型: number

ResponseStatus

类型: enum

• 成员

HttpClient

类型: class

• API

getTimestamp()

• 类型

ts (requestConfig: Partial<AxiosRequestConfig>) => Promise<{ timestamp: number; }>

• 参数

• requestConfig

  类型: Partial<AxiosRequestConfig<any>>

• 返回值

类型: Promise<{ timestamp: number }>

getToken()

• 类型

ts (requestConfig: Partial<AxiosRequestConfig>, params: any) => Promise<Token>

• 参数

• requestConfig

  类型: Partial<AxiosRequestConfig<any>>

• params

  类型: any

getPageSnapShot()

• 类型

ts (requestConfig: Partial<AxiosRequestConfig>, params: any) => Promise<Res>

• 参数

• requestConfig

  类型: Partial<AxiosRequestConfig<any>>

• params

  类型: any

replay()

• 类型

ts (requestConfig: Partial<AxiosRequestConfig>, params: any) => Promise<Res>

• 参数

• requestConfig

  类型: Partial<AxiosRequestConfig<any>>

• params

  类型: any

roomEnter()

• 类型

ts (requestConfig: Partial<AxiosRequestConfig>, params: any) => Promise<Res>

• 参数

• requestConfig

  类型: Partial<AxiosRequestConfig<any>>

• params

  类型: any

roomQuit()

• 类型

ts (requestConfig: Partial<AxiosRequestConfig>, params: any) => Promise<Res>

• 参数

• requestConfig

  类型: Partial<AxiosRequestConfig<any>>

• params

  类型: any

createTranscodeTask()

• 类型

ts (requestConfig: Partial<AxiosRequestConfig>, params: IDocsCreateTranscodeTask) => Promise<IDocsCreateTranscodeTaskRes>

• 参数

• requestConfig

  类型: Partial<AxiosRequestConfig<any>>

• params

  类型: IDocsCreateTranscodeTask

queryTranscodeTask()

• 类型

ts (requestConfig: Partial<AxiosRequestConfig>, params: IDocsQueryTranscodeTask) => Promise<IDocsQueryTranscodeTaskRes>

• 参数

• requestConfig

  类型: Partial<AxiosRequestConfig<any>>

• params

  类型: IDocsQueryTranscodeTask

getTranscodeResult()

• 类型

ts (requestConfig: Partial<AxiosRequestConfig>, params: IDocsGetTranscodeResult) => Promise<IDocsGetTranscodeResultRes>

• 参数

• requestConfig

  类型: Partial<AxiosRequestConfig<any>>

• params

  类型: IDocsGetTranscodeResult

getBoardInfos()

• 类型

ts (requestConfig: Partial<AxiosRequestConfig>, params: IGetBoardInfoParams) => Promise<Res>

• 参数

• requestConfig

  类型: Partial<AxiosRequestConfig<any>>

• params

  类型: IGetBoardInfoParams

IDocsCreateTranscodeTask

类型: interface

• API

app_id

类型: string

resource

类型: string

operator

类型: string

transcode_config

类型: TranscodeConfig

storage_config

类型: StorageConfig

transcode_mode

类型: TranscodeMode

priority

类型: Priority

onProgress()

• 类型

ts (transcodePercent: number, transcodeStatus: TaskStatus, task_id: string) => void

• 参数

• transcodePercent

  类型: number

• transcodeStatus

  类型: TaskStatus

• task_id

  类型: string

TranscodeConfig

类型: interface

• API

input_format

类型: InputFormat

output_format

类型: OutputFormat

output_width

类型: number

output_height

类型: number

force_use_resolution

类型: boolean

thumbnail

类型: boolean

thumbnail_width

类型: number

thumbnail_height

类型: number

InputFormat

类型: enum

• 成员

OutputFormat

类型: enum

• 成员

StorageConfig

类型: interface

• API

type

类型: StorageType

tos_config

类型: TosConfig

custom_config

类型: CustomConfig

StorageType

类型: enum

• 成员

TosConfig

类型: interface

• API

account_id

类型: string

bucket

类型: string

CustomConfig

类型: interface

• API

vendor

类型: Vendor

region

类型: string

bucket

类型: string

access_key

类型: string

secret_key

类型: string

Vendor

类型: enum

• 成员

TranscodeMode

类型: enum

• 成员

Priority

类型: enum

• 成员

TaskStatus

类型: enum

• 成员

IDocsQueryTranscodeTask

类型: interface

• API

app_id

类型: string

operator

类型: string

task_id

类型: string

IDocsGetTranscodeResult

类型: interface

• API

app_id

类型: string

operator

类型: string

task_id

类型: string

need_thumbnail

类型: boolean

IGetBoardInfoParams

类型: interface

• API

app_id

类型: string

room_id

类型: string

board_ids

类型: number[]

TimeHelper

类型: class

• API

new TimeHelper()

• 类型

ts constructor(options: { byteToken: string })

• 参数

• options

  类型: { byteToken: string; }

  • 成员

  名称	类型	描述
  byteToken	string

byteToken

类型: string

init()

• 类型

ts () => void

initAdjustTime()

• 类型

ts () => Promise<void>

getCurrentTime()

• 类型

ts () => number

CacheManage

类型: class

• API

new CacheManage()

storage

类型: { actionCount: { [key: number]: { [key: string]: number; }; }; controlCount: { [key: number]: { [key: string]: number; }; }; boardControlCount: { [key: number]: number; }; objData: { [key: number]: { [key: string]: { [key: string]: { [key: string]: ObjData; [key: number]: ObjData; }; }; }; }; pageDataReplay: { [key: number]: any; }; objDataReplay: { [key: number]: { [key: string]: { [key: string]: { [key: string]: ObjData; [key: number]: ObjData; }; }; }; }; objCount: { [key: number]: { [key: string]: { [key: string]: number; }; }; }; objCountTmp: { [key: number]: { [key: string]: { [key: string]: number; }; }; }; objPacket: { [key: string]: { [key: number]: { status: number | undefined; }; }; }; objActionId: { [key: string]: { cur: number; next: number; }; }; objActionIdLocal: { [key: string]: { cur: number; next: number; }; }; heartCount: { [key: number]: { [key: string]: number[]; }; }; ActionType: { timestamp: string; type: number;}[]; conflict: ConflictPacket[]; recvPacket: RecePacket[]; polylineSplit: PolylineSplit; packets: PacketParam; userLockObjIds: { [key: string]: string; }; httpCache: { [key: string]: { resendCount?: number; ack?: any; }; [key: number]: { resendCount?: number; ack?: any; }; }; pageObj: { [key: number]: WebPageInfo[]; }; createPages: { [key: string]: any[]; }; }

• 成员

  名称	类型	描述
  actionCount	{ [key: number]: { [key: string]: number; }; }
  controlCount	{ [key: number]: { [key: string]: number; }; }
  boardControlCount	{ [key: number]: number; }
  objData	{ [key: number]: { [key: string]: { [key: string]: { [key: string]: ObjData; [key: number]: ObjData; }; }; }; }
  pageDataReplay	{ [key: number]: any; }
  objDataReplay	{ [key: number]: { [key: string]: { [key: string]: { [key: string]: ObjData; [key: number]: ObjData; }; }; }; }
  objCount	{ [key: number]: { [key: string]: { [key: string]: number; }; }; }
  objCountTmp	{ [key: number]: { [key: string]: { [key: string]: number; }; }; }
  objPacket	{ [key: string]: { [key: number]: { status: number | undefined; }; }; }
  objActionId	{ [key: string]: { cur: number; next: number; }; }
  objActionIdLocal	{ [key: string]: { cur: number; next: number; }; }
  heartCount	{ [key: number]: { [key: string]: number[]; }; }
  ActionType	{ timestamp: string; type: number; }[]
  ActionType.timestamp	string
  ActionType.type	number
  conflict	ConflictPacket[]
  recvPacket	RecePacket[]
  polylineSplit	PolylineSplit
  packets	PacketParam
  userLockObjIds	{ [key: string]: string; }
  httpCache	{ [key: string]: { resendCount?: number; ack?: any; }; [key: number]: { resendCount?: number; ack?: any; }; }
  pageObj	{ [key: number]: WebPageInfo[]; }
  createPages	{ [key: string]: any[]; }

processPageInfo()

• 类型

ts (params: { boardId: number; pages: WebPageInfo[];}) => void

• 参数

• params

  类型: { boardId: number; pages: WebPageInfo[]; }

  • 成员

  名称	类型	描述
  boardId	number
  pages	WebPageInfo[]

FlipBoardPage()

• 类型

ts () => void

removeAction()

• 类型

ts (boardId: number, pageId: string, objId: string) => void

• 参数

• boardId

  类型: number

• pageId

  类型: string

• objId

  类型: string

processActionType()

• 类型

ts (item: { timestamp: string; type: number;}) => void

• 参数

• item

  类型: { timestamp: string; type: number; }

  • 成员

  名称	类型	描述
  timestamp	string
  type	number

recordObjActionIdWrite()

• 类型

ts (params: { objId: string; count: number;}) => void

• 参数

• params

  类型: { objId: string; count: number; }

  • 成员

  名称	类型	描述
  objId	string
  count	number

recordObjActionId()

• 类型

ts (params: { objId: string; count: number; key: 'objActionId' | 'objActionIdLocal';}) => void

• 参数

• params

  类型: { objId: string; count: number; key: 'objActionId' | 'objActionIdLocal'; }

  • 成员

  名称	类型	描述
  objId	string
  count	number
  key	"objActionId" | "objActionIdLocal"

processObjActionId()

• 类型

ts (params: { objId: string; key: 'objActionId' | 'objActionIdLocal';}) => void

• 参数

• params

  类型: { objId: string; key: 'objActionId' | 'objActionIdLocal'; }

  • 成员

  名称	类型	描述
  objId	string
  key	"objActionId" | "objActionIdLocal"

${operator}-${packetId}()

• 类型

ts (message: { boardId: number; pageId: string | undefined; objId: string; actions: Action[]; packetId: number; operator: string;}) => void

• 参数

• message

  类型: { boardId: number; pageId: string | undefined; objId: string; actions: Action[]; packetId: number; operator: string; }

  • 成员

  名称	类型	描述
  boardId	number
  pageId	string
  objId	string
  actions	Action[]
  packetId	number
  operator	string

processObjActionReplay()

• 类型

ts (message: { boardId: number; pageId: string | undefined; objId: string; actions: Action[]; packetId: number; operator: string;}) => void

• 参数

• message

  类型: { boardId: number; pageId: string | undefined; objId: string; actions: Action[]; packetId: number; operator: string; }

  • 成员

  名称	类型	描述
  boardId	number
  pageId	string
  objId	string
  actions	Action[]
  packetId	number
  operator	string

processPageActionReplay()

• 类型

ts (boardId: number, data: any) => void

• 参数

• boardId

  类型: number

• data

  类型: any

redoActionCount()

• 类型

ts (boardId: number, pageId: string) => void

• 参数

• boardId

  类型: number

• pageId

  类型: string

processObjCount()

• 类型

ts (boardId: number, pageId: string, objId: string, actionCount: number, phase: PhaseType | undefined, finish: boolean) => void

• 参数

• boardId

  类型: number

• pageId

  类型: string

• objId

  类型: string

• actionCount

  类型: number

• phase

  类型: PhaseType

• finish

  类型: boolean

processControlCount()

• 类型

ts (boardId: number, pageId: string, addCount: number) => void

• 参数

• boardId

  类型: number

• pageId

  类型: string

• addCount

  类型: number

processBoardControlCount()

• 类型

ts (boardId: number, addCount: number) => void

• 参数

• boardId

  类型: number

• addCount

  类型: number

processPackConflict()

• 类型

ts (item?: ConflictPacket) => void

• 参数

• item

  类型: ConflictPacket

processRecvPacket()

• 类型

ts (item?: RecePacket) => void

• 参数

• item

  类型: RecePacket

processPolylineSplit()

• 类型

ts (param: { key: string; objIds?: string[];}) => void

• 参数

• param

  类型: { key: string; objIds?: string[]; }

  • 成员

  名称	类型	描述
  key	string
  objIds	string[]

processPacket()

• 类型

ts (params: { packetId: number; param?: PackeItem; resendCount?: number; fileInfo: { fileId: string; };}) => void

• 参数

• params

  类型: { packetId: number; param?: PackeItem; resendCount?: number; fileInfo: { fileId: string;}; }

  • 成员

  名称	类型	描述
  packetId	number
  param	PackeItem
  resendCount	number
  fileInfo	{ fileId: string; }
  fileInfo.fileId	string

heartCountFission()

• 类型

ts (message: { boardId: number; pageId: string; count: number;}) => void

• 参数

• message

  类型: { boardId: number; pageId: string; count: number; }

  • 成员

  名称	类型	描述
  boardId	number
  pageId	string
  count	number

clearHeartCountFission()

• 类型

ts (message: { boardId: number; pageId: string;}) => void

• 参数

• message

  类型: { boardId: number; pageId: string; }

  • 成员

  名称	类型	描述
  boardId	number
  pageId	string

ClearCurrentPage()

• 类型

ts () => void

GetAllActions()

• 类型

ts () => void

HasActionLost()

• 类型

ts () => void

HasControlLost()

• 类型

ts () => void

GetLostObjectIdList()

• 类型

ts () => void

checkResponseTimeout()

• 类型

ts ({ onSuccess, onReject, onMaxCount, timeout, key }: ICheckResponse) => void

• 参数

• { onSuccess, onReject, onMaxCount, timeout, key }

  类型: ICheckResponse

getObjDataCacahe()

• 类型

ts (boardId: number | undefined, pageId: string | undefined, objId: string) => { obj: { [key: string]: any; }; props: { [key: string]: any; }; phase: PhaseType; timestamp: number; type: ActionType; shapeType: any; zIndex: string; }[]

• 参数

• boardId

  类型: number

• pageId

  类型: string

• objId

  类型: string

Action

类型: interface

• API

type

类型: ActionType

phase

类型: PhaseType

objId

类型: string

actionId

类型: number

timestamp

类型: string

data

类型: string

zIndex

类型: string

creatorUserId

类型: string

flag

类型: ActionFlag

ActionType

类型: enum

• 成员

PhaseType

类型: enum

• 成员

ActionFlag

类型: enum

• 成员

ICheckResponse

类型: interface

• API

timeout

类型: number

key

类型: string

onSuccess()

• 类型

ts () => void

onReject()

• 类型

ts () => void

onMaxCount()

• 类型

ts () => void

SnapshotManage

类型: class

• API

new SnapshotManage()

• 类型

ts constructor(options: { boardRef: WhiteBoardRoom})

• 参数

• options

  类型: { boardRef: WhiteBoardRoom; }

  • 成员

  名称	类型	描述
  boardRef	WhiteBoardRoom

name

类型: string

boardRef

类型: WhiteBoardRoom

count

类型: number

arrs

类型: string[][]

initRequest()

• 类型

ts (controlCount: { [key: string]: number; }, currentPageId: string) => void

• 参数

• controlCount

  类型: { [key: string]: number; }

• currentPageId

  类型: string

reqCallback()

• 类型

ts () => void

DataProcessItemSend

类型: interface

• API

object

类型: any

props

类型: any

phase

类型: PhaseType

type

类型: ActionTypeExtend

flag

类型: CALL_SOURCE

ActionTypeExtend

• 类型

ts ActionType | Constant.SHAPE_TYPE

CALL_SOURCE

类型: enum

• 成员

SendType

类型: enum

• 成员

EditingMessage

类型: interface

• API

packet

类型: Packet

userLockObjIds

类型: { [key: string]: string; }

Packet

类型: interface

• API

boardId

类型: number

pageId

类型: string

packetId

类型: number

operator

类型: string

version

类型: number

timestamp

类型: number

actions

类型: Action[]

GetActionCountResponse

类型: interface

• API

boardId

类型: number

pageId

类型: string

actionCount

类型: { [key: string]: number; }

HeartBeatResponse

类型: interface

• API

boardId

类型: number

pageId

类型: string

heartBeat

类型: HeartBeatData

HeartBeatData

类型: interface

• API

actionCount

类型: number

controlCount

类型: number

userLockObjIds

类型: { [key: string]: string; }

boardCurrentPageId

类型: string

boardControlCount

类型: number

GetShapeSnapshotResponse

类型: interface

• API

boardId

类型: number

pageId

类型: string

id

类型: string

version

类型: number

objList

类型: Element[]

Element

类型: interface

• API

type

类型: ActionType

actionCount

类型: number

actionId

类型: number

timestamp

类型: string

boardId

类型: number

pageId

类型: string

objId

类型: string

data

类型: string

zIndex

类型: string

creatorUserId

类型: string

initialized

类型: boolean

EditingResponse

类型: interface

• API

boardId

类型: number

pageId

类型: string

packetId

类型: number

status

类型: ResponseStatus

conflictObjIds

类型: string[]

BoardInfo

类型: interface

白板信息

• API

boardId

类型: number

白板 ID

pages

类型: PageInfo[]

总页数

currentPageId

类型: string

当前页面 ID

status

类型: StatusType

白板状态

controlCount

类型: { [key: string]: number; }

控制状态

boardControlCount

类型: number

控制人数

bkInfo

类型: BackgroundInfo

背景设置

PageInfo

类型: interface

• API

pageId

类型: string

bkInfo

类型: BackgroundInfo

extra

类型: string

BackgroundInfo

类型: interface

背景设置

• API

bkColor

类型: number

背景颜色

bkImage

类型: string

背景图片

bkImageFillType

类型: BkFillType

填充方式

bkImageSize

类型: BkImageSize

图片尺寸

GetBoardInfoResponse

类型: interface

白板信息

• API

boards

类型: BoardInfo[]

白板信息

packetId

类型: number

ID

canvasConfig

• 类型

ts fabric.ICanvasOptions & { width: number; height: number }

ObjectParams

• 类型

ts fabric.Object & { objId: string; id: string; shapeType: Constant.SHAPE_TYPE; text: string; textLines: string[]; type: Constant.SHAPE_TYPE; }

ImageManage

类型: class

• API

new ImageManage()

• 类型

ts constructor(options: ImageOptions)

• 参数

• options

  类型: ImageOptions

name

类型: string

boardCanvas

类型: WhiteBoard

imageObjList

类型: { url: string; img: fabric.Image; }[]

• 成员

  名称	类型	描述
  url	string
  img	Image

loadImage()

• 类型

ts (pageId: string, bkImages: string[]) => void

• 参数

• pageId

  类型: string

• bkImages

  类型: string[]

setImageFromLoad()

• 类型

ts (pageId: string, url: string, fillType?: BkFillType, options?: SetBGImgOptions) => Promise<unknown>

• 参数

• pageId

  类型: string

• url

  类型: string

• fillType

  类型: BkFillType

• options

  类型: SetBGImgOptions

getImageFormLoad()

• 类型

ts (url: string) => { url: string; img: Image; }

• 参数

• url

  类型: string

ImageOptions

类型: interface

• API

boardCanvas

类型: WhiteBoard

SetBGImgOptions

类型: interface

• API

width

类型: number

height

类型: number

MulitPage

类型: class

• API

new MulitPage()

• 类型

ts constructor(options: IMulitPage)

• 参数

• options

  类型: IMulitPage

createFilePage()

• 类型

ts (currentPageId: string, pageConfig: { fileImage: string; fileName: string;}[], fillType: BkFillType, file_id: string, options?: CreatePageOptions) => void

• 参数

• currentPageId

  类型: string

• pageConfig

  类型: { fileImage: string; fileName: string; }[]

  • 成员

  名称	类型	描述
  fileImage	string
  fileName	string

• fillType

  类型: BkFillType

• file_id

  类型: string

• options

  类型: CreatePageOptions

createPageUI()

• 类型

ts (pages: WebPageInfo[], prePageId: string, replayCallbak?: (params: ReplayCallbackParam) => void) => void

• 参数

• pages

  类型: WebPageInfo[]

• prePageId

  类型: string

• replayCallbak

  类型: (params: ReplayCallbackParam) => void

createPageData()

• 类型

ts (prePageId: string, pages: Partial<WebPageInfo>[], options?: CreatePageOptions) => void

• 参数

• prePageId

  类型: string

• pages

  类型: Partial<WebPageInfo>[]

• options

  类型: CreatePageOptions

createPages()

• 类型

ts (insertPageId: string, pageConfigs: WebPageInfo[], file_id: string, options?: CreatePageOptions) => void

• 参数

• insertPageId

  类型: string

• pageConfigs

  类型: WebPageInfo[]

• file_id

  类型: string

• options

  类型: CreatePageOptions

createPage()

• 类型

ts (insertPageId: string, pageConfig: Partial<WebPageInfo>, options?: CreatePageOptions) => void

• 参数

• insertPageId

  类型: string

• pageConfig

  类型: Partial<WebPageInfo>

• options

  类型: CreatePageOptions

flipPage()

• 类型

ts (pageId: string, with_unlock_action?: boolean) => void

• 参数

• pageId

  类型: string

• with_unlock_action

  类型: boolean

  值: ' true'

flipPageUI()

• 类型

ts (pageId: string, replayCallbak?: (params: ReplayCallbackParam) => void) => Promise<void>

• 参数

• pageId

  类型: string

• replayCallbak

  类型: (params: ReplayCallbackParam) => void

removePageUI()

• 类型

ts (pageIds: string[], replayCallbak?: (params: ReplayCallbackParam) => void) => void

• 参数

• pageIds

  类型: string[]

• replayCallbak

  类型: (params: ReplayCallbackParam) => void

removePageData()

• 类型

ts (pageIds: string[], isContinuousPages: boolean) => void

• 参数

• pageIds

  类型: string[]

• isContinuousPages

  类型: boolean

removePages()

• 类型

ts (pageIds: string[], isContinuousPages?: boolean) => void

• 参数

• pageIds

  类型: string[]

• isContinuousPages

  类型: boolean

  值: 'false'

changeBoardBackground()

• 类型

ts (params: BackgroundInfoCache) => void

• 参数

• params

  类型: BackgroundInfoCache

getCurrentPageInfo()

• 类型

ts () => WebPageInfo

getAllPageInfo()

• 类型

ts () => WebPageInfo[]

getCurrentPageIndex()

• 类型

ts () => number

getPageInfoByIndex()

• 类型

ts (index: number) => WebPageInfo

• 参数

• index

  类型: number

changePageBackground()

• 类型

ts (params: { pageId: string; color?: string; img?: string; fillType?: BkFillType;}) => void

• 参数

• params

  类型: { pageId: string; color?: string; img?: string; fillType?: BkFillType; }

  • 成员

  名称	类型	描述
  pageId	string
  color	string
  img	string
  fillType	BkFillType

changePageBackgroundCallback()

• 类型

ts (params: { pageId: string; bkInfo: { bkColor: string; bkImage: string; bkImageFillType: BkFillType; };}, replayCallbak?: (params: ReplayCallbackParam) => void) => void

• 参数

• params

  类型: { pageId: string; bkInfo: { bkColor: string; bkImage: string; bkImageFillType: BkFillType;}; }

  • 成员

  名称	类型	描述
  pageId	string
  bkInfo	{ bkColor: string; bkImage: string; bkImageFillType: BkFillType; }
  bkInfo.bkColor	string
  bkInfo.bkImage	string
  bkInfo.bkImageFillType	BkFillType

• replayCallbak

  类型: (params: ReplayCallbackParam) => void

changeBoardBackgroundCallback()

• 类型

ts (params: { pageId: string; bkInfo: { bkColor: string; bkImage: string; bkImageFillType: BkFillType; };}, replayCallbak?: (params: ReplayCallbackParam) => void) => void

• 参数

• params

  类型: { pageId: string; bkInfo: { bkColor: string; bkImage: string; bkImageFillType: BkFillType;}; }

  • 成员

  名称	类型	描述
  pageId	string
  bkInfo	{ bkColor: string; bkImage: string; bkImageFillType: BkFillType; }
  bkInfo.bkColor	string
  bkInfo.bkImage	string
  bkInfo.bkImageFillType	BkFillType

• replayCallbak

  类型: (params: ReplayCallbackParam) => void

IMulitPage

类型: interface

• API

boardRef

类型: WhiteBoard

boardRoomRef

类型: WhiteBoardRoom

CreatePageOptions

类型: interface

• API

autoFlip

类型: boolean

ReplayCallbackParam

类型: interface

• API

currentPageId

类型: string

insertPageId

类型: string

pages

类型: WebPageInfo[]

whiteBoardInfo

类型: { [key: number]: WebBoardInfo; }