PPAgent 文档

Appearance

ppagent / IDingRobotSourceParams

Interface: IDingRobotSourceParams ​

Defined in: src/source/ding.robot.source.ts:135

params应该由source供应商提供

Extends ​

Properties ​

autoAppendAt? ​

optional autoAppendAt: boolean

Defined in: src/source/source.ts:36

是否不要在@的时候自动加上@fieldInAtList的值。默认false，即不会自动附加。

Inherited from ​

ISourceParamas.autoAppendAt

desc? ​

optional desc: string

Defined in: src/config.ts:68

Inherited from ​

ISourceParamas.desc

eventNames ​

eventNames: string[]

Defined in: src/source/source.ts:32

可以被外界监听的消息类型 内置类型可以从SourceEventTypes中选择，也可以加入自定义类型。

Inherited from ​

ISourceParamas.eventNames

fieldInAtList? ​

optional fieldInAtList: "userName" | "userId" | "nickName"

Defined in: src/source/source.ts:27

@ 相关功能的时候，atList里面是用户信息的哪个字段，默认是userId，不同的source可能会有区别，可以在此配置

可以配置的值有：userName userId nickName

Inherited from ​

ISourceParamas.fieldInAtList

logoPath? ​

optional logoPath: string

Defined in: src/config.ts:72

公共目录的相对路径，如 /public/images/logo.png

Inherited from ​

ISourceParamas.logoPath

name ​

name: string

Defined in: src/config.ts:67

类型的名称（非实例名称），所有该类型的实例都一样

Inherited from ​

ISourceParamas.name

optionsSchema ​

optionsSchema: IConfigSchema

Defined in: src/config.ts:76

实例属性配置的结构

Inherited from ​

ISourceParamas.optionsSchema

readMeUrl? ​

optional readMeUrl: string

Defined in: src/config.ts:85

使用文档地址

Inherited from ​

ISourceParamas.readMeUrl

supported? ​

optional supported: object

Defined in: src/config.ts:77

groupInAndOut? ​

optional groupInAndOut: boolean

inTypes? ​

optional inTypes: SourceChatMessageType[]

outTypes? ​

optional outTypes: SourceChatMessageType[]

Inherited from ​

ISourceParamas.supported

supportedFileExts ​

supportedFileExts: string[]

Defined in: src/source/ding.robot.source.ts:136