Skip to content

Event 键值对格式

概述

Event事件采用标准的键值对格式进行数据传输,每个事件包含两个核心字段:TypeName,用于标识事件类型和来源。

字段详细说明

Type 字段

  • 字段描述:标识当前事件的具体类型和用途
  • 数据类型:字符串(String)
  • 可选值:'start' | 'startOne' | 'update' | 'end' | 'endOne' | 'msg' | 'err'
  • 值含义
    • start:表示整个下载任务组开始执行
    • startOne:表示单个下载任务开始执行
    • update:表示下载进度状态更新
    • endOne:表示单个下载任务执行完成
    • end:表示整个下载任务组执行结束
    • msg:表示发送消息通知
    • err:表示发送错误通知

Name 字段

  • 字段描述:事件的名称或简要描述(例如中文描述文本)
  • 数据类型:字符串(String)

ShowName 字段

  • 字段描述:用于展示给用户的任务/会话名称(友好显示名)
  • 数据类型:字符串(String)

ID 字段

  • 字段描述:任务或条目的唯一标识符(例如任务ID)
  • 数据类型:字符串(String)

说明:源码中 Event 结构包含 Type, Name, ShowName, ID 四个字段,接收方在使用时应同时关注 ShowNameID 以定位具体任务或显示名。

使用规范

  1. 数据格式:采用 UTF-8 编码的 JSON 格式传输
  2. 字段验证:接收方应验证 Type 字段的合法性
  3. 兼容性:新版本可能增加新的事件类型,建议实现向前兼容