美文网首页
年轮 URL Scheme 文档

年轮 URL Scheme 文档

作者: 柚子不酸酸酸 | 来源:发表于2019-12-26 16:51 被阅读0次

年轮支持以下的 URL Scheme:

  • mematom://add-card 添加卡片
  • mematom://open-card 打开卡片
  • mematom://review-card 复习卡片

总览

回调 Callback

年轮对于每个 URL 会读取以下 callback 参数

  • x-success 成功后打开URL
  • x-error 错误后打开URL
  • x-callback 如果 x-successx-error 没有提供时,会打开 x-callback

所有命令的返回值,将在回调 URL 的查阅参数中
返回值都会含有errorMessage 参数,如果成功其值为OK, 或者含有其错误信息

添加卡片

URL: mematom://add-card

参数:

  • title 标题
  • plan-id 查阅计划标志符;若查阅计划不存在则忽略;若含有此参数,则plan-name将忽略
  • plan-name 查阅计划名称;若查阅计划不存在则忽略
  • tag-id-list 标签标志符,用英文,逗号隔开;若标签不存在则忽略;若含有此参数,则tag-names 将忽略。
  • tag-names 标签名称,用英文,逗号隔开;若标签不存在则创建标签
  • api-token 写操作令牌;若未含有,将中断操作,返回错误
  • separator 标题分隔符;若提供,以第一个字符将其 title 进行分割,批量创建(3.6版本及以上)。比如 title 值为 1,2,3,4,5,separator 值为 ,,会将 title 的值(1,2,3,4,5)用 , 分割为 12345

返回值:

  • card-id 若创建成功,返回创建的卡片标志符
  • card-ids 批量创建的卡片标志符,以英文逗号,进行连接,如ID1,ID2

复习卡片

URL: mematom://review-card

参数:

  • card-id 卡片标志符

  • effect 值为1(认识)、2(模糊)、3(忘记);若未含有,默认值为1
    复习日期:若未含有next-days时,认识根据查阅计划而定,模糊在3天后复习,忘记在1天后复习
    进度:认识会增加进度,而模糊忘记不会修改进度,仅设定下次复习日期

  • next-days 下次复习日期距离现在的天数
    若未含有,则根据查阅计划获取间隔
    若含有,卡片复习进度不会增加,仅复习并设定下次复习日期
    样例1:如果值为1,当前进度为2/16,操作后,一天后再次复习此卡片,进度仍为2/16
    样例2:若未含有此参数,进度和下次复习日期根据effect 而定

  • api-token 写操作令牌

打开卡片

URL: mematom://open-card

参数:

  • card-id 卡片标志符

相关文章

网友评论

      本文标题:年轮 URL Scheme 文档

      本文链接:https://www.haomeiwen.com/subject/viaznctx.html