wangdl/zhixi-document-runtime
1
0
Fork 0
Code Issues 15 Pull Requests Actions Packages Projects Releases Wiki Activity

DOC-FULL-008：iOS 事件导出示例 #109

New Issue
Closed
opened 2026-06-10 21:18:33 +08:00 by wangdl · 1 comment
wangdl commented 2026-06-10 21:18:33 +08:00
Owner
Copy Link

目标

提供 iOS 如何调用 Rust V2 事件链路的示例代码 / 文档。

示例流程

openReadingSessionV2
→ heartbeatV2
→ recordPositionChangedV2
→ recordMarkedAsReadV2
→ closeReadingSessionV2
→ exportPendingEventsV2
→ iOS 转 UploadItem
→ iOS 写入 ReadingEventUploadQueue
→ ackEventsV2

必须强调

  1. Rust 不上传 API。
  2. Rust 不知道 readingTargetType。
  3. iOS 转 UploadItem 时补 readingTargetType / platform / appVersion / timezone。
  4. iOS 写入本地上传队列成功后才 ack。
  5. ack 不等 API 上传成功。

验收标准

  1. 新增 docs/ios-reading-event-v2-integration.md。
  2. 包含 Swift 伪代码或示例。
  3. 包含 export / queue / ack 顺序。
  4. 包含错误处理。
  5. 包含 mark failed 示例。
  6. 能指导 M-IOS-INFO 接入。
## 目标 提供 iOS 如何调用 Rust V2 事件链路的示例代码 / 文档。 ## 示例流程 ``` openReadingSessionV2 → heartbeatV2 → recordPositionChangedV2 → recordMarkedAsReadV2 → closeReadingSessionV2 → exportPendingEventsV2 → iOS 转 UploadItem → iOS 写入 ReadingEventUploadQueue → ackEventsV2 ``` ## 必须强调 1. Rust 不上传 API。 2. Rust 不知道 readingTargetType。 3. iOS 转 UploadItem 时补 readingTargetType / platform / appVersion / timezone。 4. iOS 写入本地上传队列成功后才 ack。 5. ack 不等 API 上传成功。 ## 验收标准 1. 新增 docs/ios-reading-event-v2-integration.md。 2. 包含 Swift 伪代码或示例。 3. 包含 export / queue / ack 顺序。 4. 包含错误处理。 5. 包含 mark failed 示例。 6. 能指导 M-IOS-INFO 接入。
wangdl added this to the M-DOC-FULL：Document Runtime 完整阅读内核与学习事件协议 milestone 2026-06-10 21:18:33 +08:00
wangdl commented 2026-06-11 21:19:54 +08:00
Author
Owner
Copy Link

完成证据

产物: (256 行)
提交:

内容:

  • 完整 Swift 伪代码：openSession / heartbeat / recordPosition / recordMarkedAsRead / closeSession / flushPendingEvents
  • export → queue → ack 正确顺序（写本地队列成功后才 ack）
  • 错误处理示例（best-effort close, SessionError.AlreadyClosed 处理）
  • 异常恢复示例（App background / crash recovery / reload_stale_events_v2）
  • 明确 Rust 不上传 API、readingTargetType 由 iOS 补充
  • 能指导 M-IOS-INFO 接入
## 完成证据 **产物**: (256 行) **提交**: **内容**: - 完整 Swift 伪代码：openSession / heartbeat / recordPosition / recordMarkedAsRead / closeSession / flushPendingEvents - export → queue → ack 正确顺序（写本地队列成功后才 ack） - 错误处理示例（best-effort close, SessionError.AlreadyClosed 处理） - 异常恢复示例（App background / crash recovery / reload_stale_events_v2） - 明确 Rust 不上传 API、readingTargetType 由 iOS 补充 - 能指导 M-IOS-INFO 接入
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
area:android
Android 集成
area:architecture
架构设计
area:ci
CI/CD
area:core
zx_document_core
area:document-runtime
Document Runtime 相关
area:epub
EPUB 相关
area:events
阅读事件
area:ffi
FFI 绑定层
area:image
图片处理
area:ios
iOS 集成
area:markdown
Markdown 解析
area:notes
笔记锚点
area:office
Office 格式
area:pdf
PDF 相关
area:progress
阅读位置与进度
area:search
搜索
area:text
TXT 解析
audit:planned
已完成宏观规划
priority:p0
最高优先级，阻塞发布
priority:p1
高优先级，本里程碑必需
priority:p2
中优先级，后续版本
repo:document-runtime
Rust Document Runtime 仓库
status:blocked
被阻塞
status:needs-review
待审查
status:todo
待执行
type:design
设计与建模
type:docs
文档相关
type:implementation
功能实现
type:integration
平台集成与绑定
type:research
调研与评估
type:test
测试相关
work:api-mapping
API 协议映射
work:architecture
架构
work:compatibility
兼容性
work:contract
协议/契约
work:design
架构设计
work:docs
文档
work:event
阅读事件
work:event-buffer
事件缓冲
work:example
示例代码
work:ffi
FFI 绑定
work:ffi-contract
FFI 契约
work:ios-contract
iOS 嵌入契约
work:model
数据模型
work:position
阅读位置
work:queue
队列
work:session
阅读会话
work:time-tracking
时长计算
work:uniffi
UniFFI
work:v1-v2
V1/V2 迁移
work:v2
V2 模块
No Label
area:document-runtime
audit:planned
priority:p0
repo:document-runtime
status:todo
work:docs
work:example
work:ios-contract
Milestone
No items
No Milestone M-DOC-FULL：Document Runtime 完整阅读内核与学习事件协议
Projects
Clear projects
No project
Assignees
Clear assignees
wangdl
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: wangdl/zhixi-document-runtime#109
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?