API 文档

通过 Twikoo API，主题开发者可以实现一些特殊的功能，例如：在文章列表显示文章评论数，在首页显示最新评论，等。

调用 Twikoo API 前，不需要 执行 twikoo.init()。

Get comments count

批量获取文章评论数。

Version

>= 0.2.7

Example

twikoo
  .getCommentsCount({
    envId: "您的环境 id", // 环境 ID
    // region: 'ap-guangzhou', // 环境地域，默认为 ap-shanghai，如果您的环境地域不是上海，需传此参数
    urls: [
      // 不包含协议、域名、参数的文章路径列表，必传参数
      "/2020/10/post-1.html",
      "/2020/11/post-2.html",
      "/2020/12/post-3.html",
    ],
    includeReply: false, // 评论数是否包括回复，默认：false
  })
  .then(function (res) {
    console.log(res);
    // 返回示例：[
    //   { url: '/2020/10/post-1.html', count: 10 },
    //   { url: '/2020/11/post-2.html', count: 0 },
    //   { url: '/2020/12/post-3.html', count: 20 }
    // ]
  })
  .catch(function (err) {
    // 发生错误
    console.error(err);
  });

Get recent comments

获取最新评论。

Version

>= 0.2.7

Example

twikoo
  .getRecentComments({
    envId: "您的环境 id", // 环境 ID
    // region: 'ap-guangzhou', // 环境地域，默认为 ap-shanghai，如果您的环境地域不是上海，需传此参数
    urls: [
      // 要求云函数版本 >= 1.6.27。不包含协议、域名、参数的文章路径列表，不传默认获取所有最新评论
      "/2020/10/post-1.html",
      "/2020/11/post-2.html",
      "/2020/12/post-3.html",
    ],
    pageSize: 10, // 获取多少条，默认：10，最大：100
    includeReply: false, // 是否包括最新回复，默认：false
  })
  .then(function (res) {
    console.log(res);
    // 返回 Array，包含最新评论的
    //   * id:           评论 ID
    //   * url:          评论地址
    //   * nick:         昵称
    //   * mailMd5:      邮箱的 MD5 值，可用于展示头像
    //   * link:         网址
    //   * comment:      HTML 格式的评论内容
    //   * commentText:  纯文本格式的评论内容
    //   * created:      评论时间，格式为毫秒级时间戳
    //   * avatar:       头像地址（0.2.9 新增）
    //   * relativeTime: 相对评论时间，如“1 小时前”（0.2.9 新增）
    // 返回示例：[ // 从新到旧顺序
    //   { id: '', url: '', nick: '', mailMd5: '', link: '', comment: '', commentText: '', created: 0 },
    //   { id: '', url: '', nick: '', mailMd5: '', link: '', comment: '', commentText: '', created: 0 },
    //   { id: '', url: '', nick: '', mailMd5: '', link: '', comment: '', commentText: '', created: 0 }
    // ]
  })
  .catch(function (err) {
    // 发生错误
    console.error(err);
  });

On Twikoo loaded

Twikoo 成功挂载后的回调函数。
环境 ID 错误、网络异常、挂载失败等情况时不会触发。

Version

>= 0.5.2

Example

twikoo.init({
  ......
}).then(function () {
  console.log('Twikoo 加载完成');
});

On submit

评论提交前的回调函数，参数是即将发送的评论数据。
可以在回调里就地修改这些字段（如改写昵称、追加标记）。
回调抛出异常会中止发送（表单显示错误）；返回 false 不会拦截。

Version

>= 2.0.7

Example

twikoo.init({
  ......,
  onSubmit: function (comment) {
    comment.nick = comment.nick + '（来自小程序）';
  }
});

On comment loaded

评论加载成功后的回调函数。
发表评论后自动刷新评论时、加载下一页评论时，也会触发。
评论加载失败时不会触发。

Version

>= 0.5.2

Example

twikoo.init({
  ......,
  onCommentLoaded: function () {
    console.log('评论加载完成');
  }
});