跳到主要内容
版本：2.18.0-SNAPSHOT

评论

getByName(name)​

commentFinder.getByName(name)

描述​

根据 metadata.name 获取评论。

参数​

  1. name:string - 评论的唯一标识 metadata.name。

返回值​

#CommentVo

示例​

<div th:with="comment = ${commentFinder.getByName('comment-foo')}">
  <span th:text="${comment.spec.owner.displayName}"></span>
  <div th:text="${comment.spec.content}"></div>
</div>

list(ref,page,size)​

commentFinder.list(ref,page,size)

描述​

根据评论的 metadata.name 和分页参数获取回复列表。

参数​

  1. ref:#Ref - 评论的唯一标识 metadata.name。
  2. page:int - 分页页码，从 1 开始
  3. size:int - 分页条数

返回值​

#ListResult<CommentVo>

示例​

<ul th:with="comments = ${commentFinder.list({ group: 'content.halo.run', version: 'v1alpha1', kind: 'Post', name: 'post-foo' },1,10)}">
  <li th:each="comment : ${comments.items}">
    <span th:text="${comment.spec.owner.displayName}"></span>
    <div th:text="${comment.spec.content}"></div>
  </li>
</ul>

listReply(commentName,page,size)​

commentFinder.listReply(commentName,page,size)

描述​

根据评论的 metadata.name 和分页参数获取回复列表。

参数​

  1. commentName:string - 评论的唯一标识 metadata.name。
  2. page:int - 分页页码，从 1 开始
  3. size:int - 分页条数

返回值​

#ListResult<ReplyVo>

示例​

<ul th:with="replies = ${commentFinder.listReply('comment-foo',1,10)}">
  <li th:each="reply : ${replies.items}">
    <span th:text="${reply.spec.owner.displayName}"></span>
    <div th:text="${reply.spec.content}"></div>
  </li>
</ul>

类型定义​

CommentVo​

CommentVo
{
  "metadata": {
    "name": "string",                                   // 唯一标识
    "labels": {
      "additionalProp1": "string"
    },
    "annotations": {
      "additionalProp1": "string"
    },
    "creationTimestamp": "2022-11-20T12:16:19.788Z"     // 创建时间
  },
  "spec": {
    "raw": "string",                                    // 原始文本，一般用于给编辑器使用
    "content": "string",                                // 最终渲染的文本
    "owner": {                                          // 创建者关联
      "kind": "string",
      "name": "string",
      "displayName": "string",
      "annotations": {
        "additionalProp1": "string"
      }
    },
    "userAgent": "string",                              // 评论者 UserAgent 信息
    "ipAddress": "string",                              // 评论者 IP 地址
    "priority": 0,                                      // 排序字段
    "top": false,                                       // 是否置顶
    "allowNotification": true,                          // 是否允许通知
    "approved": false,
    "hidden": false,
    "subjectRef": {                                     // 引用关联，比如文章、自定义页面
      "group": "string",
      "version": "string",
      "kind": "string",
      "name": "string"
    },
    "lastReadTime": "2022-11-20T12:16:19.788Z"
  },
  "status": {
    "lastReplyTime": "2022-11-20T12:16:19.788Z",
    "replyCount": 0,                                    // 回复数量
    "unreadReplyCount": 0,
    "hasNewReply": true                                 // 是否有新回复
  },
  "owner": {                                            // 创建者信息
    "kind": "string",
    "name": "string",
    "displayName": "string",
    "avatar": "string",
    "email": "string"
  }
}

ListResult<CommentVo>​

ListResult<CommentVo>
{
  "page": 0,                                   // 当前页码
  "size": 0,                                   // 每页条数
  "total": 0,                                  // 总条数
  "items": "List<#CommentVo>",                 // 评论列表数据
  "first": true,                               // 是否为第一页
  "last": true,                                // 是否为最后一页
  "hasNext": true,                             // 是否有下一页
  "hasPrevious": true,                         // 是否有上一页
  "totalPages": 0                              // 总页数
}

ReplyVo​

ReplyVo
{
  "metadata": {
    "name": "string",                                   // 唯一标识
    "labels": {
      "additionalProp1": "string"
    },
    "annotations": {
      "additionalProp1": "string"
    },
    "creationTimestamp": "2022-11-20T12:25:32.357Z"     // 创建时间
  },
  "spec": {
    "raw": "string",                                    // 原始文本，一般用于给编辑器使用
    "content": "string",                                // 最终渲染的文本
    "owner": {                                          // 创建者关联
      "kind": "string",
      "name": "string",
      "displayName": "string",
      "annotations": {
        "additionalProp1": "string"
      }
    },
    "userAgent": "string",                              // 评论者 UserAgent 信息
    "ipAddress": "string",                              // 评论者 IP 地址
    "priority": 0,                                      // 排序字段
    "top": false,                                       // 是否置顶
    "allowNotification": true,                          // 是否允许通知
    "approved": false,
    "hidden": false,
    "commentName": "string",                            // 被回复的评论名称，即 Comment 的 metadata.name
    "quoteReply": "string"                              // 被回复的回复名称，即 Reply 的 metadata.name
  },
  "owner": {                                            // 创建者信息
    "kind": "string",
    "name": "string",
    "displayName": "string",
    "avatar": "string",
    "email": "string"
  }
}

ListResult<ReplyVo>​

ListResult<ReplyVo>
{
  "page": 0,                                   // 当前页码
  "size": 0,                                   // 每页条数
  "total": 0,                                  // 总条数
  "items": "List<#ReplyVo>",                   // 回复列表数据
  "first": true,                               // 是否为第一页
  "last": true,                                // 是否为最后一页
  "hasNext": true,                             // 是否有下一页
  "hasPrevious": true,                         // 是否有上一页
  "totalPages": 0                              // 总页数
}

Ref​

Ref
{
  "group": "string",
  "kind": "string",
  "version": "string",
  "name": "string"
}