IDaoPaaS | DaoPaaS API Options

这是应用程序入口

使用如下:

   let options = {...};
   let dao = new DaoPaaS(options);

Hierarchy

IDaoPaaS

Events

Optional onError

onError(callback: ((error: Message) => void)): void

- Defined in types/DaoPaaS.d.ts:372
错误消息侦听器.

Parameters
- callback: ((error: Message) => void)
  
  回调函数
  - - (error: Message): void
    - Parameters
      - error: Message
      Returns void
Returns void

Optional onMessage

onMessage(callback: ((message: Message) => void)): void

- Defined in types/DaoPaaS.d.ts:384
消息侦听器.

Parameters
- callback: ((message: Message) => void)
  
  回调函数
  - - (message: Message): void
    - Parameters
      - message: Message
      Returns void
Returns void

Optional removeError

removeError(callback: ((error: Message) => void)): void

- Defined in types/DaoPaaS.d.ts:378
移除错误消息侦听器.

Parameters
- callback: ((error: Message) => void)
  
  回调函数
  - - (error: Message): void
    - Parameters
      - error: Message
      Returns void
Returns void

Optional removeMessage

removeMessage(callback: ((message: Message) => void)): void

- Defined in types/DaoPaaS.d.ts:390
移除消息侦听器.

Parameters
- callback: ((message: Message) => void)
  
  回调函数
  - - (message: Message): void
    - Parameters
      - message: Message
      Returns void
Returns void

Properties

i18nLanguage

i18nLanguage: I18nLanguageType

国际化语言

sdkVersion

sdkVersion: string

sdk版本

themeType

themeType: ThemeType

主题类型

Methods

activePlayground

activePlayground(): void

- Defined in types/DaoPaaS.d.ts:440
激活playground

Returns void

customExecute

customExecute(config: ICustomExcuteConfig): void

- Defined in types/DaoPaaS.d.ts:532
自定义执行，通过业务方携带的配置信息来启动运行 tips：而不是通过后端读取配置文件信息

Parameters
- config: ICustomExcuteConfig
Returns void

dispose

dispose(): void

- Defined in types/DaoPaaS.d.ts:394
页面卸载的时候需要销毁实例和相关的缓存数据

Returns void

followUser

followUser(agentUserId: string, callback: ((userInfo: UserInfo) => void)): void

- Defined in types/DaoPaaS.d.ts:406
用户跟随

Parameters
- agentUserId: string
  
  用户id
- callback: ((userInfo: UserInfo) => void)
  
  回调函数
  - - (userInfo: UserInfo): void
    - Parameters
      - userInfo: UserInfo
      Returns void
Returns void

goToPlayback

goToPlayback(start: number): void

- Defined in types/DaoPaaS.d.ts:427
改变相对开始时间,一般发生在用户托动进度条

Parameters
- start: number
  
  The difference relative to the absolute start time
Returns void

insertCodeByCursor

insertCodeByCursor(callback: IInsertCodeExternalFn): any

- Defined in types/DaoPaaS.d.ts:538
根据光标位置插入内容 tips: 该方法可以用于自定义光标定位

Parameters
- callback: IInsertCodeExternalFn
Returns any

loadTheme

loadTheme(type: ThemeType): void

- Defined in types/DaoPaaS.d.ts:470
切换主题

Parameters
- type: ThemeType
  
  主题类型
Returns void

loggerEnable

loggerEnable(data: any): void

- Defined in types/DaoPaaS.d.ts:465
设置本地logger打印是否开启的方法

Parameters
- data: any
  
  设置的值，当这个值存在就会打印logger
Returns void

mapRender

mapRender(components: Component[]): void

- Defined in types/DaoPaaS.d.ts:453
挂载SDK内部组件

Parameters
- components: Component[]
  
  组件配置信息
Returns void

openFile

openFile(filePath: string): Promise<ResultType>

- Defined in types/DaoPaaS.d.ts:475
打开内部指定文件

Parameters
- filePath: string
Returns Promise<ResultType>

pausePlayback

pausePlayback(): void

- Defined in types/DaoPaaS.d.ts:431
暂停回放

Returns void

preparePlayback

preparePlayback(): any

- Defined in types/DaoPaaS.d.ts:411
准备回放数据,回放摘要信息到达后,会触发PlaybackInfo

Returns any

reload

reload(components?: ModuleType[]): void

- Defined in types/DaoPaaS.d.ts:493
重新加载

默认参数 ['Editor', 'Tree']

memberof
IDaoPaaS

Parameters
- components: ModuleType[] = ...
  
  需要刷新的组件
Returns void

reloadI18nResources

reloadI18nResources(lngOrSource: I18nLanguageType | I18nResourcesType[], resource?: any): void

