PPAgent 文档

Appearance

ppagent / IGlobalNotifyEventData

Interface: IGlobalNotifyEventData ​

Defined in: src/util/global.event.ts:6

Extends ​

Properties ​

data? ​

optional data: any

Defined in: src/util/global.event.ts:57

消息的详细数据

Inherited from ​

IGlobalEventData.data

desc? ​

optional desc: string

Defined in: src/util/global.event.ts:45

消息的描述

Inherited from ​

IGlobalEventData.desc

id? ​

optional id: string

Defined in: src/util/global.event.ts:53

用来唯一标记一条消息。如果是支持与配置端进行callback的通知，在callback的时候需要根据这个id来识别当前是哪个消息的callback。

Inherited from ​

IGlobalEventData.id

info ​

info: object

Defined in: src/util/global.event.ts:7

callbackUrl? ​

optional callbackUrl: string

如果提供了callback url，那么客户端会详细消息操作按钮。当提供了schema和data时，按照可视化方式显示，否则显示一个文本输入框。用户编辑的JSON结果，将被POST到指定的路由下。

为http的绝对路径。

confirmActionName? ​

optional confirmActionName: string

详情窗口中，确认按钮的名称，默认是“提交”

detailActionName? ​

optional detailActionName: string

操作按钮的名称，默认是“详情”

expireInSeconds? ​

optional expireInSeconds: number

消息的有效期，如果不提供，则使用插件的全局有效期，全局有效期默认为1小时

level? ​

optional level: "normal" | "important" | "urgent"

通知等级，important和urgent会高亮显示

schema? ​

optional schema: Stringify

表单结构

time? ​

optional time: Date

Defined in: src/util/global.event.ts:49

消息的时间

Inherited from ​

IGlobalEventData.time

title ​

title: string

Defined in: src/util/global.event.ts:41

消息名称

Inherited from ​

IGlobalEventData.title