PPAgent 文档

Appearance

ppagent / ISource

Interface: ISource ​

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

消息源的实现类

Extends ​

Properties ​

event ​

event: Emittery

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

用户发布订阅事件的对象，事件类型为SourceEventType

Accessors ​

actions ​

Get Signature ​

get actions(): ISourceActionInfo[]

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

消息源的路由和ws处理器列表，需要在消息源的构造函数阶段创建

Returns ​

ISourceActionInfo[]

options ​

Get Signature ​

get options(): ISourceOptions

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

初始化过程中的动态参数

Returns ​

ISourceOptions

Overrides ​

IInstance.options

params ​

Get Signature ​

get params(): ISourceParamas

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

这个Source的固有属性，比如source的平台名称

Returns ​

ISourceParamas

Overrides ​

IInstance.params

Methods ​

afterSend()? ​

optional afterSend(sourceMessage): any

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

当agent把内容发送给bot之后，可以用来给source释放相关资源，如结束卡片的写入状态。

Parameters ​

sourceMessage ​

ISourceChatMessage

Returns ​

any

beforeSend()? ​

optional beforeSend(sourceMessage): Promise<void>

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

当agent把内容送给bot回复之前。可以用来做一系列的准备工作，如提前下发卡片stream卡片。

Parameters ​

sourceMessage ​

ISourceChatMessage

Returns ​

Promise<void>

getContactDetail() ​

getContactDetail(baseInfo): Promise<ISourceUserInfo>

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

根据获取联系人列表接口返回的粗略信息

Parameters ​

baseInfo ​

ISourceUserInfo

Returns ​

Promise<ISourceUserInfo>

getContacts() ​

getContacts(mode, force?): Promise<object & Partial<ISourceUserInfo>[]>

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

获取用户信息，至少返回nickName

Parameters ​

mode ​

all返回全部，user仅返回个人用户，group仅返回群组

"all" | "user" | "group"

force? ​

boolean

Returns ​

Promise<object & Partial<ISourceUserInfo>[]>

hasLogin() ​

hasLogin(): boolean

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

是否是登录状态。仅被用来检查登录状态，未登录不代表出错，也可能是正处于登录中。

Returns ​

boolean

login() ​

login(): Promise<void>

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

执行登录，如果有需要扫码等，应发出全局TODO事件，登录成功后发出LOGIN消息，并携带用户信息

Returns ​

Promise<void>

me() ​

me(force?): Promise<ISourceUserInfo>

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

获取当前登录用户的个人信息

Parameters ​

force? ​

boolean

Returns ​

Promise<ISourceUserInfo>

sendMessage() ​

sendMessage(message, fromMessage?): Promise<string>

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

发送消息，如果返回内容不为空，说明发送失败

Parameters ​

message ​

ISourceChatMessage

要发送的消息

fromMessage? ​

ISourceChatMessage

该条消息如果是对某条消息的响应，可以传入原始消息。某些平台可能只允许被动发送消息，此时可能需要用到原始触发回复的那条消息。

Returns ​

Promise<string>