- Defined in types/DaoPaaS.d.ts:507
切换国际化语言

Parameters
- lngOrSource: I18nLanguageType | I18nResourcesType[]
  
  -语言类型或者整体资源数组文件
- Optional resource: any
  
  国际化文本资源（只有lngOrSource为语言类型需要传入）兼容旧写法
  
  用法: https://snyk.io/advisor/npm-package/i18next/functions/i18next.addResources
Returns void

restartPlayback

restartPlayback(rate?: number): any

- Defined in types/DaoPaaS.d.ts:422
启动播放,可以指定相对开始时间和速率

Parameters
- Optional rate: number
  
  The multiplier relative to the original rate
Returns any

runPlayground

runPlayground(): void

- Defined in types/DaoPaaS.d.ts:444
运行 playground 方法

Returns void

setFileStyle

setFileStyle(params: FileStyleType): void

- Defined in types/DaoPaaS.d.ts:518
设置文件样式

Parameters
- params: FileStyleType
  
  参数 - paths文件路径/styles为对应class
  
  PS: paths文件路径支持minimatch所支持的模糊路径
Returns void

setRate

setRate(rate: number): any

- Defined in types/DaoPaaS.d.ts:436
设置播放速率

Parameters
- rate: number
  
  播放速率
Returns any

startPlayback

startPlayback(start: number, rate: number): any

- Defined in types/DaoPaaS.d.ts:417
启动播放,可以指定相对开始时间和速率

Parameters
- start: number
  
  The difference relative to the absolute start time
- rate: number
  
  The multiplier relative to the original rate
Returns any

stopPlayground

stopPlayground(): void

- Defined in types/DaoPaaS.d.ts:448
停止 playground 方法

Returns void

switchI18nLanguage

switchI18nLanguage(language: I18nLanguageType): void

- Defined in types/DaoPaaS.d.ts:498
切换国际化语言

Parameters
- language: I18nLanguageType
  
  语言
Returns void

switchLspDiagnostic

switchLspDiagnostic(openDiagnostic: boolean): void

- Defined in types/DaoPaaS.d.ts:526
切换LSP诊断

memberof
IDaoPaaS

Parameters
- openDiagnostic: boolean
  
  是否开启诊断报错
Returns void

unFollowUser

unFollowUser(user: UserInfo, callback: ((userInfo: UserInfo) => void)): void

- Defined in types/DaoPaaS.d.ts:400
取消用户跟随

Parameters
- user: UserInfo
  
  用户信息
- callback: ((userInfo: UserInfo) => void)
  
  回调函数
  - - (userInfo: UserInfo): void
    - Parameters
      - userInfo: UserInfo
      Returns void
Returns void

unmapRender

unmapRender(componentName: string): boolean

- Defined in types/DaoPaaS.d.ts:460
卸载已通过 mapRender 挂载的组件。宿主组件 v-if 切换或父级路由切换时调用，避免下一次 mapRender 撞到守卫。

Parameters
- componentName: string
  
  组件名（与 mapRender 的 item 字段对应）
Returns boolean
之前是否真的挂载过该组件

updateConfig

updateConfig(config: Config): any

- Defined in types/DaoPaaS.d.ts:485
更新配置

Parameters
- config: Config
  
  配置
Returns any

updateGlobalConfig

updateGlobalConfig(globalConfig: GlobalConfig): any

- Defined in types/DaoPaaS.d.ts:480
更新全局配置

Parameters
- globalConfig: GlobalConfig
  
  全局配置
Returns any

Hierarchy

Index

Events

Properties

Methods

Events

Optional onError

Parameters

callback: ((error: Message) => void)

Parameters

error: Message

Returns void

Returns void

Optional onMessage

Parameters

callback: ((message: Message) => void)

Parameters

message: Message

Returns void

Returns void

Optional removeError

Parameters

callback: ((error: Message) => void)

Parameters

error: Message

Returns void

Returns void

Optional removeMessage

Parameters

callback: ((message: Message) => void)

Parameters

message: Message

Returns void

Returns void

Properties

i18nLanguage

sdkVersion

themeType

Methods

activePlayground

Returns void

customExecute

Parameters

config: ICustomExcuteConfig

Returns void

dispose

Returns void

followUser

Parameters

agentUserId: string

callback: ((userInfo: UserInfo) => void)

Parameters

userInfo: UserInfo

Returns void

Returns void

goToPlayback

Parameters

start: number

Returns void

insertCodeByCursor

Parameters

callback: IInsertCodeExternalFn

Returns any

loadTheme

Parameters

type: ThemeType

Returns void

loggerEnable

Parameters

data: any

Returns void

mapRender

Parameters

components: Component[]

Returns void

openFile

Parameters

filePath: string

Returns Promise<ResultType>

pausePlayback