论坛插件文档

getByName(name)

forumTagFinder.getByName(name)

描述

根据 metadata.name 获取标签。

参数

name:string - 标签的唯一标识 metadata.name。

返回值

#TagVo

示例

<div th:with="tag = ${forumTagFinder.getByName('forum-tag-foo')}">
  <a th:href="@{${tag.status.permalink}}" th:text="${tag.spec.displayName}"></a>
</div>

getByNames(names)

forumTagFinder.getByNames(names)

描述

根据一组 metadata.name 获取标签。

参数

names:List<string> - 标签的唯一标识 metadata.name 的集合。

返回值

List<#TagVo>

示例

<div th:with="tags = ${forumTagFinder.getByNames(['forum-tag-foo', 'forum-tag-bar'])}">
  <a th:each="tag : ${tags}" th:href="@{${tag.status.permalink}}" th:text="${tag.spec.displayName}"></a>
</div>

list(page,size)

forumTagFinder.list(page,size)

描述

根据分页参数获取标签列表。

参数

page:int - 分页页码，从 1 开始
size:int - 分页条数

返回值

#ListResult<TagVo>

示例

<ul th:with="tags = ${forumTagFinder.list(1,10)}">
  <li th:each="tag : ${tags.items}">
    <a th:href="@{${tag.status.permalink}}" th:text="${tag.spec.displayName}"></a>
  </li>
</ul>

listAll()

forumTagFinder.listAll()

描述

获取所有帖子标签。

参数

无

返回值

List<#TagVo>

示例

<ul th:with="tags = ${forumTagFinder.listAll()}">
  <li th:each="tag : ${tags}">
    <a th:href="@{${tag.status.permalink}}" th:text="${tag.spec.displayName}"></a>
  </li>
</ul>

类型定义

TagVo

{
  "metadata": {
    "name": "string",                                   // 唯一标识
    "labels": {
      "additionalProp1": "string"
    },
    "annotations": {
      "additionalProp1": "string"
    },
    "creationTimestamp": "2022-11-20T13:06:38.512Z",    // 创建时间
  },
  "spec": {
    "displayName": "string",                            // 显示名称
    "slug": "string",                                   // 别名，通常用于生成 status.permalink
    "description": "string",                            // 描述
    "cover": "string"                                   // 封面图
  },
  "status": {
    "permalink": "string",                              // 固定链接
    "visibleForumPostCount": 0,                         // 已发布帖子数
    "forumPostCount": 0                                 // 帖子数
  },
  "forumPostCount": 0
}

ListResult<TagVo>

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

#TagVo