FastComments Swift SDK

这是 FastComments 的官方 Swift SDK。

FastComments API 的官方 Swift SDK

仓库

AI coding agents

为您的编码代理提供 FastComments 所需的上下文——小部件、配置、Secure SSO、REST API 和 SDK：

npx skills add fastcomments/skills

兼容 Claude Code、Codex、Cursor、Copilot、Gemini，以及所有其他由 skills CLI 支持的代理。

Installation

Swift Package Manager

在您的 Package.swift 文件中添加以下内容：

dependencies: [
    .package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "3.1.2")
]

或者在 Xcode 中：

File > Add Packages...
输入仓库 URL：https://github.com/fastcomments/fastcomments-swift.git
选择您想使用的版本

系统要求

Swift 5.9+
iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+

Library Contents

FastComments 的 Swift SDK 由多个模块组成：

客户端模块 - 用于 FastComments REST API 的客户端
- 为所有 API 模型提供完整的类型定义
- 包含验证（DefaultAPI）、公共（PublicAPI）和审核（ModerationAPI）方法
- 完整的 async/await 支持
- 详见 client/README.md 获取详细的 API 文档
SSO 模块 - 服务器端单点登录实用工具
- 用于用户认证的安全令牌生成
- 支持简单和安全两种 SSO 模式
- 使用 CryptoKit 基于 HMAC-SHA256 的令牌签名

Quick Start

使用公共 API

import FastCommentsSwift

// 获取页面的评论
do {
    let response = try await PublicAPI.getCommentsPublic(
        tenantId: "your-tenant-id",
        urlId: "page-url-id"
    )

    print("Found \(response.comments?.count ?? 0) comments")
    for comment in response.comments ?? [] {
        print("Comment: \(comment.comment ?? "")")
    }
} catch {
    print("Error fetching comments: \(error)")
}

使用已认证 API

import FastCommentsSwift

// 在共享配置上设置您的 API 密钥（作为 x-api-key 头发送）
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "your-api-key"

// 使用已认证 API 获取评论
do {
    let response = try await DefaultAPI.getComments(
        tenantId: "your-tenant-id",
        options: .init(urlId: "page-url-id")
    )

    print("Total comments: \(response.count ?? 0)")
    for comment in response.comments ?? [] {
        print("Comment ID: \(comment.id ?? ""), Text: \(comment.comment ?? "")")
    }
} catch {
    print("Error: \(error)")
}

使用审查 API

import FastCommentsSwift

// 审核方法需要使用 `sso` 令牌进行授权（使用 FastCommentsSSO 生成，参见上面的 SSO 部分）。
do {
    let response = try await ModerationAPI.getApiComments(
        options: .init(
            page: 0,
            count: 30,
            sso: ssoToken
        )
    )

    print("Found \(response.comments.count) comments to moderate")
    for comment in response.comments {
        print("Comment ID: \(comment.id), Text: \(comment.commentHTML)")
    }
} catch {
    print("Error: \(error)")
}

使用 SSO 进行身份验证

安全 SSO（推荐用于生产环境）

import FastCommentsSwift

let apiKey = "your-api-key"

// 创建安全的 SSO 用户数据（仅限服务器端！）
let userData = SecureSSOUserData(
    id: "user-123",              // User ID
    email: "user@example.com",   // Email
    username: "johndoe",         // Username
    avatar: "https://example.com/avatar.jpg" // Avatar URL
)

// 生成 SSO 令牌
do {
    let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
    let token = try sso.createToken()

    print("SSO Token: \(token ?? "")")
    // 将此令牌传递给前端进行身份验证
} catch {
    print("Error creating SSO token: \(error)")
}

简单 SSO（用于开发/测试）

import FastCommentsSwift

// 创建简单的 SSO 用户数据（无需 API 密钥）
let userData = SimpleSSOUserData(
    username: "johndoe",
    email: "user@example.com",
    avatar: "https://example.com/avatar.jpg"
)

// 生成简单 SSO 令牌
let sso = FastCommentsSSO.createSimple(simpleSSOUserData: userData)
do {
    let token = try sso.createToken()
    print("Simple SSO Token: \(token ?? "")")
} catch {
    print("Error creating SSO token: \(error)")
}

API Clients

FastComments SDK 提供了三个 API 客户端：

PublicAPI - 客户端安全方法

PublicAPI 包含可安全从客户端代码（iOS/macOS 应用）调用的方法。这些方法：

不需要 API 密钥
可以使用 SSO 令牌进行身份验证
按用户/设备进行限流
适用于面向最终用户的应用程序

示例用例：在 iOS 应用中获取和创建评论

DefaultAPI - 服务器端方法

DefaultAPI 包含需要 API 密钥的已认证方法。这些方法：

需要您的 FastComments API 密钥
只能从服务器端代码调用
提供对您的 FastComments 数据的完整访问
按租户进行限流

示例用例：管理操作、大批量数据导出、用户管理

ModerationAPI - 版主仪表盘方法

ModerationAPI 提供了一个功能丰富的实时快速审核 API 套件。每个 ModerationAPI 方法都接受一个 sso 参数，并且可以通过 SSO 或 FastComments.com 会话 Cookie 进行身份验证。

示例用例：为您社区的版主构建审核体验

重要提示：切勿在客户端代码中暴露您的 API 密钥。API 密钥应仅在服务器端使用。

Making API Calls

Swift SDK 使用现代的 async/await 语法进行所有 API 调用：

let response = try await PublicAPI.getCommentsPublic(
    tenantId: "your-tenant-id",
    urlId: "page-url-id"
)

Common Issues

401 未授权错误

如果在使用已认证的 API 时遇到 401 错误：

检查您的 API 密钥：确保使用来自 FastComments 仪表板的正确 API 密钥
验证租户 ID：确保租户 ID 与您的账户匹配
API 密钥格式：API 密钥应在共享配置中设置为 x-api-key 头部：

FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "YOUR_API_KEY"

使用错误的 API：确保在已认证调用中使用 DefaultAPI（而不是 PublicAPI）

SSO 令牌问题

如果 SSO 令牌无法正常工作：

在生产环境中使用安全模式：始终使用 FastCommentsSSO.createSecure() 并传入您的 API 密钥进行生产环境部署
仅限服务器端：在服务器上生成安全的 SSO 令牌，切勿将 API 密钥暴露给客户端
检查用户数据：确保提供所有必填字段（id、email、username）
令牌过期：安全的 SSO 令牌包含时间戳，可能会过期。根据需要生成新的令牌。

SSL/TLS 错误

如果遇到 SSL/TLS 错误：

确保您的应用的 Info.plist 允许对 fastcomments.com 的 HTTPS 连接
检查是否未使用可能阻止连接的 App Transport Security 异常

Notes

广播 ID

你会看到在某些 API 调用中需要传入 broadcastId。当你接收到事件时，会返回该 ID，这样如果你打算在客户端乐观地应用更改（你很可能会这么做，因为它能提供最佳体验），就可以知道要忽略该事件。请在此处传入一个 UUID。该 ID 应该足够唯一，以避免在一次会话中出现两次。

let broadcastId = UUID().uuidString

createAgentTenant

创建一个新的 AI 代理试用账户，无需人工注册。调用此接口不需要 API 密钥。

响应中包含租户 ID、可立即用于 REST API 和 MCP 服务器的 API 密钥，以及一个认领 URL。将该认领 URL 提供给您为之工作的人员：在登录 FastComments 后打开该链接即可将账户关联到他们。未认领的账户及其密钥将在创建后 72 小时内被删除。在认领之前，账户拥有标准的试用限制。

Response

返回：CreateAgentTenantResponse

Example

createAgentTenant 示例

Copy

// 以下代码示例仍处于 beta 版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let createAgentTenantBody = CreateAgentTenantBody(name: "name_example", domains: ["domains_example"], agent: "agent_example") // CreateAgentTenantBody | 
DefaultAPI.createAgentTenant(createAgentTenantBody: createAgentTenantBody) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

aggregate

聚合文档，通过对文档进行分组（如果提供了 groupBy）并执行多项操作来实现。支持不同的操作（例如 sum、countDistinct、avg 等）。

参数

名称	类型	位置	必需
tenantId	string	query	Yes
parentTenantId	string	query	No
includeStats	boolean	query	No

响应

返回: AggregateResponse

示例

聚合示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let aggregationRequest = AggregationRequest(query: [QueryPredicate(key: "key_example", value: QueryPredicate_value(), _operator: "_operator_example")], resourceName: "resourceName_example", groupBy: ["groupBy_example"], operations: [AggregationOperation(field: "field_example", op: AggregationOpType(), alias: "alias_example", expandArray: false)], sort: AggregationRequest_sort(dir: "dir_example", field: "field_example")) // AggregationRequest | 
let parentTenantId = "parentTenantId_example" // String |  (optional)
let includeStats = true // Bool |  (optional)
DefaultAPI.aggregate(tenantId: tenantId, aggregationRequest: aggregationRequest, options: DefaultAPI.AggregateOptions(parentTenantId: parentTenantId, includeStats: includeStats)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getAuditLogs

参数

名称	类型	位置	必填	描述
tenantId	string	query	Yes	要读取审计日志的租户。
limit	integer	query	No	返回多少条日志。最大 10000，默认 1000。
skip	integer	query	No	要跳过的日志数量，用于分页。
order	string	query	No	事件时间的排序方向。默认 DESC（最新的在前）。
after	integer	query	No
before	integer	query	No
username	string	query	No	仅返回此用户名执行的事件。
ip	string	query	No	仅返回来自此 IP 地址的事件。
crudType	string	query	No	仅返回此类型的事件：c、r、u、d 或 login。
resourceName	string	query	No	仅返回此资源的事件，例如 User 或 Moderator。
targetId	string	query	No	仅返回受影响对象具有此 ID 的事件。
target	string	query	No	对受影响对象的标签进行不区分大小写的子字符串匹配，例如用户名或电子邮件。
includeManagedTenants	boolean	query	No	还返回此租户管理的租户的事件。

响应

返回：GetAuditLogsResponse

示例

getAuditLogs 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 要读取审计日志的租户。
let limit = 987 // Int | 返回多少条日志。最大 10000，默认 1000。（可选）
let skip = 987 // Int | 要跳过的日志数量，用于分页。（可选）
let order = SORT_DIR() // SORTDIR | 事件时间的排序方向。默认 DESC（最新的在前）。（可选）
let after = 987 // Int64 |  （可选）
let before = 987 // Int64 |  （可选）
let username = "username_example" // String | 仅返回此用户名执行的事件。（可选）
let ip = "ip_example" // String | 仅返回来自此 IP 地址的事件。（可选）
let crudType = "crudType_example" // String | 仅返回此类型的事件：c、r、u、d 或 login。（可选）
let resourceName = "resourceName_example" // String | 仅返回此资源的事件，例如 User 或 Moderator。（可选）
let targetId = "targetId_example" // String | 仅返回受影响对象具有此 ID 的事件。（可选）
let target = "target_example" // String | 对受影响对象的标签进行不区分大小写的子字符串匹配，例如用户名或电子邮件。（可选）
let includeManagedTenants = true // Bool | 还返回此租户管理的租户的事件。（可选）
DefaultAPI.getAuditLogs(tenantId: tenantId, options: DefaultAPI.GetAuditLogsOptions(limit: limit, skip: skip, order: order, after: after, before: before, username: username, ip: ip, crudType: crudType, resourceName: resourceName, targetId: targetId, target: target, includeManagedTenants: includeManagedTenants)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

logoutPublic

响应

返回：APIEmptyResponse

示例

logoutPublic 示例

Copy

// 以下代码示例仍处于测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
PublicAPI.logoutPublic() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getBatchJob

状态、进度以及完成后批处理作业的结果。

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
id	string	path	是

响应

返回：GetBatchJobAPIResponse

示例

getBatchJob 示例

Copy

// 以下代码示例仍处于 beta 版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
DefaultAPI.getBatchJob(tenantId: tenantId, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getBatchJobs

The tenant's batch jobs (imports, exports, page migrations...), newest first.

Parameters

名称	类型	位置	必需	描述
tenantId	string	query	是
type	string	query	否	仅此类型的作业，例如 migrate-pages。
status	string	query	否	仅此状态的作业：requested、running、success 或 failed。
skip	integer	query	否	要跳过的作业数量，用于分页。

Response

Returns: GetBatchJobsAPIResponse

Example

getBatchJobs 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let type = "type_example" // String | 仅此类型的作业，例如 migrate-pages。（optional）
let status = "status_example" // String | 仅此状态的作业：requested、running、success 或 failed。（optional）
let skip = 987 // Int | 要跳过的作业数量，用于分页。（optional）
DefaultAPI.getBatchJobs(tenantId: tenantId, options: DefaultAPI.GetBatchJobsOptions(type: type, status: status, skip: skip)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

blockFromCommentPublic

参数

Name	Type	Location	Required
tenantId	string	query	是
commentId	string	path	是
sso	string	query	否

响应

返回: BlockSuccess

示例

blockFromCommentPublic 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let publicBlockFromCommentParams = PublicBlockFromCommentParams(commentIds: ["commentIds_example"]) // PublicBlockFromCommentParams | 
let sso = "sso_example" // String |  (可选)
PublicAPI.blockFromCommentPublic(tenantId: tenantId, commentId: commentId, publicBlockFromCommentParams: publicBlockFromCommentParams, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

unBlockCommentPublic

参数

名称	类型	位置	必填
tenantId	string	query	是
commentId	string	path	是
sso	string	query	否

响应

返回: UnblockSuccess

示例

unBlockCommentPublic 示例

Copy

// 以下代码示例仍为测试版。如遇任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let publicBlockFromCommentParams = PublicBlockFromCommentParams(commentIds: ["commentIds_example"]) // PublicBlockFromCommentParams | 
let sso = "sso_example" // String |  (可选)
PublicAPI.unBlockCommentPublic(tenantId: tenantId, commentId: commentId, publicBlockFromCommentParams: publicBlockFromCommentParams, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

checkedCommentsForBlocked

参数

Name	Type	Location	Required	Description
tenantId	string	query	是
commentIds	string	query	是	以逗号分隔的评论 id 列表。
sso	string	query	否

响应

返回: CheckBlockedCommentsResponse

示例

checkedCommentsForBlocked 示例

Copy

// 以下代码示例仍处于测试版。如有问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentIds = "commentIds_example" // String | 以逗号分隔的评论 id 列表。
let sso = "sso_example" // String |  （可选）
PublicAPI.checkedCommentsForBlocked(tenantId: tenantId, commentIds: commentIds, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

blockUserFromComment

参数

名称	类型	位置	必需
tenantId	string	query	是
id	string	path	是
userId	string	query	否
anonUserId	string	query	否

响应

返回: BlockSuccess

示例

blockUserFromComment 示例

Copy

// 以下代码示例仍在测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let blockFromCommentParams = BlockFromCommentParams(commentIdsToCheck: ["commentIdsToCheck_example"]) // BlockFromCommentParams | 
let userId = "userId_example" // String |  (可选)
let anonUserId = "anonUserId_example" // String |  (可选)
DefaultAPI.blockUserFromComment(tenantId: tenantId, id: id, blockFromCommentParams: blockFromCommentParams, options: DefaultAPI.BlockUserFromCommentOptions(userId: userId, anonUserId: anonUserId)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

createCommentPublic

参数

名称	类型	位置	必填
tenantId	string	path	是
urlId	string	query	是
broadcastId	string	query	是
sessionId	string	query	否
sso	string	query	否
locale	string	query	否

响应

返回：SaveCommentsResponseWithPresence

示例

createCommentPublic 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let urlId = "urlId_example" // String | 
let broadcastId = "broadcastId_example" // String | 
let commentData = CommentData(date: 123, localDateString: "localDateString_example", localDateHours: 123, commenterName: "commenterName_example", commenterEmail: "commenterEmail_example", commenterLink: "commenterLink_example", comment: "comment_example", productId: 123, userId: "userId_example", avatarSrc: "avatarSrc_example", parentId: "parentId_example", mentions: [CommentUserMentionInfo(id: "id_example", tag: "tag_example", rawTag: "rawTag_example", type: "type_example", sent: false)], hashTags: [CommentUserHashTagInfo(id: "id_example", tag: "tag_example", url: "url_example", retain: false)], pageTitle: "pageTitle_example", isFromMyAccountPage: false, url: "url_example", urlId: "urlId_example", meta: 123, moderationGroupIds: ["moderationGroupIds_example"], rating: 123, fromOfflineRestore: false, autoplayDelayMS: 123, feedbackIds: ["feedbackIds_example"], questionValues: "TODO", poll: CommentPollInput(question: "question_example", options: ["options_example"], closesAt: "closesAt_example", privacy: 123, requireVoteToSeeResults: false), tos: false, botId: "botId_example") // CommentData | 
let sessionId = "sessionId_example" // String |  （可选）
let sso = "sso_example" // String |  （可选）
let locale = "locale_example" // String |  （可选）
PublicAPI.createCommentPublic(tenantId: tenantId, urlId: urlId, broadcastId: broadcastId, commentData: commentData, options: PublicAPI.CreateCommentPublicOptions(sessionId: sessionId, sso: sso, locale: locale)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deleteComment

参数

名称	类型	位置	必填
tenantId	string	query	Yes
id	string	path	Yes
contextUserId	string	query	No
isLive	boolean	query	No

响应

返回：DeleteCommentResult

示例

deleteComment 示例

Copy

// 以下代码示例仍处于测试阶段。若有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let contextUserId = "contextUserId_example" // String |  （可选）
let isLive = true // Bool |  （可选）
DefaultAPI.deleteComment(tenantId: tenantId, id: id, options: DefaultAPI.DeleteCommentOptions(contextUserId: contextUserId, isLive: isLive)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deleteCommentPublic

参数

名称	类型	位置	必需
tenantId	string	path	是
commentId	string	path	是
broadcastId	string	query	是
editKey	string	query	否
sso	string	query	否

响应

返回: PublicAPIDeleteCommentResponse

示例

deleteCommentPublic 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let broadcastId = "broadcastId_example" // String | 
let editKey = "editKey_example" // String |  （可选）
let sso = "sso_example" // String |  （可选）
PublicAPI.deleteCommentPublic(tenantId: tenantId, commentId: commentId, broadcastId: broadcastId, options: PublicAPI.DeleteCommentPublicOptions(editKey: editKey, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deleteCommentVote

参数

名称	类型	位置	必填
tenantId	string	path	Yes
commentId	string	path	Yes
voteId	string	path	Yes
urlId	string	query	Yes
broadcastId	string	query	Yes
editKey	string	query	No
sso	string	query	No

响应

返回：VoteDeleteResponse

示例

deleteCommentVote 示例

Copy

// 以下代码示例仍在 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let voteId = "voteId_example" // String | 
let urlId = "urlId_example" // String | 
let broadcastId = "broadcastId_example" // String | 
let editKey = "editKey_example" // String |  （可选）
let sso = "sso_example" // String |  （可选）
PublicAPI.deleteCommentVote(tenantId: tenantId, commentId: commentId, voteId: voteId, urlId: urlId, broadcastId: broadcastId, options: PublicAPI.DeleteCommentVoteOptions(editKey: editKey, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

flagComment

参数

名称	类型	位置	必需
tenantId	string	query	是
id	string	path	是
userId	string	query	否
anonUserId	string	query	否

响应

返回：FlagCommentResponse

示例

flagComment 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let userId = "userId_example" // String |  (可选)
let anonUserId = "anonUserId_example" // String |  (可选)
DefaultAPI.flagComment(tenantId: tenantId, id: id, options: DefaultAPI.FlagCommentOptions(userId: userId, anonUserId: anonUserId)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getComment

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
id	string	path	是

响应

返回: APIGetCommentResponse

示例

getComment 示例

Copy

// 以下代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
DefaultAPI.getComment(tenantId: tenantId, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getComments

参数

名称	类型	位置	必填
tenantId	string	query	是
page	integer	query	否
limit	integer	query	否
skip	integer	query	否
asTree	boolean	query	否
skipChildren	integer	query	否
limitChildren	integer	query	否
maxTreeDepth	integer	query	否
urlId	string	query	否
userId	string	query	否
anonUserId	string	query	否
contextUserId	string	query	否
hashTag	string	query	否
parentId	string	query	否
direction	string	query	否
fromDate	integer	query	否
toDate	integer	query	否

响应

返回：APIGetCommentsResponse

示例

获取评论示例

Copy

// 以下代码示例仍为 beta 版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let page = 987 // Int |  (可选)
let limit = 987 // Int |  (可选)
let skip = 987 // Int |  (可选)
let asTree = true // Bool |  (可选)
let skipChildren = 987 // Int |  (可选)
let limitChildren = 987 // Int |  (可选)
let maxTreeDepth = 987 // Int |  (可选)
let urlId = "urlId_example" // String |  (可选)
let userId = "userId_example" // String |  (可选)
let anonUserId = "anonUserId_example" // String |  (可选)
let contextUserId = "contextUserId_example" // String |  (可选)
let hashTag = "hashTag_example" // String |  (可选)
let parentId = "parentId_example" // String |  (可选)
let direction = SortDirections() // SortDirections |  (可选)
let fromDate = 987 // Int64 |  (可选)
let toDate = 987 // Int64 |  (可选)
DefaultAPI.getComments(tenantId: tenantId, options: DefaultAPI.GetCommentsOptions(page: page, limit: limit, skip: skip, asTree: asTree, skipChildren: skipChildren, limitChildren: limitChildren, maxTreeDepth: maxTreeDepth, urlId: urlId, userId: userId, anonUserId: anonUserId, contextUserId: contextUserId, hashTag: hashTag, parentId: parentId, direction: direction, fromDate: fromDate, toDate: toDate)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getCommentsPublic

req tenantId urlId

参数

名称	类型	位置	必填
tenantId	string	path	Yes
urlId	string	query	Yes
page	integer	query	No
direction	string	query	No
sso	string	query	No
skip	integer	query	No
skipChildren	integer	query	No
limit	integer	query	No
limitChildren	integer	query	No
countChildren	boolean	query	No
fetchPageForCommentId	string	query	No
includeConfig	boolean	query	No
countAll	boolean	query	No
includei10n	boolean	query	No
locale	string	query	No
modules	string	query	No
isCrawler	boolean	query	No
includeNotificationCount	boolean	query	No
asTree	boolean	query	No
maxTreeDepth	integer	query	No
useFullTranslationIds	boolean	query	No
parentId	string	query	No
searchText	string	query	No
hashTags	array	query	No
userId	string	query	No
customConfigStr	string	query	No
afterCommentId	string	query	No
beforeCommentId	string	query	No
questionId	string	query	No
questionValue	integer	query	No

响应

返回: GetCommentsResponseWithPresencePublicComment

示例

getCommentsPublic 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let urlId = "urlId_example" // String | 
let page = 987 // Int |  (optional)
let direction = SortDirections() // SortDirections |  (optional)
let sso = "sso_example" // String |  (optional)
let skip = 987 // Int |  (optional)
let skipChildren = 987 // Int |  (optional)
let limit = 987 // Int |  (optional)
let limitChildren = 987 // Int |  (optional)
let countChildren = true // Bool |  (optional)
let fetchPageForCommentId = "fetchPageForCommentId_example" // String |  (optional)
let includeConfig = true // Bool |  (optional)
let countAll = true // Bool |  (optional)
let includei10n = true // Bool |  (optional)
let locale = "locale_example" // String |  (optional)
let modules = "modules_example" // String |  (optional)
let isCrawler = true // Bool |  (optional)
let includeNotificationCount = true // Bool |  (optional)
let asTree = true // Bool |  (optional)
let maxTreeDepth = 987 // Int |  (optional)
let useFullTranslationIds = true // Bool |  (optional)
let parentId = "parentId_example" // String |  (optional)
let searchText = "searchText_example" // String |  (optional)
let hashTags = ["inner_example"] // [String] |  (optional)
let userId = "userId_example" // String |  (optional)
let customConfigStr = "customConfigStr_example" // String |  (optional)
let afterCommentId = "afterCommentId_example" // String |  (optional)
let beforeCommentId = "beforeCommentId_example" // String |  (optional)
let questionId = "questionId_example" // String |  (optional)
let questionValue = 987 // Int |  (optional)
PublicAPI.getCommentsPublic(tenantId: tenantId, urlId: urlId, options: PublicAPI.GetCommentsPublicOptions(page: page, direction: direction, sso: sso, skip: skip, skipChildren: skipChildren, limit: limit, limitChildren: limitChildren, countChildren: countChildren, fetchPageForCommentId: fetchPageForCommentId, includeConfig: includeConfig, countAll: countAll, includei10n: includei10n, locale: locale, modules: modules, isCrawler: isCrawler, includeNotificationCount: includeNotificationCount, asTree: asTree, maxTreeDepth: maxTreeDepth, useFullTranslationIds: useFullTranslationIds, parentId: parentId, searchText: searchText, hashTags: hashTags, userId: userId, customConfigStr: customConfigStr, afterCommentId: afterCommentId, beforeCommentId: beforeCommentId, questionId: questionId, questionValue: questionValue)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getCommentText

参数

名称	类型	位置	必需
tenantId	string	path	是
commentId	string	path	是
editKey	string	query	否
sso	string	query	否

响应

Returns: PublicAPIGetCommentTextResponse

示例

getCommentText 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let editKey = "editKey_example" // String |  (optional)
let sso = "sso_example" // String |  (optional)
PublicAPI.getCommentText(tenantId: tenantId, commentId: commentId, options: PublicAPI.GetCommentTextOptions(editKey: editKey, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getCommentVoteUserNames

参数

Name	Type	Location	Required
tenantId	string	path	是
commentId	string	path	是
dir	integer	query	是
sso	string	query	否

响应

返回: GetCommentVoteUserNamesSuccessResponse

示例

getCommentVoteUserNames 示例

Copy

// 以下代码示例仍在测试阶段。如遇任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let dir = 987 // Int | 
let sso = "sso_example" // String |  (可选)
PublicAPI.getCommentVoteUserNames(tenantId: tenantId, commentId: commentId, dir: dir, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

lockComment

参数

名称	类型	位置	必需
tenantId	string	path	是
commentId	string	path	是
broadcastId	string	query	是
sso	string	query	否

响应

返回: APIEmptyResponse

示例

lockComment 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let broadcastId = "broadcastId_example" // String | 
let sso = "sso_example" // String |  (可选)
PublicAPI.lockComment(tenantId: tenantId, commentId: commentId, broadcastId: broadcastId, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

pinComment

参数

名称	类型	位置	必填
tenantId	string	path	是
commentId	string	path	是
broadcastId	string	query	是
sso	string	query	否

响应

返回: ChangeCommentPinStatusResponse

示例

pinComment 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let broadcastId = "broadcastId_example" // String | 
let sso = "sso_example" // String |  (可选)
PublicAPI.pinComment(tenantId: tenantId, commentId: commentId, broadcastId: broadcastId, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

saveComment

参数

名称	类型	位置	必填
tenantId	string	query	Yes
isLive	boolean	query	No
doSpamCheck	boolean	query	No
sendEmails	boolean	query	No
populateNotifications	boolean	query	No

响应

返回: APISaveCommentResponse

示例

saveComment 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let createCommentParams = CreateCommentParams(date: 123, localDateString: "localDateString_example", localDateHours: 123, commenterName: "commenterName_example", commenterEmail: "commenterEmail_example", commenterLink: "commenterLink_example", comment: "comment_example", productId: 123, userId: "userId_example", avatarSrc: "avatarSrc_example", parentId: "parentId_example", mentions: [CommentUserMentionInfo(id: "id_example", tag: "tag_example", rawTag: "rawTag_example", type: "type_example", sent: false)], hashTags: [CommentUserHashTagInfo(id: "id_example", tag: "tag_example", url: "url_example", retain: false)], pageTitle: "pageTitle_example", isFromMyAccountPage: false, url: "url_example", urlId: "urlId_example", meta: 123, moderationGroupIds: ["moderationGroupIds_example"], rating: 123, fromOfflineRestore: false, autoplayDelayMS: 123, feedbackIds: ["feedbackIds_example"], questionValues: "TODO", poll: CommentPollInput(question: "question_example", options: ["options_example"], closesAt: "closesAt_example", privacy: 123, requireVoteToSeeResults: false), tos: false, botId: "botId_example", approved: false, domain: "domain_example", ip: "ip_example", isPinned: false, locale: "locale_example", reviewed: false, verified: false, votes: 123, votesDown: 123, votesUp: 123) // CreateCommentParams | 
let isLive = true // Bool |  (optional)
let doSpamCheck = true // Bool |  (optional)
let sendEmails = true // Bool |  (optional)
let populateNotifications = true // Bool |  (optional)
DefaultAPI.saveComment(tenantId: tenantId, createCommentParams: createCommentParams, options: DefaultAPI.SaveCommentOptions(isLive: isLive, doSpamCheck: doSpamCheck, sendEmails: sendEmails, populateNotifications: populateNotifications)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

saveCommentsBulk

参数

名称	类型	位置	必填
tenantId	string	query	Yes
isLive	boolean	query	No
doSpamCheck	boolean	query	No
sendEmails	boolean	query	No
populateNotifications	boolean	query	No

响应

返回：[SaveCommentsBulkResponse]

示例

saveCommentsBulk 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告。
import FastCommentsSwift
let tenantId = "tenantId_example" // 字符串 | 
let createCommentParams = [CreateCommentParams(date: 123, localDateString: "localDateString_example", localDateHours: 123, commenterName: "commenterName_example", commenterEmail: "commenterEmail_example", commenterLink: "commenterLink_example", comment: "comment_example", productId: 123, userId: "userId_example", avatarSrc: "avatarSrc_example", parentId: "parentId_example", mentions: [CommentUserMentionInfo(id: "id_example", tag: "tag_example", rawTag: "rawTag_example", type: "type_example", sent: false)], hashTags: [CommentUserHashTagInfo(id: "id_example", tag: "tag_example", url: "url_example", retain: false)], pageTitle: "pageTitle_example", isFromMyAccountPage: false, url: "url_example", urlId: "urlId_example", meta: 123, moderationGroupIds: ["moderationGroupIds_example"], rating: 123, fromOfflineRestore: false, autoplayDelayMS: 123, feedbackIds: ["feedbackIds_example"], questionValues: "TODO", poll: CommentPollInput(question: "question_example", options: ["options_example"], closesAt: "closesAt_example", privacy: 123, requireVoteToSeeResults: false), tos: false, botId: "botId_example", approved: false, domain: "domain_example", ip: "ip_example", isPinned: false, locale: "locale_example", reviewed: false, verified: false, votes: 123, votesDown: 123, votesUp: 123)] // [CreateCommentParams] | 
let isLive = true // 布尔 |  (optional)
let doSpamCheck = true // 布尔 |  (optional)
let sendEmails = true // 布尔 |  (optional)
let populateNotifications = true // 布尔 |  (optional)
DefaultAPI.saveCommentsBulk(tenantId: tenantId, createCommentParams: createCommentParams, options: DefaultAPI.SaveCommentsBulkOptions(isLive: isLive, doSpamCheck: doSpamCheck, sendEmails: sendEmails, populateNotifications: populateNotifications)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

setCommentText

参数

名称	类型	位置	必需
tenantId	string	path	是
commentId	string	path	是
broadcastId	string	query	是
editKey	string	query	否
sso	string	query	否

响应

返回: PublicAPISetCommentTextResponse

示例

setCommentText 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let broadcastId = "broadcastId_example" // String | 
let commentTextUpdateRequest = CommentTextUpdateRequest(comment: "comment_example", mentions: [CommentUserMentionInfo(id: "id_example", tag: "tag_example", rawTag: "rawTag_example", type: "type_example", sent: false)], hashTags: [CommentUserHashTagInfo(id: "id_example", tag: "tag_example", url: "url_example", retain: false)]) // CommentTextUpdateRequest | 
let editKey = "editKey_example" // String |  (可选)
let sso = "sso_example" // String |  (可选)
PublicAPI.setCommentText(tenantId: tenantId, commentId: commentId, broadcastId: broadcastId, commentTextUpdateRequest: commentTextUpdateRequest, options: PublicAPI.SetCommentTextOptions(editKey: editKey, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

translateComments

将给定的评论翻译为小部件的语言环境。仅在匹配的小部件自定义规则将“评论翻译”设置为自动或手动时可用。

参数

名称	类型	位置	必填
tenantId	string	path	是
urlId	string	query	是
sso	string	query	否
locale	string	query	否

响应

Returns: CommentTranslationsResponse

示例

translateComments 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let urlId = "urlId_example" // String | 
let commentTranslationsRequest = CommentTranslationsRequest(commentIds: ["commentIds_example"]) // CommentTranslationsRequest | 
let sso = "sso_example" // String |  （可选）
let locale = "locale_example" // String |  （可选）
PublicAPI.translateComments(tenantId: tenantId, urlId: urlId, commentTranslationsRequest: commentTranslationsRequest, options: PublicAPI.TranslateCommentsOptions(sso: sso, locale: locale)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

unBlockUserFromComment

参数

名称	类型	位置	必填
tenantId	string	query	是
id	string	path	是
userId	string	query	否
anonUserId	string	query	否

响应

返回：UnblockSuccess

示例

unBlockUserFromComment 示例

Copy

// 以下代码示例仍为 beta 版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let unBlockFromCommentParams = UnBlockFromCommentParams(commentIdsToCheck: ["commentIdsToCheck_example"]) // UnBlockFromCommentParams | 
let userId = "userId_example" // String |  (可选)
let anonUserId = "anonUserId_example" // String |  (可选)
DefaultAPI.unBlockUserFromComment(tenantId: tenantId, id: id, unBlockFromCommentParams: unBlockFromCommentParams, options: DefaultAPI.UnBlockUserFromCommentOptions(userId: userId, anonUserId: anonUserId)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

unFlagComment

参数

名称	类型	位置	必需
tenantId	string	query	是
id	string	path	是
userId	string	query	否
anonUserId	string	query	否

响应

返回：FlagCommentResponse

示例

unFlagComment 示例

Copy

// 以下代码示例仍处于 beta 版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let userId = "userId_example" // String |  (可选)
let anonUserId = "anonUserId_example" // String |  (可选)
DefaultAPI.unFlagComment(tenantId: tenantId, id: id, options: DefaultAPI.UnFlagCommentOptions(userId: userId, anonUserId: anonUserId)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

unLockComment

参数

名称	类型	位置	必填
tenantId	string	path	是
commentId	string	path	是
broadcastId	string	query	是
sso	string	query	否

响应

返回: APIEmptyResponse

示例

unLockComment 示例

Copy

// 以下代码示例仍处于测试版。若有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let broadcastId = "broadcastId_example" // String | 
let sso = "sso_example" // String |  (可选)
PublicAPI.unLockComment(tenantId: tenantId, commentId: commentId, broadcastId: broadcastId, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

unPinComment

参数

名称	类型	位置	必需
tenantId	string	path	是
commentId	string	path	是
broadcastId	string	query	是
sso	string	query	否

响应

返回：ChangeCommentPinStatusResponse

示例

unPinComment 示例

Copy

// 以下代码示例仍为测试版。如遇任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // 字符串 | 
let commentId = "commentId_example" // 字符串 | 
let broadcastId = "broadcastId_example" // 字符串 | 
let sso = "sso_example" // 字符串 |  (可选)
PublicAPI.unPinComment(tenantId: tenantId, commentId: commentId, broadcastId: broadcastId, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

updateComment

参数

名称	类型	位置	必填
tenantId	string	query	是
id	string	path	是
contextUserId	string	query	否
doSpamCheck	boolean	query	否
isLive	boolean	query	否

响应

返回: APIEmptyResponse

示例

updateComment 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let updatableCommentParams = UpdatableCommentParams(urlId: "urlId_example", urlIdRaw: "urlIdRaw_example", url: "url_example", pageTitle: "pageTitle_example", userId: "userId_example", commenterEmail: "commenterEmail_example", commenterName: "commenterName_example", commenterLink: "commenterLink_example", comment: "comment_example", commentHTML: "commentHTML_example", parentId: "parentId_example", date: 123, localDateString: "localDateString_example", localDateHours: 123, votes: 123, votesUp: 123, votesDown: 123, expireAt: Date(), verified: false, verifiedDate: Date(), notificationSentForParent: false, notificationSentForParentTenant: false, reviewed: false, externalId: "externalId_example", externalParentId: "externalParentId_example", avatarSrc: "avatarSrc_example", isSpam: false, approved: false, isDeleted: false, isDeletedUser: false, isByAdmin: false, isByModerator: false, isPinned: false, isLocked: false, flagCount: 123, displayLabel: "displayLabel_example", meta: APICommentBase_meta(wpUserId: "wpUserId_example", wpPostId: "wpPostId_example"), moderationGroupIds: ["moderationGroupIds_example"], feedbackIds: ["feedbackIds_example"]) // UpdatableCommentParams | 
let contextUserId = "contextUserId_example" // String |  (optional)
let doSpamCheck = true // Bool |  (optional)
let isLive = true // Bool |  (optional)
DefaultAPI.updateComment(tenantId: tenantId, id: id, updatableCommentParams: updatableCommentParams, options: DefaultAPI.UpdateCommentOptions(contextUserId: contextUserId, doSpamCheck: doSpamCheck, isLive: isLive)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

voteComment

参数

名称	类型	位置	必填
tenantId	string	path	Yes
commentId	string	path	Yes
urlId	string	query	Yes
broadcastId	string	query	Yes
sessionId	string	query	No
sso	string	query	No

响应

返回：VoteResponse

示例

voteComment 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String |
let commentId = "commentId_example" // String |
let urlId = "urlId_example" // String |
let broadcastId = "broadcastId_example" // String |
let voteBodyParams = VoteBodyParams(commenterEmail: "commenterEmail_example", commenterName: "commenterName_example", voteDir: "voteDir_example", url: "url_example") // VoteBodyParams |
let sessionId = "sessionId_example" // String |  (可选)
let sso = "sso_example" // String |  (可选)
PublicAPI.voteComment(tenantId: tenantId, commentId: commentId, urlId: urlId, broadcastId: broadcastId, voteBodyParams: voteBodyParams, options: PublicAPI.VoteCommentOptions(sessionId: sessionId, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getCommentsForUser

参数

名称	类型	位置	必需
userId	string	query	否
direction	string	query	否
repliesToUserId	string	query	否
page	number	query	否
includei10n	boolean	query	否
locale	string	query	否
isCrawler	boolean	query	否

响应

返回：GetCommentsForUserResponse

示例

getCommentsForUser 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 提交报告
import FastCommentsSwift
let userId = "userId_example" // String |  (可选)
let direction = SortDirections() // SortDirections |  (可选)
let repliesToUserId = "repliesToUserId_example" // String |  (可选)
let page = 987 // Double |  (可选)
let includei10n = true // Bool |  (可选)
let locale = "locale_example" // String |  (可选)
let isCrawler = true // Bool |  (可选)
PublicAPI.getCommentsForUser(options: PublicAPI.GetCommentsForUserOptions(userId: userId, direction: direction, repliesToUserId: repliesToUserId, page: page, includei10n: includei10n, locale: locale, isCrawler: isCrawler)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

addDomainConfig

参数

名称	类型	位置	必填	描述
tenantId	string	query	是

响应

返回: AddDomainConfigResponse

示例

addDomainConfig 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let addDomainConfigParams = AddDomainConfigParams(domain: "domain_example", emailFromName: "emailFromName_example", emailFromEmail: "emailFromEmail_example", logoSrc: "logoSrc_example", logoSrc100px: "logoSrc100px_example", footerUnsubscribeURL: "footerUnsubscribeURL_example", emailHeaders: "TODO") // AddDomainConfigParams | 
DefaultAPI.addDomainConfig(tenantId: tenantId, addDomainConfigParams: addDomainConfigParams) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deleteDomainConfig

参数

Name	Type	Location	Required	Description
tenantId	string	query	是
domain	string	path	是

响应

返回: DeleteDomainConfigResponse

示例

deleteDomainConfig 示例

Copy

// 以下代码示例仍为测试版。如遇问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let domain = "domain_example" // String | 
DefaultAPI.deleteDomainConfig(tenantId: tenantId, domain: domain) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getDomainConfig

参数

Name	Type	Location	Required	Description
tenantId	string	query	是
domain	string	path	是

响应

返回： GetDomainConfigResponse

示例

getDomainConfig 示例

Copy

// 以下代码示例仍处于测试阶段。如有问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // 字符串 | 
let domain = "domain_example" // 字符串 | 
DefaultAPI.getDomainConfig(tenantId: tenantId, domain: domain) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getDomainConfigs

参数

名称	类型	位置	必填	描述
tenantId	string	query	是

响应

返回: GetDomainConfigsResponse

示例

getDomainConfigs 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
DefaultAPI.getDomainConfigs(tenantId: tenantId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

patchDomainConfig

参数

Name	Type	Location	Required	Description
tenantId	string	query	Yes
domainToUpdate	string	path	Yes

响应

返回: PatchDomainConfigResponse

示例

patchDomainConfig 示例

Copy

// 以下代码示例仍处于测试版。如遇任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let domainToUpdate = "domainToUpdate_example" // String | 
let patchDomainConfigParams = PatchDomainConfigParams(domain: "domain_example", emailFromName: "emailFromName_example", emailFromEmail: "emailFromEmail_example", logoSrc: "logoSrc_example", logoSrc100px: "logoSrc100px_example", footerUnsubscribeURL: "footerUnsubscribeURL_example", emailHeaders: "TODO") // PatchDomainConfigParams | 
DefaultAPI.patchDomainConfig(tenantId: tenantId, domainToUpdate: domainToUpdate, patchDomainConfigParams: patchDomainConfigParams) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

putDomainConfig

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
domainToUpdate	string	path	是

返回：PutDomainConfigResponse

示例

putDomainConfig 示例

Copy

// 以下代码示例仍处于测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let domainToUpdate = "domainToUpdate_example" // String | 
let updateDomainConfigParams = UpdateDomainConfigParams(domain: "domain_example", emailFromName: "emailFromName_example", emailFromEmail: "emailFromEmail_example", logoSrc: "logoSrc_example", logoSrc100px: "logoSrc100px_example", footerUnsubscribeURL: "footerUnsubscribeURL_example", emailHeaders: "TODO") // UpdateDomainConfigParams | 
DefaultAPI.putDomainConfig(tenantId: tenantId, domainToUpdate: domainToUpdate, updateDomainConfigParams: updateDomainConfigParams) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

createEmailTemplate

参数

Name	Type	Location	Required	Description
tenantId	string	query	是

响应

返回: CreateEmailTemplateResponse

示例

createEmailTemplate 示例

Copy

// 以下代码示例仍处于测试阶段。如遇任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let createEmailTemplateBody = CreateEmailTemplateBody(emailTemplateId: "emailTemplateId_example", displayName: "displayName_example", ejs: "ejs_example", domain: "domain_example", translationOverridesByLocale: "TODO", testData: "TODO") // CreateEmailTemplateBody | 
DefaultAPI.createEmailTemplate(tenantId: tenantId, createEmailTemplateBody: createEmailTemplateBody) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deleteEmailTemplate

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
id	string	path	是

Response

返回: APIEmptyResponse

示例

deleteEmailTemplate 示例

Copy

// 以下代码示例仍处于测试阶段。如有问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
DefaultAPI.deleteEmailTemplate(tenantId: tenantId, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deleteEmailTemplateRenderError

参数

Name	Type	Location	Required
tenantId	string	query	是
id	string	path	是
errorId	string	path	是

响应

返回：APIEmptyResponse

示例

deleteEmailTemplateRenderError 示例

Copy

// 以下代码示例仍处于测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let errorId = "errorId_example" // String | 
DefaultAPI.deleteEmailTemplateRenderError(tenantId: tenantId, id: id, errorId: errorId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getEmailTemplate

参数

名称	类型	位置	是否必需	描述
tenantId	string	query	是
id	string	path	是

响应

返回: GetEmailTemplateResponse

示例

getEmailTemplate 示例

Copy

// 下面的代码示例仍处于测试阶段。如有问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
DefaultAPI.getEmailTemplate(tenantId: tenantId, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getEmailTemplateDefinitions

参数

名称	类型	位置	必填	描述
tenantId	string	query	是

响应

返回: GetEmailTemplateDefinitionsResponse

示例

getEmailTemplateDefinitions 示例

Copy

// 以下代码示例仍为测试版。如遇到任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
DefaultAPI.getEmailTemplateDefinitions(tenantId: tenantId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getEmailTemplateRenderErrors

参数

Name	Type	Location	Required
tenantId	string	query	是
id	string	path	是
skip	number	query	否

响应

返回: GetEmailTemplateRenderErrorsResponse

示例

getEmailTemplateRenderErrors 示例

Copy

// 以下代码示例仍处于测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let skip = 987 // Double |  (可选)
DefaultAPI.getEmailTemplateRenderErrors(tenantId: tenantId, id: id, skip: skip) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getEmailTemplates

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
skip	number	query	否

响应

返回：GetEmailTemplatesResponse

示例

getEmailTemplates 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let skip = 987 // Double |  (可选)
DefaultAPI.getEmailTemplates(tenantId: tenantId, skip: skip) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

renderEmailTemplate

参数

Name	Type	Location	Required	Description
tenantId	string	query	是
locale	string	query	否

响应

返回: RenderEmailTemplateResponse

示例

renderEmailTemplate 示例

Copy

// 以下代码示例仍处于测试版。如有问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let renderEmailTemplateBody = RenderEmailTemplateBody(emailTemplateId: "emailTemplateId_example", ejs: "ejs_example", testData: "TODO", translationOverridesByLocale: "TODO") // RenderEmailTemplateBody | 
let locale = "locale_example" // String |  (可选)
DefaultAPI.renderEmailTemplate(tenantId: tenantId, renderEmailTemplateBody: renderEmailTemplateBody, locale: locale) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

updateEmailTemplate

参数

Name	Type	Location	Required	Description
tenantId	string	query	是
id	string	path	是

响应

返回: APIEmptyResponse

示例

updateEmailTemplate 示例

Copy

// 以下代码示例仍处于测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let updateEmailTemplateBody = UpdateEmailTemplateBody(emailTemplateId: "emailTemplateId_example", displayName: "displayName_example", ejs: "ejs_example", domain: "domain_example", translationOverridesByLocale: "TODO", testData: "TODO") // UpdateEmailTemplateBody | 
DefaultAPI.updateEmailTemplate(tenantId: tenantId, id: id, updateEmailTemplateBody: updateEmailTemplateBody) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getEventLog

req tenantId urlId userIdWS

参数

Name	Type	Location	Required
tenantId	string	path	是
urlId	string	query	是
userIdWS	string	query	是
startTime	integer	query	是
endTime	integer	query	否

Response

返回: GetEventLogResponse

示例

getEventLog 示例

Copy

// 以下代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let urlId = "urlId_example" // String | 
let userIdWS = "userIdWS_example" // String | 
let startTime = 987 // Int64 | 
let endTime = 987 // Int64 |  (可选)
PublicAPI.getEventLog(tenantId: tenantId, urlId: urlId, userIdWS: userIdWS, startTime: startTime, endTime: endTime) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getGlobalEventLog

req tenantId urlId userIdWS

参数

Name	Type	Location	Required
tenantId	string	path	是
urlId	string	query	是
userIdWS	string	query	是
startTime	integer	query	是
endTime	integer	query	否

响应

返回: GetEventLogResponse

示例

getGlobalEventLog 示例

Copy

// 以下代码示例仍处于测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let urlId = "urlId_example" // String | 
let userIdWS = "userIdWS_example" // String | 
let startTime = 987 // Int64 | 
let endTime = 987 // Int64 |  (可选)
PublicAPI.getGlobalEventLog(tenantId: tenantId, urlId: urlId, userIdWS: userIdWS, startTime: startTime, endTime: endTime) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

createFeedPost

参数

名称	类型	位置	必需
tenantId	string	query	Yes
broadcastId	string	query	No
isLive	boolean	query	No
doSpamCheck	boolean	query	No
skipDupCheck	boolean	query	No

响应

返回：CreateFeedPostsResponse

示例

createFeedPost 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let createFeedPostParams = CreateFeedPostParams(title: "title_example", contentHTML: "contentHTML_example", media: [FeedPostMediaItem(title: "title_example", linkUrl: "linkUrl_example", sizes: [FeedPostMediaItemAsset(w: 123, h: 123, src: "src_example")])], links: [FeedPostLink(text: "text_example", title: "title_example", description: "description_example", url: "url_example")], fromUserId: "fromUserId_example", fromUserDisplayName: "fromUserDisplayName_example", tags: ["tags_example"], meta: "TODO") // CreateFeedPostParams | 
let broadcastId = "broadcastId_example" // String |  （可选）
let isLive = true // Bool |  （可选）
let doSpamCheck = true // Bool |  （可选）
let skipDupCheck = true // Bool |  （可选）
DefaultAPI.createFeedPost(tenantId: tenantId, createFeedPostParams: createFeedPostParams, options: DefaultAPI.CreateFeedPostOptions(broadcastId: broadcastId, isLive: isLive, doSpamCheck: doSpamCheck, skipDupCheck: skipDupCheck)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

createFeedPostPublic

参数

名称	类型	位置	必填
tenantId	string	path	是
broadcastId	string	query	否
sso	string	query	否

响应

返回：CreateFeedPostResponse

示例

createFeedPostPublic 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let createFeedPostParams = CreateFeedPostParams(title: "title_example", contentHTML: "contentHTML_example", media: [FeedPostMediaItem(title: "title_example", linkUrl: "linkUrl_example", sizes: [FeedPostMediaItemAsset(w: 123, h: 123, src: "src_example")])], links: [FeedPostLink(text: "text_example", title: "title_example", description: "description_example", url: "url_example")], fromUserId: "fromUserId_example", fromUserDisplayName: "fromUserDisplayName_example", tags: ["tags_example"], meta: "TODO") // CreateFeedPostParams | 
let broadcastId = "broadcastId_example" // String |  (可选)
let sso = "sso_example" // String |  (可选)
PublicAPI.createFeedPostPublic(tenantId: tenantId, createFeedPostParams: createFeedPostParams, options: PublicAPI.CreateFeedPostPublicOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deleteFeedPostPublic

参数

名称	类型	位置	必填
tenantId	string	path	是
postId	string	path	是
broadcastId	string	query	否
sso	string	query	否

响应

返回：DeleteFeedPostPublicResponse

示例

deleteFeedPostPublic 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告。
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let postId = "postId_example" // String | 
let broadcastId = "broadcastId_example" // String |  （可选）
let sso = "sso_example" // String |  （可选）
PublicAPI.deleteFeedPostPublic(tenantId: tenantId, postId: postId, options: PublicAPI.DeleteFeedPostPublicOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getFeedPosts

请求
tenantId
afterId

参数

名称	类型	位置	必需
tenantId	string	query	Yes
afterId	string	query	No
limit	integer	query	No
tags	array	query	No

响应

返回：GetFeedPostsResponse

示例

getFeedPosts 示例

Copy

// 以下代码示例仍处于测试阶段。若有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let afterId = "afterId_example" // String |  （可选）
let limit = 987 // Int |  （可选）
let tags = ["inner_example"] // [String] |  （可选）
DefaultAPI.getFeedPosts(tenantId: tenantId, options: DefaultAPI.GetFeedPostsOptions(afterId: afterId, limit: limit, tags: tags)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getFeedPostsPublic

req tenantId afterId

参数

Name	Type	Location	Required
tenantId	string	path	是
afterId	string	query	否
limit	integer	query	否
tags	array	query	否
sso	string	query	否
isCrawler	boolean	query	否
includeUserInfo	boolean	query	否

响应

返回：PublicFeedPostsResponse

示例

getFeedPostsPublic 示例

Copy

// 以下代码示例仍为 beta 版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告。
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let afterId = "afterId_example" // String |  (可选)
let limit = 987 // Int |  (可选)
let tags = ["inner_example"] // [String] |  (可选)
let sso = "sso_example" // String |  (可选)
let isCrawler = true // Bool |  (可选)
let includeUserInfo = true // Bool |  (可选)
PublicAPI.getFeedPostsPublic(tenantId: tenantId, options: PublicAPI.GetFeedPostsPublicOptions(afterId: afterId, limit: limit, tags: tags, sso: sso, isCrawler: isCrawler, includeUserInfo: includeUserInfo)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getFeedPostsStats

参数

Name	Type	Location	Required
tenantId	string	path	是
postIds	array	query	是
sso	string	query	否

响应

返回: FeedPostsStatsResponse

示例

getFeedPostsStats 示例

Copy

// 以下代码示例仍处于测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let postIds = ["inner_example"] // [String] | 
let sso = "sso_example" // String |  (可选)
PublicAPI.getFeedPostsStats(tenantId: tenantId, postIds: postIds, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getUserReactsPublic

参数

名称	类型	位置	必填
tenantId	string	path	Yes
postIds	array	query	No
sso	string	query	No

响应

返回：UserReactsResponse

示例

getUserReactsPublic 示例

Copy

// 以下代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let postIds = ["inner_example"] // [String] |  （可选）
let sso = "sso_example" // String |  （可选）
PublicAPI.getUserReactsPublic(tenantId: tenantId, options: PublicAPI.GetUserReactsPublicOptions(postIds: postIds, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

reactFeedPostPublic

参数

名称	类型	位置	必需
tenantId	string	path	是
postId	string	path	是
isUndo	boolean	query	否
broadcastId	string	query	否
sso	string	query	否

响应

返回: ReactFeedPostResponse

示例

reactFeedPostPublic 示例

Copy

// 以下代码示例仍为测试版。如有问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let postId = "postId_example" // String | 
let reactBodyParams = ReactBodyParams(reactType: "reactType_example") // ReactBodyParams | 
let isUndo = true // Bool |  (optional)
let broadcastId = "broadcastId_example" // String |  (optional)
let sso = "sso_example" // String |  (optional)
PublicAPI.reactFeedPostPublic(tenantId: tenantId, postId: postId, reactBodyParams: reactBodyParams, options: PublicAPI.ReactFeedPostPublicOptions(isUndo: isUndo, broadcastId: broadcastId, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

updateFeedPost

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
id	string	path	是

响应

返回：APIEmptyResponse

示例

updateFeedPost 示例

Copy

// 以下代码示例仍处于测试版。若遇到任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let feedPost = FeedPost(id: "id_example", tenantId: "tenantId_example", title: "title_example", fromUserId: "fromUserId_example", fromUserDisplayName: "fromUserDisplayName_example", fromUserAvatar: "fromUserAvatar_example", fromIpHash: "fromIpHash_example", tags: ["tags_example"], weight: 123, meta: "TODO", contentHTML: "contentHTML_example", media: [FeedPostMediaItem(title: "title_example", linkUrl: "linkUrl_example", sizes: [FeedPostMediaItemAsset(w: 123, h: 123, src: "src_example")])], links: [FeedPostLink(text: "text_example", title: "title_example", description: "description_example", url: "url_example")], createdAt: Date(), reacts: "TODO", commentCount: 123) // FeedPost | 
DefaultAPI.updateFeedPost(tenantId: tenantId, id: id, feedPost: feedPost) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

updateFeedPostPublic

参数

名称	类型	位置	必需
tenantId	string	path	是
postId	string	path	是
broadcastId	string	query	否
sso	string	query	否

响应

返回：CreateFeedPostResponse

示例

updateFeedPostPublic 示例

Copy

// 以下代码示例仍在测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let postId = "postId_example" // String | 
let updateFeedPostParams = UpdateFeedPostParams(title: "title_example", contentHTML: "contentHTML_example", media: [FeedPostMediaItem(title: "title_example", linkUrl: "linkUrl_example", sizes: [FeedPostMediaItemAsset(w: 123, h: 123, src: "src_example")])], links: [FeedPostLink(text: "text_example", title: "title_example", description: "description_example", url: "url_example")], tags: ["tags_example"], meta: "TODO") // UpdateFeedPostParams | 
let broadcastId = "broadcastId_example" // String |  (optional)
let sso = "sso_example" // String |  (optional)
PublicAPI.updateFeedPostPublic(tenantId: tenantId, postId: postId, updateFeedPostParams: updateFeedPostParams, options: PublicAPI.UpdateFeedPostPublicOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

flagCommentPublic

参数

名称	类型	位置	必需
tenantId	string	query	是
commentId	string	path	是
isFlagged	boolean	query	是
sso	string	query	否

响应

返回: APIEmptyResponse

示例

flagCommentPublic 示例

Copy

// 以下代码示例仍处于测试阶段。如遇任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let isFlagged = true // Bool | 
let sso = "sso_example" // String |  (可选)
PublicAPI.flagCommentPublic(tenantId: tenantId, commentId: commentId, isFlagged: isFlagged, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getGifLarge

参数

Name	Type	Location	Required	Description
tenantId	string	path	是
largeInternalURLSanitized	string	query	是

响应

返回：GifGetLargeResponse

示例

getGifLarge 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let largeInternalURLSanitized = "largeInternalURLSanitized_example" // String | 
PublicAPI.getGifLarge(tenantId: tenantId, largeInternalURLSanitized: largeInternalURLSanitized) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getGifsSearch

参数

名称	类型	位置	必填
tenantId	string	路径	是
search	string	查询	是
locale	string	查询	否
rating	string	查询	否
page	number	查询	否

响应

返回：GetGifsSearchResponse

示例

getGifsSearch 示例

Copy

// 以下代码示例仍处于 beta 版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let search = "search_example" // String | 
let locale = "locale_example" // String |  (可选)
let rating = "rating_example" // String |  (可选)
let page = 987 // Double |  (可选)
PublicAPI.getGifsSearch(tenantId: tenantId, search: search, options: PublicAPI.GetGifsSearchOptions(locale: locale, rating: rating, page: page)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getGifsTrending

参数

名称	类型	位置	必填
tenantId	string	path	是
locale	string	query	否
rating	string	query	否
page	number	query	否

响应

返回：GetGifsTrendingResponse

示例

getGifsTrending 示例

Copy

// 以下代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let locale = "locale_example" // String |  (可选)
let rating = "rating_example" // String |  (可选)
let page = 987 // Double |  (可选)
PublicAPI.getGifsTrending(tenantId: tenantId, options: PublicAPI.GetGifsTrendingOptions(locale: locale, rating: rating, page: page)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

addHashTag

参数

Name	Type	Location	Required	Description
tenantId	string	query	Yes

响应

返回: CreateHashTagResponse

示例

addHashTag 示例

Copy

// 以下代码示例仍处于 beta 版。如果有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let createHashTagBody = CreateHashTagBody(tenantId: "tenantId_example", tag: "tag_example", url: "url_example") // CreateHashTagBody |  (可选)
DefaultAPI.addHashTag(tenantId: tenantId, createHashTagBody: createHashTagBody) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

addHashTagsBulk

参数

名称	类型	位置	必填	描述
tenantId	string	query	是

响应

返回：BulkCreateHashTagsResponse

示例

addHashTagsBulk 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let bulkCreateHashTagsBody = BulkCreateHashTagsBody(tenantId: "tenantId_example", tags: [BulkCreateHashTagsBody_tags_inner(url: "url_example", tag: "tag_example")]) // BulkCreateHashTagsBody |  (optional)
DefaultAPI.addHashTagsBulk(tenantId: tenantId, bulkCreateHashTagsBody: bulkCreateHashTagsBody) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deleteHashTag

参数

名称	类型	位置	必填	描述
tenantId	string	query	Yes
tag	string	path	Yes

响应

返回：APIEmptyResponse

示例

deleteHashTag 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let tag = "tag_example" // String | 
let deleteHashTagRequestBody = DeleteHashTagRequestBody(tenantId: "tenantId_example") // DeleteHashTagRequestBody |  (optional)
DefaultAPI.deleteHashTag(tenantId: tenantId, tag: tag, deleteHashTagRequestBody: deleteHashTagRequestBody) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getHashTags

参数

Name	Type	Location	Required	Description
tenantId	string	query	是
page	number	query	否

响应

返回: GetHashTagsResponse

示例

getHashTags 示例

Copy

// 以下代码示例仍处于测试阶段。如有问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let page = 987 // Double |  (可选)
DefaultAPI.getHashTags(tenantId: tenantId, page: page) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

patchHashTag

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
tag	string	path	是

响应

返回: UpdateHashTagResponse

示例

patchHashTag 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let tag = "tag_example" // String | 
let updateHashTagBody = UpdateHashTagBody(tenantId: "tenantId_example", url: "url_example", tag: "tag_example") // UpdateHashTagBody | (可选)
DefaultAPI.patchHashTag(tenantId: tenantId, tag: tag, updateHashTagBody: updateHashTagBody) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getMe

标识当前使用的凭据：其所属的租户，以及（对于 OAuth 令牌）授权该令牌的用户。集成使用此接口来测试连接并为其添加标签。

参数

名称	类型	位置	必填	描述
tenantId	string	query	是

响应

返回：GetMeResponse

示例

getMe 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
DefaultAPI.getMe(tenantId: tenantId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deleteModerationVote

参数

名称	类型	位置	必需
tenantId	string	query	是
commentId	string	path	是
voteId	string	path	是
broadcastId	string	query	否
sso	string	query	否

响应

返回：VoteDeleteResponse

示例

deleteModerationVote 示例

Copy

// 以下代码示例仍为 Beta 版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let voteId = "voteId_example" // String | 
let broadcastId = "broadcastId_example" // String |  (可选)
let sso = "sso_example" // String |  (可选)
ModerationAPI.deleteModerationVote(tenantId: tenantId, commentId: commentId, voteId: voteId, options: ModerationAPI.DeleteModerationVoteOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getApiComments

参数

名称	类型	位置	必填
tenantId	string	查询	是
page	number	查询	否
count	number	查询	否
text-search	string	查询	否
byIPFromComment	string	查询	否
filters	string	查询	否
searchFilters	string	查询	否
sorts	string	查询	否
demo	boolean	查询	否
sso	string	查询	否

响应

返回：ModerationAPIGetCommentsResponse

示例

getApiComments 示例

Copy

// 以下代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let page = 987 // Double |  (optional)
let count = 987 // Double |  (optional)
let textSearch = "textSearch_example" // String |  (optional)
let byIPFromComment = "byIPFromComment_example" // String |  (optional)
let filters = "filters_example" // String |  (optional)
let searchFilters = "searchFilters_example" // String |  (optional)
let sorts = "sorts_example" // String |  (optional)
let demo = true // Bool |  (optional)
let sso = "sso_example" // String |  (optional)
ModerationAPI.getApiComments(tenantId: tenantId, options: ModerationAPI.GetApiCommentsOptions(page: page, count: count, textSearch: textSearch, byIPFromComment: byIPFromComment, filters: filters, searchFilters: searchFilters, sorts: sorts, demo: demo, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getApiExportStatus

参数

名称	类型	位置	必填
tenantId	string	query	是
batchJobId	string	query	否
sso	string	query	否

响应

返回: ModerationExportStatusResponse

示例

getApiExportStatus 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let batchJobId = "batchJobId_example" // String |  (可选)
let sso = "sso_example" // String |  (可选)
ModerationAPI.getApiExportStatus(tenantId: tenantId, options: ModerationAPI.GetApiExportStatusOptions(batchJobId: batchJobId, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getApiIds

参数

名称	类型	位置	必填
tenantId	string	query	Yes
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
afterId	string	query	No
demo	boolean	query	No
sso	string	query	No

响应

返回：ModerationAPIGetCommentIdsResponse

示例

getApiIds 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let textSearch = "textSearch_example" // String |  (可选)
let byIPFromComment = "byIPFromComment_example" // String |  (可选)
let filters = "filters_example" // String |  (可选)
let searchFilters = "searchFilters_example" // String |  (可选)
let afterId = "afterId_example" // String |  (可选)
let demo = true // Bool |  (可选)
let sso = "sso_example" // String |  (可选)
ModerationAPI.getApiIds(tenantId: tenantId, options: ModerationAPI.GetApiIdsOptions(textSearch: textSearch, byIPFromComment: byIPFromComment, filters: filters, searchFilters: searchFilters, afterId: afterId, demo: demo, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getBanUsersFromComment

参数

名称	类型	位置	必需
tenantId	string	query	是
commentId	string	path	是
sso	string	query	否

响应

返回: GetBannedUsersFromCommentResponse

示例

getBanUsersFromComment 示例

Copy

// 以下代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let sso = "sso_example" // String |  (可选)
ModerationAPI.getBanUsersFromComment(tenantId: tenantId, commentId: commentId, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getCommentBanStatus

参数

名称	类型	位置	必需
tenantId	string	query	是
commentId	string	path	是
sso	string	query	否

响应

返回：GetCommentBanStatusResponse

示例

getCommentBanStatus 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let sso = "sso_example" // String | （可选）
ModerationAPI.getCommentBanStatus(tenantId: tenantId, commentId: commentId, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getCommentChildren

Parameters

Name	Type	Location	Required
tenantId	string	query	是
commentId	string	path	是
sso	string	query	否

Response

返回: ModerationAPIChildCommentsResponse

示例

获取评论子项示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let sso = "sso_example" // String |  （可选）
ModerationAPI.getCommentChildren(tenantId: tenantId, commentId: commentId, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getCount

参数

名称	类型	位置	必填
tenantId	string	query	是
text-search	string	query	否
byIPFromComment	string	query	否
filter	string	query	否
searchFilters	string	query	否
demo	boolean	query	否
sso	string	query	否

响应

返回：ModerationAPICountCommentsResponse

示例

getCount 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let textSearch = "textSearch_example" // String |  （可选）
let byIPFromComment = "byIPFromComment_example" // String |  （可选）
let filter = "filter_example" // String |  （可选）
let searchFilters = "searchFilters_example" // String |  （可选）
let demo = true // Bool |  （可选）
let sso = "sso_example" // String |  （可选）
ModerationAPI.getCount(tenantId: tenantId, options: ModerationAPI.GetCountOptions(textSearch: textSearch, byIPFromComment: byIPFromComment, filter: filter, searchFilters: searchFilters, demo: demo, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getCounts

参数

Name	Type	Location	Required	Description
tenantId	string	query	Yes
sso	string	query	No

响应

返回：GetBannedUsersCountResponse

示例

getCounts 示例

Copy

// 以下代码示例仍在测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let sso = "sso_example" // String | (可选)
ModerationAPI.getCounts(tenantId: tenantId, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getLogs

参数

名称	类型	位置	必需
tenantId	string	query	是
commentId	string	path	是
sso	string	query	否

响应

返回：ModerationAPIGetLogsResponse

示例

getLogs 示例

Copy

// 以下代码示例仍在测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let sso = "sso_example" // String |  （可选）
ModerationAPI.getLogs(tenantId: tenantId, commentId: commentId, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getManualBadges

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
sso	string	query	否

响应

返回: GetTenantManualBadgesResponse

示例

getManualBadges 示例

Copy

// 以下代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let sso = "sso_example" // String |  (可选)
ModerationAPI.getManualBadges(tenantId: tenantId, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getManualBadgesForUser

参数

名称	类型	位置	必填
tenantId	string	query	Yes
badgesUserId	string	query	No
commentId	string	query	No
sso	string	query	No

响应

返回: GetUserManualBadgesResponse

示例

getManualBadgesForUser 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let badgesUserId = "badgesUserId_example" // String |  (optional)
let commentId = "commentId_example" // String |  (optional)
let sso = "sso_example" // String |  (optional)
ModerationAPI.getManualBadgesForUser(tenantId: tenantId, options: ModerationAPI.GetManualBadgesForUserOptions(badgesUserId: badgesUserId, commentId: commentId, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getModerationComment

参数

名称	类型	位置	必填
tenantId	string	query	是
commentId	string	path	是
includeEmail	boolean	query	否
includeIP	boolean	query	否
sso	string	query	否

响应

返回：ModerationAPICommentResponse

示例

getModerationComment 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let includeEmail = true // Bool |  (optional)
let includeIP = true // Bool |  (optional)
let sso = "sso_example" // String |  (optional)
ModerationAPI.getModerationComment(tenantId: tenantId, commentId: commentId, options: ModerationAPI.GetModerationCommentOptions(includeEmail: includeEmail, includeIP: includeIP, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getModerationCommentText

参数

名称	类型	位置	必填
tenantId	string	query	是
commentId	string	path	是
sso	string	query	否

响应

返回: GetCommentTextResponse

示例

getModerationCommentText 示例

Copy

// 以下代码示例仍处于 beta 版。如有问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let sso = "sso_example" // String |  (可选)
ModerationAPI.getModerationCommentText(tenantId: tenantId, commentId: commentId, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getPreBanSummary

参数

名称	类型	位置	必需
tenantId	string	query	是
commentId	string	path	是
includeByUserIdAndEmail	boolean	query	否
includeByIP	boolean	query	否
includeByEmailDomain	boolean	query	否
sso	string	query	否

响应

返回：PreBanSummary

示例

getPreBanSummary 示例

Copy

// 以下代码示例仍处于 beta 状态。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let includeByUserIdAndEmail = true // Bool |  (optional)
let includeByIP = true // Bool |  (optional)
let includeByEmailDomain = true // Bool |  (optional)
let sso = "sso_example" // String |  (optional)
ModerationAPI.getPreBanSummary(tenantId: tenantId, commentId: commentId, options: ModerationAPI.GetPreBanSummaryOptions(includeByUserIdAndEmail: includeByUserIdAndEmail, includeByIP: includeByIP, includeByEmailDomain: includeByEmailDomain, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getSearchCommentsSummary

参数

名称	类型	位置	必需
tenantId	string	query	是
value	string	query	否
filters	string	query	否
searchFilters	string	query	否
sso	string	query	否

响应

返回：ModerationCommentSearchResponse

示例

getSearchCommentsSummary 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let value = "value_example" // String |  （可选）
let filters = "filters_example" // String |  （可选）
let searchFilters = "searchFilters_example" // String |  （可选）
let sso = "sso_example" // String |  （可选）
ModerationAPI.getSearchCommentsSummary(tenantId: tenantId, options: ModerationAPI.GetSearchCommentsSummaryOptions(value: value, filters: filters, searchFilters: searchFilters, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getSearchPages

参数

名称	类型	位置	必填
tenantId	string	query	Yes
value	string	query	No
sso	string	query	No

响应

返回：ModerationPageSearchResponse

示例

getSearchPages 示例

Copy

// 以下代码示例仍处于 beta 阶段。若有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let value = "value_example" // String |  (可选)
let sso = "sso_example" // String |  (可选)
ModerationAPI.getSearchPages(tenantId: tenantId, options: ModerationAPI.GetSearchPagesOptions(value: value, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getSearchSites

参数

名称	类型	位置	必需
tenantId	string	query	Yes
value	string	query	No
sso	string	query	No

响应

返回：ModerationSiteSearchResponse

示例

getSearchSites 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let value = "value_example" // String |  (optional)
let sso = "sso_example" // String |  (optional)
ModerationAPI.getSearchSites(tenantId: tenantId, options: ModerationAPI.GetSearchSitesOptions(value: value, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getSearchSuggest

参数

名称	类型	位置	必需
tenantId	string	query	是
text-search	string	query	否
sso	string	query	否

响应

返回：ModerationSuggestResponse

示例

getSearchSuggest 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let textSearch = "textSearch_example" // String | （可选）
let sso = "sso_example" // String | （可选）
ModerationAPI.getSearchSuggest(tenantId: tenantId, options: ModerationAPI.GetSearchSuggestOptions(textSearch: textSearch, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getSearchUsers

参数

名称	类型	位置	必需
tenantId	string	query	Yes
value	string	query	No
sso	string	query	No

响应

返回: ModerationUserSearchResponse

示例

getSearchUsers 示例

Copy

// 以下代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let value = "value_example" // String |  (可选)
let sso = "sso_example" // String |  (可选)
ModerationAPI.getSearchUsers(tenantId: tenantId, options: ModerationAPI.GetSearchUsersOptions(value: value, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getTrustFactor

参数

名称	类型	位置	必填
tenantId	string	query	是
userId	string	query	否
sso	string	query	否

响应

Returns: GetUserTrustFactorResponse

示例

getTrustFactor 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let userId = "userId_example" // String |  （可选）
let sso = "sso_example" // String |  （可选）
ModerationAPI.getTrustFactor(tenantId: tenantId, options: ModerationAPI.GetTrustFactorOptions(userId: userId, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getUserBanPreference

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
sso	string	query	否

响应

返回：APIModerateGetUserBanPreferencesResponse

示例

getUserBanPreference 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let sso = "sso_example" // String |  (可选)
ModerationAPI.getUserBanPreference(tenantId: tenantId, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getUserInternalProfile

参数

名称	类型	位置	必需
tenantId	string	query	是
commentId	string	query	否
sso	string	query	否

响应

返回：GetUserInternalProfileResponse

示例

getUserInternalProfile 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String |  (optional)
let sso = "sso_example" // String |  (optional)
ModerationAPI.getUserInternalProfile(tenantId: tenantId, options: ModerationAPI.GetUserInternalProfileOptions(commentId: commentId, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

postAdjustCommentVotes

参数

名称	类型	位置	必填
tenantId	string	query	是
commentId	string	path	是
broadcastId	string	query	否
sso	string	query	否

响应

返回：AdjustVotesResponse

示例

postAdjustCommentVotes 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let adjustCommentVotesParams = AdjustCommentVotesParams(adjustVoteAmount: 123) // AdjustCommentVotesParams | 
let broadcastId = "broadcastId_example" // String |  （可选）
let sso = "sso_example" // String |  （可选）
ModerationAPI.postAdjustCommentVotes(tenantId: tenantId, commentId: commentId, adjustCommentVotesParams: adjustCommentVotesParams, options: ModerationAPI.PostAdjustCommentVotesOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

postApiExport

参数

Name	Type	Location	Required
tenantId	string	query	Yes
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
sorts	string	query	No
sso	string	query	No

响应

返回: ModerationExportResponse

示例

postApiExport 示例

Copy

// 以下代码示例仍处于测试阶段。如有问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 提交报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let textSearch = "textSearch_example" // String |  （可选）
let byIPFromComment = "byIPFromComment_example" // String |  （可选）
let filters = "filters_example" // String |  （可选）
let searchFilters = "searchFilters_example" // String |  （可选）
let sorts = "sorts_example" // String |  （可选）
let sso = "sso_example" // String |  （可选）
ModerationAPI.postApiExport(tenantId: tenantId, options: ModerationAPI.PostApiExportOptions(textSearch: textSearch, byIPFromComment: byIPFromComment, filters: filters, searchFilters: searchFilters, sorts: sorts, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

postBanUserFromComment

参数

名称	类型	位置	必填
tenantId	string	query	Yes
commentId	string	path	Yes
banEmail	boolean	query	No
banEmailDomain	boolean	query	No
banIP	boolean	query	No
deleteAllUsersComments	boolean	query	No
bannedUntil	string	query	No
isShadowBan	boolean	query	No
updateId	string	query	No
banReason	string	query	No
sso	string	query	No

响应

返回: BanUserFromCommentResult

示例

postBanUserFromComment 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let banEmail = true // Bool |  (optional)
let banEmailDomain = true // Bool |  (optional)
let banIP = true // Bool |  (optional)
let deleteAllUsersComments = true // Bool |  (optional)
let bannedUntil = "bannedUntil_example" // String |  (optional)
let isShadowBan = true // Bool |  (optional)
let updateId = "updateId_example" // String |  (optional)
let banReason = "banReason_example" // String |  (optional)
let sso = "sso_example" // String |  (optional)
ModerationAPI.postBanUserFromComment(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostBanUserFromCommentOptions(banEmail: banEmail, banEmailDomain: banEmailDomain, banIP: banIP, deleteAllUsersComments: deleteAllUsersComments, bannedUntil: bannedUntil, isShadowBan: isShadowBan, updateId: updateId, banReason: banReason, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

postBanUserUndo

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
sso	string	query	否

响应

返回：APIEmptyResponse

示例

postBanUserUndo 示例

Copy

// 以下代码示例仍为 beta 版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let banUserUndoParams = BanUserUndoParams(changelog: APIBanUserChangeLog(createdBannedUserId: "createdBannedUserId_example", updatedBannedUserId: "updatedBannedUserId_example", deletedBannedUsers: [APIBannedUser(id: "id_example", tenantId: "tenantId_example", userId: "userId_example", email: "email_example", username: "username_example", ipHash: "ipHash_example", createdAt: Date(), bannedByUserId: "bannedByUserId_example", bannedCommentText: "bannedCommentText_example", banType: "banType_example", bannedUntil: Date(), hasEmailWildcard: false, banReason: "banReason_example")], changedValuesBefore: APIBanUserChangedValues(id: "id_example", tenantId: "tenantId_example", userId: "userId_example", email: "email_example", username: "username_example", ipHash: "ipHash_example", createdAt: Date(), bannedByUserId: "bannedByUserId_example", bannedCommentText: "bannedCommentText_example", banType: "banType_example", bannedUntil: Date(), hasEmailWildcard: false, banReason: "banReason_example"))) // BanUserUndoParams | 
let sso = "sso_example" // String |  (可选)
ModerationAPI.postBanUserUndo(tenantId: tenantId, banUserUndoParams: banUserUndoParams, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

postBulkPreBanSummary

参数

名称	类型	位置	必填
tenantId	string	query	Yes
includeByUserIdAndEmail	boolean	query	No
includeByIP	boolean	query	No
includeByEmailDomain	boolean	query	No
sso	string	query	No

响应

返回: BulkPreBanSummary

示例

postBulkPreBanSummary 示例

Copy

// 以下代码示例仍处于测试阶段。如有问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let bulkPreBanParams = BulkPreBanParams(commentIds: ["commentIds_example"]) // BulkPreBanParams | 
let includeByUserIdAndEmail = true // Bool |  (optional)
let includeByIP = true // Bool |  (optional)
let includeByEmailDomain = true // Bool |  (optional)
let sso = "sso_example" // String |  (optional)
ModerationAPI.postBulkPreBanSummary(tenantId: tenantId, bulkPreBanParams: bulkPreBanParams, options: ModerationAPI.PostBulkPreBanSummaryOptions(includeByUserIdAndEmail: includeByUserIdAndEmail, includeByIP: includeByIP, includeByEmailDomain: includeByEmailDomain, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

postCommentsByIds

参数

名称	类型	位置	必填	描述
tenantId	string	query	Yes
sso	string	query	No

响应

返回: ModerationAPIChildCommentsResponse

示例

postCommentsByIds 示例

Copy

// 以下代码示例仍处于 beta 版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentsByIdsParams = CommentsByIdsParams(ids: ["ids_example"]) // CommentsByIdsParams | 
let sso = "sso_example" // String |  (可选)
ModerationAPI.postCommentsByIds(tenantId: tenantId, commentsByIdsParams: commentsByIdsParams, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

postFlagComment

参数

名称	类型	位置	必需
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

响应

返回: APIEmptyResponse

示例

postFlagComment 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let broadcastId = "broadcastId_example" // String |  （可选）
let sso = "sso_example" // String |  （可选）
ModerationAPI.postFlagComment(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostFlagCommentOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

postRemoveComment

参数

名称	类型	位置	必填
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

响应

返回: PostRemoveCommentApiResponse

示例

postRemoveComment 示例

Copy

// 以下代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String |
let commentId = "commentId_example" // String |
let broadcastId = "broadcastId_example" // String |  （可选）
let sso = "sso_example" // String |  （可选）
ModerationAPI.postRemoveComment(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostRemoveCommentOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

postRestoreDeletedComment

参数

名称	类型	位置	必填
tenantId	string	query	是
commentId	string	path	是
broadcastId	string	query	否
sso	string	query	否

响应

返回：APIEmptyResponse

示例

postRestoreDeletedComment 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let broadcastId = "broadcastId_example" // String |  (可选)
let sso = "sso_example" // String |  (可选)
ModerationAPI.postRestoreDeletedComment(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostRestoreDeletedCommentOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

postSetCommentApprovalStatus

参数

Name	Type	Location	Required
tenantId	string	query	Yes
commentId	string	path	Yes
approved	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

响应

返回: SetCommentApprovedResponse

示例

postSetCommentApprovalStatus 示例

Copy

// 以下代码示例仍处于 beta 状态。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let approved = true // Bool |  (optional)
let broadcastId = "broadcastId_example" // String |  (optional)
let sso = "sso_example" // String |  (optional)
ModerationAPI.postSetCommentApprovalStatus(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostSetCommentApprovalStatusOptions(approved: approved, broadcastId: broadcastId, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

postSetCommentReviewStatus

参数

名称	类型	位置	必填
tenantId	string	query	是
commentId	string	path	是
reviewed	boolean	query	否
broadcastId	string	query	否
sso	string	query	否

响应

返回: APIEmptyResponse

示例

postSetCommentReviewStatus 示例

Copy

// 以下代码示例仍处于 beta 版本。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let reviewed = true // Bool |  (optional)
let broadcastId = "broadcastId_example" // String |  (optional)
let sso = "sso_example" // String |  (optional)
ModerationAPI.postSetCommentReviewStatus(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostSetCommentReviewStatusOptions(reviewed: reviewed, broadcastId: broadcastId, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

postSetCommentSpamStatus

参数

名称	类型	位置	必需
tenantId	string	查询	是
commentId	string	路径	是
spam	boolean	查询	否
permNotSpam	boolean	查询	否
broadcastId	string	查询	否
sso	string	查询	否

响应

返回：APIEmptyResponse

示例

postSetCommentSpamStatus 示例

Copy

// 以下代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let spam = true // Bool |  (optional)
let permNotSpam = true // Bool |  (optional)
let broadcastId = "broadcastId_example" // String |  (optional)
let sso = "sso_example" // String |  (optional)
ModerationAPI.postSetCommentSpamStatus(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostSetCommentSpamStatusOptions(spam: spam, permNotSpam: permNotSpam, broadcastId: broadcastId, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

postSetCommentText

参数

名称	类型	位置	必需
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

响应

返回: SetCommentTextResponse

示例

postSetCommentText 示例

Copy

// 以下代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let setCommentTextParams = SetCommentTextParams(comment: "comment_example") // SetCommentTextParams | 
let broadcastId = "broadcastId_example" // String |  (optional)
let sso = "sso_example" // String |  (optional)
ModerationAPI.postSetCommentText(tenantId: tenantId, commentId: commentId, setCommentTextParams: setCommentTextParams, options: ModerationAPI.PostSetCommentTextOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

postUnFlagComment

参数

名称	类型	位置	必填
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

响应

返回: APIEmptyResponse

示例

postUnFlagComment 示例

Copy

// 以下代码示例仍处于 beta 版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let broadcastId = "broadcastId_example" // String |  (可选)
let sso = "sso_example" // String |  (可选)
ModerationAPI.postUnFlagComment(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostUnFlagCommentOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

postVote

参数

名称	类型	位置	必填
tenantId	string	query	Yes
commentId	string	path	Yes
direction	string	query	No
broadcastId	string	query	No
sso	string	query	No

响应

返回: VoteResponse

示例

postVote 示例

Copy

// 以下代码示例仍为 beta 版。如有问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let direction = "direction_example" // String |  (optional)
let broadcastId = "broadcastId_example" // String |  (optional)
let sso = "sso_example" // String |  (optional)
ModerationAPI.postVote(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostVoteOptions(direction: direction, broadcastId: broadcastId, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

putAwardBadge

参数

名称	类型	位置	必填
tenantId	string	query	Yes
badgeId	string	query	Yes
userId	string	query	No
commentId	string	query	No
broadcastId	string	query	No
sso	string	query	No

响应

Returns: AwardUserBadgeResponse

示例

putAwardBadge 示例

Copy

// 以下代码示例仍处于 beta 版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let badgeId = "badgeId_example" // String | 
let userId = "userId_example" // String |  （可选）
let commentId = "commentId_example" // String |  （可选）
let broadcastId = "broadcastId_example" // String |  （可选）
let sso = "sso_example" // String |  （可选）
ModerationAPI.putAwardBadge(tenantId: tenantId, badgeId: badgeId, options: ModerationAPI.PutAwardBadgeOptions(userId: userId, commentId: commentId, broadcastId: broadcastId, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

putCloseThread

参数

名称	类型	位置	必填
tenantId	string	query	是
urlId	string	query	是
sso	string	query	否

响应

返回：APIEmptyResponse

示例

putCloseThread 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let urlId = "urlId_example" // String | 
let sso = "sso_example" // String |  （可选）
ModerationAPI.putCloseThread(tenantId: tenantId, urlId: urlId, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

putRemoveBadge

参数

名称	类型	位置	必填
tenantId	string	query	Yes
badgeId	string	query	Yes
userId	string	query	No
commentId	string	query	No
broadcastId	string	query	No
sso	string	query	No

响应

Returns: RemoveUserBadgeResponse

示例

putRemoveBadge 示例

Copy

// 以下代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 提交报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let badgeId = "badgeId_example" // String | 
let userId = "userId_example" // String |  (optional)
let commentId = "commentId_example" // String |  (optional)
let broadcastId = "broadcastId_example" // String |  (optional)
let sso = "sso_example" // String |  (optional)
ModerationAPI.putRemoveBadge(tenantId: tenantId, badgeId: badgeId, options: ModerationAPI.PutRemoveBadgeOptions(userId: userId, commentId: commentId, broadcastId: broadcastId, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

putReopenThread

参数

名称	类型	位置	必填
tenantId	string	query	是
urlId	string	query	是
sso	string	query	否

响应

返回：APIEmptyResponse

示例

putReopenThread 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String |
let urlId = "urlId_example" // String |
let sso = "sso_example" // String |  （可选）
ModerationAPI.putReopenThread(tenantId: tenantId, urlId: urlId, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

setTrustFactor

Parameters

Name	Type	Location	Required
tenantId	string	query	Yes
userId	string	query	No
trustFactor	string	query	No
sso	string	query	No

Response

返回: SetUserTrustFactorResponse

Example

setTrustFactor 示例

Copy

// 以下代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let userId = "userId_example" // String |  (可选)
let trustFactor = "trustFactor_example" // String |  (可选)
let sso = "sso_example" // String |  (可选)
ModerationAPI.setTrustFactor(tenantId: tenantId, options: ModerationAPI.SetTrustFactorOptions(userId: userId, trustFactor: trustFactor, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

createModerator

参数

名称	类型	位置	必需	描述
tenantId	string	query	是

响应

返回: CreateModeratorResponse

示例

createModerator 示例

Copy

// 以下代码示例仍处于测试阶段。如有问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let createModeratorBody = CreateModeratorBody(name: "name_example", email: "email_example", userId: "userId_example", moderationGroupIds: ["moderationGroupIds_example"]) // CreateModeratorBody | 
DefaultAPI.createModerator(tenantId: tenantId, createModeratorBody: createModeratorBody) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deleteModerator

参数

Name	Type	Location	Required
tenantId	string	query	是
id	string	path	是
sendEmail	string	query	否

响应

返回: APIEmptyResponse

示例

deleteModerator 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let sendEmail = "sendEmail_example" // String |  (可选)
DefaultAPI.deleteModerator(tenantId: tenantId, id: id, sendEmail: sendEmail) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getModerator

参数

Name	Type	Location	Required	Description
tenantId	string	query	是
id	string	path	是

响应

返回: GetModeratorResponse

示例

getModerator 示例

Copy

// 以下代码示例仍处于测试阶段。如有问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
DefaultAPI.getModerator(tenantId: tenantId, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getModerators

参数

名称	类型	位置	必需	描述
tenantId	string	查询	是
skip	number	查询	否

响应

返回: GetModeratorsResponse

示例

getModerators 示例

Copy

// 以下代码示例仍处于测试版。如遇任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let skip = 987 // Double |  (可选)
DefaultAPI.getModerators(tenantId: tenantId, skip: skip) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

sendInvite

参数

Name	Type	Location	Required
tenantId	string	query	是
id	string	path	是
fromName	string	query	是

响应

返回: APIEmptyResponse

示例

sendInvite 示例

Copy

// 以下代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let fromName = "fromName_example" // String | 
DefaultAPI.sendInvite(tenantId: tenantId, id: id, fromName: fromName) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

updateModerator

参数

Name	Type	Location	Required	Description
tenantId	string	query	是
id	string	path	是

响应

返回: APIEmptyResponse

示例

updateModerator 示例

Copy

// 以下代码示例仍为 beta。如遇任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let updateModeratorBody = UpdateModeratorBody(name: "name_example", email: "email_example", userId: "userId_example", moderationGroupIds: ["moderationGroupIds_example"]) // UpdateModeratorBody | 
DefaultAPI.updateModerator(tenantId: tenantId, id: id, updateModeratorBody: updateModeratorBody) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deleteNotificationCount

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
id	string	path	是

返回：APIEmptyResponse

示例

deleteNotificationCount 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // 字符串 | 
let id = "id_example" // 字符串 | 
DefaultAPI.deleteNotificationCount(tenantId: tenantId, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getCachedNotificationCount

参数

Name	Type	Location	Required	Description
tenantId	string	query	是
id	string	path	是

Response

返回: GetCachedNotificationCountResponse

示例

getCachedNotificationCount 示例

Copy

// 以下代码示例仍为测试版。如遇问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
DefaultAPI.getCachedNotificationCount(tenantId: tenantId, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getNotificationCount

参数

名称	类型	位置	必填
tenantId	string	query	Yes
userId	string	query	No
urlId	string	query	No
fromCommentId	string	query	No
viewed	boolean	query	No
type	string	query	No

响应

返回：GetNotificationCountResponse

示例

getNotificationCount 示例

Copy

// 以下代码示例仍处于测试阶段。若出现任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let userId = "userId_example" // String |  (可选)
let urlId = "urlId_example" // String |  (可选)
let fromCommentId = "fromCommentId_example" // String |  (可选)
let viewed = true // Bool |  (可选)
let type = "type_example" // String |  (可选)
DefaultAPI.getNotificationCount(tenantId: tenantId, options: DefaultAPI.GetNotificationCountOptions(userId: userId, urlId: urlId, fromCommentId: fromCommentId, viewed: viewed, type: type)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getNotifications

参数

名称	类型	位置	必填
tenantId	string	query	是
userId	string	query	否
urlId	string	query	否
fromCommentId	string	query	否
viewed	boolean	query	否
type	string	query	否
skip	number	query	否

响应

返回: GetNotificationsResponse

示例

getNotifications 示例

Copy

// 以下代码示例仍属Beta。如有问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let userId = "userId_example" // String |  (可选)
let urlId = "urlId_example" // String |  (可选)
let fromCommentId = "fromCommentId_example" // String |  (可选)
let viewed = true // Bool |  (可选)
let type = "type_example" // String |  (可选)
let skip = 987 // Double |  (可选)
DefaultAPI.getNotifications(tenantId: tenantId, options: DefaultAPI.GetNotificationsOptions(userId: userId, urlId: urlId, fromCommentId: fromCommentId, viewed: viewed, type: type, skip: skip)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

updateNotification

参数

Name	Type	Location	Required
tenantId	string	query	是
id	string	path	是
userId	string	query	否

响应

返回: APIEmptyResponse

示例

updateNotification 示例

Copy

// 下列代码示例仍处于测试版。如遇任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let updateNotificationBody = UpdateNotificationBody(viewed: false, optedOut: false) // UpdateNotificationBody | 
let userId = "userId_example" // String |  (可选)
DefaultAPI.updateNotification(tenantId: tenantId, id: id, updateNotificationBody: updateNotificationBody, userId: userId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

createV1PageReact

参数

名称	类型	位置	必填
tenantId	string	path	是
urlId	string	query	是
title	string	query	否
sso	string	query	否

响应

Returns: CreateV1PageReact

示例

createV1PageReact 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let urlId = "urlId_example" // String | 
let title = "title_example" // String |  (可选)
let sso = "sso_example" // String |  (可选)
PublicAPI.createV1PageReact(tenantId: tenantId, urlId: urlId, options: PublicAPI.CreateV1PageReactOptions(title: title, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

createV2PageReact

参数

Name	Type	Location	Required
tenantId	string	path	Yes
urlId	string	query	Yes
id	string	query	Yes
title	string	query	No
sso	string	query	No

响应

返回: CreateV1PageReact

示例

createV2PageReact 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let urlId = "urlId_example" // String | 
let id = "id_example" // String | 
let title = "title_example" // String |  (可选)
let sso = "sso_example" // String |  (可选)
PublicAPI.createV2PageReact(tenantId: tenantId, urlId: urlId, id: id, options: PublicAPI.CreateV2PageReactOptions(title: title, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deleteV1PageReact

参数

名称	类型	位置	必填
tenantId	string	path	Yes
urlId	string	query	Yes
sso	string	query	No

响应

返回：CreateV1PageReact

示例

deleteV1PageReact 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let urlId = "urlId_example" // String | 
let sso = "sso_example" // String |  (可选)
PublicAPI.deleteV1PageReact(tenantId: tenantId, urlId: urlId, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deleteV2PageReact

参数

名称	类型	位置	必填
tenantId	string	path	Yes
urlId	string	query	Yes
id	string	query	Yes
sso	string	query	No

响应

返回: CreateV1PageReact

示例

deleteV2PageReact 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let urlId = "urlId_example" // String | 
let id = "id_example" // String | 
let sso = "sso_example" // String |  (可选)
PublicAPI.deleteV2PageReact(tenantId: tenantId, urlId: urlId, id: id, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getV1PageLikes

参数

名称	类型	位置	必需	描述
tenantId	string	path	Yes
urlId	string	query	Yes
sso	string	query	No
includeUserInfo	string	query	No	设置后，返回点赞页面的用户（头像和用户名）。仅接受 "public"，这会省略私人资料。

响应

返回：GetV1PageLikes

示例

getV1PageLikes 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let urlId = "urlId_example" // String | 
let sso = "sso_example" // String |  (可选)
let includeUserInfo = PageReactIncludeUserInfo() // PageReactIncludeUserInfo | 设置后，返回点赞页面的用户（头像和用户名）。仅接受 "public"，这会省略私人资料。（可选）
PublicAPI.getV1PageLikes(tenantId: tenantId, urlId: urlId, options: PublicAPI.GetV1PageLikesOptions(sso: sso, includeUserInfo: includeUserInfo)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getV2PageReacts

参数

名称	类型	位置	必填	描述
tenantId	string	path	是
urlId	string	query	是
sso	string	query	否
includeUserInfo	string	query	否	设置后，返回每个 react id 的用户（头像和用户名）。仅接受 "public"，会省略私人资料。

响应

返回：GetV2PageReacts

示例

getV2PageReacts 示例

Copy

// 以下代码示例仍处于 beta 版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let urlId = "urlId_example" // String | 
let sso = "sso_example" // String |  （可选）
let includeUserInfo = PageReactIncludeUserInfo() // PageReactIncludeUserInfo | 设置后，返回每个 react id 的用户（头像和用户名）。仅接受 \"public\"，会省略私人资料。 （可选）
PublicAPI.getV2PageReacts(tenantId: tenantId, urlId: urlId, options: PublicAPI.GetV2PageReactsOptions(sso: sso, includeUserInfo: includeUserInfo)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getV2PageReactUsers

参数

名称	类型	位置	必需
tenantId	string	path	是
urlId	string	query	是
id	string	query	是
sso	string	query	否

响应

返回: GetV2PageReactUsersResponse

示例

getV2PageReactUsers 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let urlId = "urlId_example" // String | 
let id = "id_example" // String | 
let sso = "sso_example" // String |  （可选）
PublicAPI.getV2PageReactUsers(tenantId: tenantId, urlId: urlId, id: id, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

addPage

参数

Name	Type	Location	Required	Description
tenantId	string	query	是

响应

返回: AddPageAPIResponse

示例

addPage 示例

Copy

// 以下代码示例仍处于测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let createAPIPageData = CreateAPIPageData(accessibleByGroupIds: ["accessibleByGroupIds_example"], rootCommentCount: 123, commentCount: 123, title: "title_example", url: "url_example", urlId: "urlId_example") // CreateAPIPageData | 
DefaultAPI.addPage(tenantId: tenantId, createAPIPageData: createAPIPageData) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deletePage

参数

Name	Type	Location	Required	Description
tenantId	string	query	是
id	string	path	是

响应

返回: DeletePageAPIResponse

示例

deletePage 示例

Copy

// 下面的代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
DefaultAPI.deletePage(tenantId: tenantId, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getOfflineUsers

当前不在线的页面历史评论者。按 displayName 排序。在用完 /users/online 之后，使用此接口渲染“成员”部分。基于 commenterName 的游标分页：服务器通过 $gt 从 afterName 开始沿部分索引 {tenantId, urlId, commenterName} 向前遍历，没有 $skip 开销。

参数

名称	类型	位置	必填	描述
tenantId	string	path	是
urlId	string	query	是	页面 URL 标识符（在服务端进行清理）。
afterName	string	query	否	游标：传入上一次响应中的 nextAfterName。
afterUserId	string	query	否	游标决胜键：传入上一次响应中的 nextAfterUserId。当设置了 afterName 时必须提供，以避免同名条目被丢弃。

响应

返回：PageUsersOfflineResponse

示例

getOfflineUsers 示例

Copy

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let urlId = "urlId_example" // String | 页面 URL 标识符（在服务端进行清理）。
let afterName = "afterName_example" // String | 游标：传入上一次响应中的 nextAfterName。 (optional)
let afterUserId = "afterUserId_example" // String | 游标决胜键：传入上一次响应中的 nextAfterUserId。当设置了 afterName 时必须提供，以避免同名条目被丢弃。 (optional)
PublicAPI.getOfflineUsers(tenantId: tenantId, urlId: urlId, options: PublicAPI.GetOfflineUsersOptions(afterName: afterName, afterUserId: afterUserId)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getOnlineUsers

当前在线的页面查看者：指其 websocket 会话当前已订阅该页面的用户。
返回 anonCount + totalCount（全房间订阅者，包括我们不枚举的匿名查看者）。

参数

名称	类型	位置	必需	描述
tenantId	string	path	Yes
urlId	string	query	Yes	页面 URL 标识符（服务器端清理后）。
afterName	string	query	No	光标：从上一次响应中传递 nextAfterName。
afterUserId	string	query	No	光标平局解决器：从上一次响应中传递 nextAfterUserId。当设置 afterName 时需要此字段，以防止名称平局导致条目丢失。

响应

返回：PageUsersOnlineResponse

示例

获取在线用户示例

Copy

// 以下代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let urlId = "urlId_example" // String | 页面 URL 标识符（服务器端清理后）。
let afterName = "afterName_example" // String | 光标：从上一次响应中传递 nextAfterName。（可选）
let afterUserId = "afterUserId_example" // String | 光标平局解决器：从上一次响应中传递 nextAfterUserId。当设置 afterName 时需要此字段，以防止名称平局导致条目丢失。（可选）
PublicAPI.getOnlineUsers(tenantId: tenantId, urlId: urlId, options: PublicAPI.GetOnlineUsersOptions(afterName: afterName, afterUserId: afterUserId)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getPageByURLId

参数

名称	类型	位置	必填	描述
tenantId	string	query	Yes
urlId	string	query	Yes

响应

返回: GetPageByURLIdAPIResponse

示例

getPageByURLId 示例

Copy

// 以下代码示例仍处于测试版。如有问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let urlId = "urlId_example" // String | 
DefaultAPI.getPageByURLId(tenantId: tenantId, urlId: urlId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getPageLikes

页面的点赞数，可选包含点赞的用户。

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
urlId	string	query	是
includeUserInfo	string	query	否	"public" 省略拥有私密资料的用户，"include-private" 则包含他们。

响应

返回：GetPageLikesAPIResponse

示例

getPageLikes 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let urlId = "urlId_example" // String | 
let includeUserInfo = PageReactIncludeUserInfo() // PageReactIncludeUserInfo | \"public\" 省略拥有私密资料的用户，\"include-private\" 则包含他们。(optional)
DefaultAPI.getPageLikes(tenantId: tenantId, urlId: urlId, includeUserInfo: includeUserInfo) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getPageReacts

自定义页面的反应计数，可选包含做出反应的用户。

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
urlId	string	query	是
includeUserInfo	string	query	否	"public" 省略拥有私密资料的用户，"include-private" 则包含他们。

响应

返回：GetPageReactsAPIResponse

示例

getPageReacts 示例

Copy

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let urlId = "urlId_example" // String | 
let includeUserInfo = PageReactIncludeUserInfo() // PageReactIncludeUserInfo | \"public\" omits users with private profiles, \"include-private\" includes them. (optional)
DefaultAPI.getPageReacts(tenantId: tenantId, urlId: urlId, includeUserInfo: includeUserInfo) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getPages

参数

名称	类型	位置	必填	描述
tenantId	string	query	是

响应

返回: GetPagesAPIResponse

示例

getPages 示例

Copy

// 以下代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // 字符串 | 
DefaultAPI.getPages(tenantId: tenantId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getPagesPublic

列出租户的页面。由 FChat 桌面客户端用于填充其房间列表。要求每个页面的已解析自定义配置中 enableFChat 为 true。需要 SSO 的页面会根据请求用户的组访问权限进行过滤。

参数

名称	类型	位置	必填	描述
tenantId	string	path	是
cursor	string	query	否	上一次请求返回的 `nextCursor` 不透明分页游标。与相同的 `sortBy` 绑定。
limit	integer	query	否	1..200，默认 50
q	string	query	否	可选的不区分大小写的标题前缀过滤器。
sortBy	string	query	否	排序方式。`updatedAt`（默认，最新优先）、`commentCount`（评论最多优先）或 `title`（按字母顺序）。
hasComments	boolean	query	否	如果为 true，则仅返回至少有一条评论的页面。

响应

返回：GetPublicPagesResponse

示例

getPagesPublic 示例

Copy

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let cursor = "cursor_example" // String | 上一次请求返回的 `nextCursor` 不透明分页游标。与相同的 `sortBy` 绑定。 (optional)
let limit = 987 // Int | 1..200，默认 50 (optional)
let q = "q_example" // String | 可选的不区分大小写的标题前缀过滤器。 (optional)
let sortBy = PagesSortBy() // PagesSortBy | 排序方式。`updatedAt`（默认，最新优先）、`commentCount`（评论最多优先）或 `title`（按字母顺序）。 (optional)
let hasComments = true // Bool | 如果为 true，则仅返回至少有一条评论的页面。 (optional)
PublicAPI.getPagesPublic(tenantId: tenantId, options: PublicAPI.GetPagesPublicOptions(cursor: cursor, limit: limit, q: q, sortBy: sortBy, hasComments: hasComments)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getUsersInfo

为租户批量获取用户信息。根据 userIds，返回来自 User / SSOUser 的展示信息。由评论小部件使用，以补充通过存在事件刚刚出现的用户信息。没有页面上下文：隐私统一强制执行（私人资料将被屏蔽）。

参数

名称	类型	位置	必需	描述
tenantId	string	path	是
ids	string	query	是	以逗号分隔的 userIds。

响应

返回：PageUsersInfoResponse

示例

getUsersInfo 示例

Copy

// 以下代码示例仍处于测试版。如遇任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let ids = "ids_example" // String | 以逗号分隔的 userIds。
PublicAPI.getUsersInfo(tenantId: tenantId, ids: ids) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

migratePages

将批量任务加入队列，把评论、页面及相关记录从一个 urlId 或 domain 迁移到另一个。 "urlId" 迁移仅匹配完全相同的 urlId。"domain" 迁移会在每个 urlId 和 url 中查找并替换该值。轮询 GET /api/v1/batch-jobs/{batchJobId}：任务完成后会包含每次迁移的结果和一个 undoId。

参数

名称	类型	位置	必填	描述
tenantId	string	query	是

响应

返回：QueuePageMigrationJobAPIResponse

示例

migratePages 示例

Copy

// 以下代码示例仍处于测试阶段。如有问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 反馈
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let migrateAPIPagesData = MigrateAPIPagesData(migrations: [PageMigration(from: "from_example", to: "to_example", type: PageMigrationType())]) // MigrateAPIPagesData | 
DefaultAPI.migratePages(tenantId: tenantId, migrateAPIPagesData: migrateAPIPagesData) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

patchPage

参数

Name	Type	Location	Required	Description
tenantId	string	query	Yes
id	string	path	Yes

响应

返回: PatchPageAPIResponse

示例

patchPage 示例

Copy

// 以下代码示例仍为测试版。如果有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let updateAPIPageData = UpdateAPIPageData(isClosed: false, accessibleByGroupIds: ["accessibleByGroupIds_example"], title: "title_example", url: "url_example", urlId: "urlId_example") // UpdateAPIPageData | 
DefaultAPI.patchPage(tenantId: tenantId, id: id, updateAPIPageData: updateAPIPageData) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

undoPageMigrations

将一个批量任务加入队列，该任务会按从新到旧的顺序撤销某个 migrate-pages 任务的每一次迁移。此功能可用 90 天。迁移之后发生变更的记录不会被改动，因此后续的编辑永远不会被覆盖。轮询 GET /api/v1/batch-jobs/{batchJobId} 以获取已恢复/已跳过的数量。

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
undoId	string	path	是

响应

返回：QueuePageMigrationJobAPIResponse

示例

undoPageMigrations 示例

Copy

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let undoId = "undoId_example" // String | 
DefaultAPI.undoPageMigrations(tenantId: tenantId, undoId: undoId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deletePendingWebhookEvent

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
id	string	path	是

响应

返回: APIEmptyResponse

示例

deletePendingWebhookEvent 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // 字符串 | 
let id = "id_example" // 字符串 | 
DefaultAPI.deletePendingWebhookEvent(tenantId: tenantId, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getPendingWebhookEventCount

参数

名称	类型	位置	必填
tenantId	string	query	Yes
commentId	string	query	No
externalId	string	query	No
eventType	string	query	No
type	string	query	No
domain	string	query	No
attemptCountGT	number	query	No

响应

返回：GetPendingWebhookEventCountResponse

示例

getPendingWebhookEventCount 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String |  （可选）
let externalId = "externalId_example" // String |  （可选）
let eventType = "eventType_example" // String |  （可选）
let type = "type_example" // String |  （可选）
let domain = "domain_example" // String |  （可选）
let attemptCountGT = 987 // Double |  （可选）
DefaultAPI.getPendingWebhookEventCount(tenantId: tenantId, options: DefaultAPI.GetPendingWebhookEventCountOptions(commentId: commentId, externalId: externalId, eventType: eventType, type: type, domain: domain, attemptCountGT: attemptCountGT)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getPendingWebhookEvents

参数

名称	类型	位置	必填
tenantId	string	query	是
commentId	string	query	否
externalId	string	query	否
eventType	string	query	否
type	string	query	否
domain	string	query	否
attemptCountGT	number	query	否
skip	number	query	否

响应

返回：GetPendingWebhookEventsResponse

示例

getPendingWebhookEvents 示例

Copy

// 以下代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String |  （可选）
let externalId = "externalId_example" // String |  （可选）
let eventType = "eventType_example" // String |  （可选）
let type = "type_example" // String |  （可选）
let domain = "domain_example" // String |  （可选）
let attemptCountGT = 987 // Double |  （可选）
let skip = 987 // Double |  （可选）
DefaultAPI.getPendingWebhookEvents(tenantId: tenantId, options: DefaultAPI.GetPendingWebhookEventsOptions(commentId: commentId, externalId: externalId, eventType: eventType, type: type, domain: domain, attemptCountGT: attemptCountGT, skip: skip)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

createPollVote

对投票进行投票，或将现有投票移动到不同的选项。每位投票者在每个投票中最多只能有一票，因此对同一投票者再次调用此接口会移动其投票，而不是新增一票。

此接口遵循站点的投票设置：如果投票设置为仅限已登录用户，则仅包含 anonUserId 的投票将被拒绝，并且匿名投票会按 IP 按投票进行速率限制。

参数

名称	类型	位置	必填	描述
tenantId	string	query	是

响应

返回：CreatePollVoteResponse

示例

createPollVote 示例

Copy

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let createPollVoteBody = CreatePollVoteBody(commentId: "commentId_example", optionId: "optionId_example", userId: "userId_example", anonUserId: "anonUserId_example", ip: "ip_example") // CreatePollVoteBody | 
DefaultAPI.createPollVote(tenantId: tenantId, createPollVoteBody: createPollVoteBody) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deletePollVote

撤回投票。投票所投的选项会恢复其计数。

Parameters

名称	类型	位置	必填	描述
tenantId	string	query	是
id	string	path	是

Response

返回：DeletePollVoteResponse

示例

deletePollVote 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
DefaultAPI.deletePollVote(tenantId: tenantId, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getPollVote

参数

名称	类型	位置	必填	描述
tenantId	string	query	Yes
id	string	path	Yes

响应

返回：GetPollVoteResponse

示例

getPollVote 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
DefaultAPI.getPollVote(tenantId: tenantId, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getPollVotes

单个投票背后的各项投票记录，按时间从旧到新排列。

投票属于某条评论，因此投票记录总是按单个投票读取 - commentId 为必填项。这确保每个查询都能利用集合已有的索引。

遵循投票的隐私设置：匿名投票的投票记录无法读取（poll-anonymous），无论是通过此接口还是通过 id。

参数

名称	类型	位置	必填
tenantId	string	query	是
commentId	string	query	是
voterId	string	query	否
optionId	string	query	否
skip	integer	query	否

响应

返回：GetPollVotesResponse

示例

getPollVotes 示例

Copy

// 以下代码示例仍处于测试阶段。如有问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let voterId = "voterId_example" // String |  (optional)
let optionId = "optionId_example" // String |  (optional)
let skip = 987 // Int |  (optional)
DefaultAPI.getPollVotes(tenantId: tenantId, commentId: commentId, options: DefaultAPI.GetPollVotesOptions(voterId: voterId, optionId: optionId, skip: skip)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deletePoll

从其评论中移除投票（poll），以及对其所做的所有投票。评论本身保持不变。

参数

名称	类型	位置	必填	描述
tenantId	string	query	Yes
commentId	string	path	Yes

响应

返回：APIEmptyResponse

示例

deletePoll 示例

Copy

// 以下代码示例仍处于 beta 版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
DefaultAPI.deletePoll(tenantId: tenantId, commentId: commentId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getPoll

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
commentId	string	path	是

响应

返回：GetPollResponse

示例

getPoll 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
DefaultAPI.getPoll(tenantId: tenantId, commentId: commentId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getPollVoters

谁投了哪个选项。匿名投票永不显示答案，只有管理员的投票仅对管理员或版主可见。

参数

名称	类型	位置	必需
tenantId	string	path	Yes
commentId	string	path	Yes
urlId	string	query	No
page	integer	query	No
search	string	query	No
sso	string	query	No

响应

返回: GetPollVoterNamesSuccessResponse

示例

getPollVoters 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let urlId = "urlId_example" // String |  （可选）
let page = 987 // Int |  （可选）
let search = "search_example" // String |  （可选）
let sso = "sso_example" // String |  （可选）
PublicAPI.getPollVoters(tenantId: tenantId, commentId: commentId, options: PublicAPI.GetPollVotersOptions(urlId: urlId, page: page, search: search, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

patchPoll

在原位编辑投票，保留其计数：更改问题，重新标记选项，关闭或重新打开它，
或更改谁可以看到投票者。选项通过 id 定位——要添加、删除或重新排序它们，请 PUT 完整列表。

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
commentId	string	path	是

响应

返回：SavePollResponse

示例

patchPoll 示例

Copy

// 以下代码示例仍处于 beta 版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let commentPollPatch = CommentPollPatch(question: "question_example", options: [CommentPollPatch_options_inner(label: "label_example", id: "id_example")], closesAt: "closesAt_example", privacy: 123, requireVoteToSeeResults: false) // CommentPollPatch | 
DefaultAPI.patchPoll(tenantId: tenantId, commentId: commentId, commentPollPatch: commentPollPatch) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

putPoll

将投票附加到评论，或设置已存在投票的完整状态。

选项通过 id 进行匹配：带有现有选项 id 的选项会保留其投票（并采用新的标签和位置），未提供 id 的选项会被添加，而列表中省略的现有选项则会被删除，连同其已投的票一起移除。

在已有投票的投票中不保留任何现有选项 id 会删除所有选项，因此需要设置 replaceVotes=true。

Parameters

名称	类型	位置	必填
tenantId	string	query	Yes
commentId	string	path	Yes
replaceVotes	boolean	query	No

Response

Returns: SavePollResponse

Example

putPoll 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let commentPollPutInput = CommentPollPutInput(question: "question_example", options: [CommentPollOptionInput(id: "id_example", label: "label_example")], closesAt: "closesAt_example", privacy: 123, requireVoteToSeeResults: false) // CommentPollPutInput | 
let replaceVotes = true // Bool |  (可选)
DefaultAPI.putPoll(tenantId: tenantId, commentId: commentId, commentPollPutInput: commentPollPutInput, replaceVotes: replaceVotes) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

votePoll

参数

名称	类型	位置	必填
tenantId	string	path	是
commentId	string	path	是
urlId	string	query	否
broadcastId	string	query	否
sso	string	query	否

响应

返回：VotePollResponse

示例

votePoll 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let votePollBody = VotePollBody(optionId: "optionId_example") // VotePollBody | 
let urlId = "urlId_example" // String |  (可选)
let broadcastId = "broadcastId_example" // String |  (可选)
let sso = "sso_example" // String |  (可选)
PublicAPI.votePoll(tenantId: tenantId, commentId: commentId, votePollBody: votePollBody, options: PublicAPI.VotePollOptions(urlId: urlId, broadcastId: broadcastId, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

createQuestionConfig

参数

名称	类型	位置	必填	描述
tenantId	string	query	是

响应

返回：CreateQuestionConfigResponse

示例

createQuestionConfig 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let createQuestionConfigBody = CreateQuestionConfigBody(name: "name_example", question: "question_example", helpText: "helpText_example", type: "type_example", numStars: 123, min: 123, max: 123, defaultValue: 123, labelNegative: "labelNegative_example", labelPositive: "labelPositive_example", customOptions: [QuestionConfig_customOptions_inner(imageSrc: "imageSrc_example", name: "name_example")], subQuestionIds: ["subQuestionIds_example"], alwaysShowSubQuestions: false, subQuestionConditions: [SubQuestionCondition(_operator: QuestionConditionOperator(), value: 123, subQuestionId: "subQuestionId_example")], commentBoxCondition: QuestionCondition(_operator: nil, value: 123), commentBoxPrompt: "commentBoxPrompt_example", reportingOrder: 123) // CreateQuestionConfigBody | 
DefaultAPI.createQuestionConfig(tenantId: tenantId, createQuestionConfigBody: createQuestionConfigBody) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deleteQuestionConfig

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
id	string	path	是

响应

返回：APIEmptyResponse

示例

deleteQuestionConfig 示例

Copy

// 下面的代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
DefaultAPI.deleteQuestionConfig(tenantId: tenantId, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getQuestionConfig

参数

Name	Type	Location	Required	Description
tenantId	string	query	是
id	string	path	是

响应

返回：GetQuestionConfigResponse

示例

getQuestionConfig 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
DefaultAPI.getQuestionConfig(tenantId: tenantId, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getQuestionConfigs

参数

Name	Type	Location	Required	Description
tenantId	string	query	是
skip	number	query	否

响应

返回：GetQuestionConfigsResponse

示例

getQuestionConfigs 示例

Copy

// 下列代码示例仍处于测试阶段。如遇任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let skip = 987 // Double |  (可选)
DefaultAPI.getQuestionConfigs(tenantId: tenantId, skip: skip) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

updateQuestionConfig

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
id	string	path	是

响应

返回：APIEmptyResponse

示例

updateQuestionConfig 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let updateQuestionConfigBody = UpdateQuestionConfigBody(name: "name_example", question: "question_example", helpText: "helpText_example", type: "type_example", numStars: 123, min: 123, max: 123, defaultValue: 123, labelNegative: "labelNegative_example", labelPositive: "labelPositive_example", customOptions: [QuestionConfig_customOptions_inner(imageSrc: "imageSrc_example", name: "name_example")], subQuestionIds: ["subQuestionIds_example"], alwaysShowSubQuestions: false, subQuestionConditions: [SubQuestionCondition(_operator: QuestionConditionOperator(), value: 123, subQuestionId: "subQuestionId_example")], commentBoxCondition: QuestionCondition(_operator: nil, value: 123), commentBoxPrompt: "commentBoxPrompt_example", reportingOrder: 123) // UpdateQuestionConfigBody | 
DefaultAPI.updateQuestionConfig(tenantId: tenantId, id: id, updateQuestionConfigBody: updateQuestionConfigBody) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

createQuestionResult

参数

Name	Type	Location	Required	Description
tenantId	string	query	Yes

响应

返回：CreateQuestionResultResponse

示例

createQuestionResult 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let createQuestionResultBody = CreateQuestionResultBody(urlId: "urlId_example", value: 123, values: [123], questionId: "questionId_example", anonUserId: "anonUserId_example", userId: "userId_example", commentId: "commentId_example", meta: [MetaItem(name: "name_example", values: ["values_example"])]) // CreateQuestionResultBody | 
DefaultAPI.createQuestionResult(tenantId: tenantId, createQuestionResultBody: createQuestionResultBody) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deleteQuestionResult

参数

Name	Type	Location	Required	Description
tenantId	string	query	Yes
id	string	path	Yes

响应

返回: APIEmptyResponse

示例

deleteQuestionResult 示例

Copy

// 以下代码示例仍处于测试阶段。如有问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
DefaultAPI.deleteQuestionResult(tenantId: tenantId, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getQuestionResult

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
id	string	path	是

响应

返回：GetQuestionResultResponse

示例

getQuestionResult 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
DefaultAPI.getQuestionResult(tenantId: tenantId, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getQuestionResults

参数

名称	类型	位置	必填
tenantId	string	query	是
urlId	string	query	否
userId	string	query	否
startDate	string	query	否
questionId	string	query	否
questionIds	string	query	否
skip	number	query	否

响应

返回：GetQuestionResultsResponse

示例

getQuestionResults 示例

Copy

// 以下代码示例仍处于测试阶段。若有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let urlId = "urlId_example" // String |  (可选)
let userId = "userId_example" // String |  (可选)
let startDate = "startDate_example" // String |  (可选)
let questionId = "questionId_example" // String |  (可选)
let questionIds = "questionIds_example" // String |  (可选)
let skip = 987 // Double |  (可选)
DefaultAPI.getQuestionResults(tenantId: tenantId, options: DefaultAPI.GetQuestionResultsOptions(urlId: urlId, userId: userId, startDate: startDate, questionId: questionId, questionIds: questionIds, skip: skip)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

updateQuestionResult

参数

名称	类型	位置	必填	描述
tenantId	string	query	Yes
id	string	path	Yes

响应

返回: APIEmptyResponse

示例

updateQuestionResult 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let updateQuestionResultBody = UpdateQuestionResultBody(urlId: "urlId_example", anonUserId: "anonUserId_example", userId: "userId_example", value: 123, values: [123], commentId: "commentId_example", questionId: "questionId_example", meta: [MetaItem(name: "name_example", values: ["values_example"])]) // UpdateQuestionResultBody | 
DefaultAPI.updateQuestionResult(tenantId: tenantId, id: id, updateQuestionResultBody: updateQuestionResultBody) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

aggregateQuestionResults

参数

名称	类型	位置	必需
tenantId	string	query	Yes
questionId	string	query	No
questionIds	array	query	No
urlId	string	query	No
timeBucket	string	query	No
startDate	string	query	No
forceRecalculate	boolean	query	No

响应

返回: AggregateQuestionResultsResponse

示例

aggregateQuestionResults 示例

Copy

// 以下代码示例仍在测试阶段。 如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let questionId = "questionId_example" // String |  (optional) => // String | （可选）
let questionIds = ["inner_example"] // [String] |  (optional) => // [String] | （可选）
let urlId = "urlId_example" // String |  (optional) => // String | （可选）
let timeBucket = AggregateTimeBucket() // AggregateTimeBucket |  (optional) => // AggregateTimeBucket | （可选）
let startDate = Date() // Date |  (optional) => // Date | （可选）
let forceRecalculate = true // Bool |  (optional) => // Bool | （可选）
DefaultAPI.aggregateQuestionResults(tenantId: tenantId, options: DefaultAPI.AggregateQuestionResultsOptions(questionId: questionId, questionIds: questionIds, urlId: urlId, timeBucket: timeBucket, startDate: startDate, forceRecalculate: forceRecalculate)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

bulkAggregateQuestionResults

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
forceRecalculate	boolean	query	否

响应

返回：BulkAggregateQuestionResultsResponse

示例

bulkAggregateQuestionResults 示例

Copy

// 以下代码示例仍处于测试阶段。如遇任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let bulkAggregateQuestionResultsRequest = BulkAggregateQuestionResultsRequest(aggregations: [BulkAggregateQuestionItem(aggId: "aggId_example", questionId: "questionId_example", questionIds: ["questionIds_example"], urlId: "urlId_example", timeBucket: AggregateTimeBucket(), startDate: Date())]) // BulkAggregateQuestionResultsRequest | 
let forceRecalculate = true // Bool |  (可选)
DefaultAPI.bulkAggregateQuestionResults(tenantId: tenantId, bulkAggregateQuestionResultsRequest: bulkAggregateQuestionResultsRequest, forceRecalculate: forceRecalculate) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

combineCommentsWithQuestionResults

参数

名称	类型	位置	必需
tenantId	string	query	是
questionId	string	query	否
questionIds	array	query	否
urlId	string	query	否
startDate	string	query	否
forceRecalculate	boolean	query	否
minValue	number	query	否
maxValue	number	query	否
limit	number	query	否

响应

返回：CombineQuestionResultsWithCommentsResponse

示例

combineCommentsWithQuestionResults 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 提交报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let questionId = "questionId_example" // String |  (可选)
let questionIds = ["inner_example"] // [String] |  (可选)
let urlId = "urlId_example" // String |  (可选)
let startDate = Date() // Date |  (可选)
let forceRecalculate = true // Bool |  (可选)
let minValue = 987 // Double |  (可选)
let maxValue = 987 // Double |  (可选)
let limit = 987 // Double |  (可选)
DefaultAPI.combineCommentsWithQuestionResults(tenantId: tenantId, options: DefaultAPI.CombineCommentsWithQuestionResultsOptions(questionId: questionId, questionIds: questionIds, urlId: urlId, startDate: startDate, forceRecalculate: forceRecalculate, minValue: minValue, maxValue: maxValue, limit: limit)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

addSSOUser

参数

Name	Type	Location	Required	Description
tenantId	string	query	是

响应

返回：AddSSOUserAPIResponse

示例

addSSOUser 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let createAPISSOUserData = CreateAPISSOUserData(groupIds: ["groupIds_example"], hasBlockedUsers: false, isProfileDMDisabled: false, isProfileCommentsPrivate: false, isProfileActivityPrivate: false, isCommentModeratorAdmin: false, isAdminAdmin: false, isAccountOwner: false, displayName: "displayName_example", displayLabel: "displayLabel_example", optedInSubscriptionNotifications: false, optedInNotifications: false, avatarSrc: "avatarSrc_example", loginCount: 123, createdFromUrlId: "createdFromUrlId_example", signUpDate: 123, email: "email_example", websiteUrl: "websiteUrl_example", username: "username_example", id: "id_example") // CreateAPISSOUserData | 
DefaultAPI.addSSOUser(tenantId: tenantId, createAPISSOUserData: createAPISSOUserData) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deleteSSOUser

参数

Name	Type	Location	Required
tenantId	string	query	Yes
id	string	path	Yes
deleteComments	boolean	query	No
commentDeleteMode	string	query	No

响应

返回: DeleteSSOUserAPIResponse

示例

deleteSSOUser 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let deleteComments = true // Bool |  (optional)
let commentDeleteMode = "commentDeleteMode_example" // String |  (optional)
DefaultAPI.deleteSSOUser(tenantId: tenantId, id: id, options: DefaultAPI.DeleteSSOUserOptions(deleteComments: deleteComments, commentDeleteMode: commentDeleteMode)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getSSOUserByEmail

参数

Name	Type	Location	Required	Description
tenantId	string	query	是
email	string	path	是

响应

返回：GetSSOUserByEmailAPIResponse

示例

getSSOUserByEmail 示例

Copy

// 以下代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let email = "email_example" // String | 
DefaultAPI.getSSOUserByEmail(tenantId: tenantId, email: email) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getSSOUserById

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
id	string	path	是

响应

返回: GetSSOUserByIdAPIResponse

示例

getSSOUserById 示例

Copy

// 以下代码示例仍处于测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
DefaultAPI.getSSOUserById(tenantId: tenantId, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getSSOUsers

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
skip	integer	query	否

响应

返回: GetSSOUsersResponse

示例

getSSOUsers 示例

Copy

// 以下代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // 字符串 | 
let skip = 987 // 整数 |  (可选)
DefaultAPI.getSSOUsers(tenantId: tenantId, skip: skip) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

patchSSOUser

参数

名称	类型	位置	必填
tenantId	string	query	是
id	string	path	是
updateComments	boolean	query	否

响应

返回: PatchSSOUserAPIResponse

示例

patchSSOUser 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let updateAPISSOUserData = UpdateAPISSOUserData(groupIds: ["groupIds_example"], hasBlockedUsers: false, isProfileDMDisabled: false, isProfileCommentsPrivate: false, isProfileActivityPrivate: false, isCommentModeratorAdmin: false, isAdminAdmin: false, isAccountOwner: false, displayName: "displayName_example", displayLabel: "displayLabel_example", optedInSubscriptionNotifications: false, optedInNotifications: false, avatarSrc: "avatarSrc_example", loginCount: 123, createdFromUrlId: "createdFromUrlId_example", signUpDate: 123, email: "email_example", websiteUrl: "websiteUrl_example", username: "username_example", id: "id_example") // UpdateAPISSOUserData | 
let updateComments = true // Bool |  (optional)
DefaultAPI.patchSSOUser(tenantId: tenantId, id: id, updateAPISSOUserData: updateAPISSOUserData, updateComments: updateComments) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

putSSOUser

参数

Name	Type	Location	Required
tenantId	string	query	是
id	string	path	是
updateComments	boolean	query	否

响应

返回: PutSSOUserAPIResponse

示例

putSSOUser 示例

Copy

// 以下代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let updateAPISSOUserData = UpdateAPISSOUserData(groupIds: ["groupIds_example"], hasBlockedUsers: false, isProfileDMDisabled: false, isProfileCommentsPrivate: false, isProfileActivityPrivate: false, isCommentModeratorAdmin: false, isAdminAdmin: false, isAccountOwner: false, displayName: "displayName_example", displayLabel: "displayLabel_example", optedInSubscriptionNotifications: false, optedInNotifications: false, avatarSrc: "avatarSrc_example", loginCount: 123, createdFromUrlId: "createdFromUrlId_example", signUpDate: 123, email: "email_example", websiteUrl: "websiteUrl_example", username: "username_example", id: "id_example") // UpdateAPISSOUserData | 
let updateComments = true // Bool |  (可选)
DefaultAPI.putSSOUser(tenantId: tenantId, id: id, updateAPISSOUserData: updateAPISSOUserData, updateComments: updateComments) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

createSubscription

参数

Name	Type	Location	Required	Description
tenantId	string	query	是

响应

返回: CreateSubscriptionAPIResponse

示例

createSubscription 示例

Copy

// 以下代码示例仍处于测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let createAPIUserSubscriptionData = CreateAPIUserSubscriptionData(notificationFrequency: 123, pageTitle: "pageTitle_example", url: "url_example", urlId: "urlId_example", anonUserId: "anonUserId_example", userId: "userId_example") // CreateAPIUserSubscriptionData | 
DefaultAPI.createSubscription(tenantId: tenantId, createAPIUserSubscriptionData: createAPIUserSubscriptionData) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deleteSubscription

参数

Name	Type	Location	Required
tenantId	string	query	是
id	string	path	是
userId	string	query	否

响应

返回：DeleteSubscriptionAPIResponse

示例

deleteSubscription 示例

Copy

// 以下代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let userId = "userId_example" // String |  (可选)
DefaultAPI.deleteSubscription(tenantId: tenantId, id: id, userId: userId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getSubscriptions

参数

Name	Type	Location	Required	Description
tenantId	string	query	是
userId	string	query	否

响应

返回: GetSubscriptionsAPIResponse

示例

getSubscriptions 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let userId = "userId_example" // String |  (可选)
DefaultAPI.getSubscriptions(tenantId: tenantId, userId: userId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

updateSubscription

参数

Name	Type	Location	Required
tenantId	string	query	是
id	string	path	是
userId	string	query	否

响应

返回: UpdateSubscriptionAPIResponse

示例

updateSubscription 示例

Copy

// 以下代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let updateAPIUserSubscriptionData = UpdateAPIUserSubscriptionData(notificationFrequency: 123) // UpdateAPIUserSubscriptionData | 
let userId = "userId_example" // String |  (可选)
DefaultAPI.updateSubscription(tenantId: tenantId, id: id, updateAPIUserSubscriptionData: updateAPIUserSubscriptionData, userId: userId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getTenantDailyUsages

参数

名称	类型	位置	必填
tenantId	string	query	是
yearNumber	number	query	否
monthNumber	number	query	否
dayNumber	number	query	否
skip	number	query	否

响应

返回: GetTenantDailyUsagesResponse

示例

getTenantDailyUsages 示例

Copy

// 以下代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let yearNumber = 987 // Double |  (可选)
let monthNumber = 987 // Double |  (可选)
let dayNumber = 987 // Double |  (可选)
let skip = 987 // Double |  (可选)
DefaultAPI.getTenantDailyUsages(tenantId: tenantId, options: DefaultAPI.GetTenantDailyUsagesOptions(yearNumber: yearNumber, monthNumber: monthNumber, dayNumber: dayNumber, skip: skip)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

createTenantPackage

参数

名称	类型	位置	必需	描述
tenantId	string	query	是

响应

返回: CreateTenantPackageResponse

示例

createTenantPackage 示例

Copy

// 以下代码示例仍处于测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let createTenantPackageBody = CreateTenantPackageBody(name: "name_example", monthlyCostUSD: 123, yearlyCostUSD: 123, monthlyStripePlanId: "monthlyStripePlanId_example", yearlyStripePlanId: "yearlyStripePlanId_example", maxMonthlyPageLoads: 123, maxMonthlyAPICredits: 123, maxMonthlySmallWidgetsCredits: 123, maxMonthlyComments: 123, maxConcurrentUsers: 123, maxTenantUsers: 123, maxSSOUsers: 123, maxModerators: 123, maxDomains: 123, maxWhiteLabeledTenants: 123, maxMonthlyEventLogRequests: 123, maxCustomCollectionSize: 123, hasWhiteLabeling: false, hasDebranding: false, hasLLMSpamDetection: false, forWhoText: "forWhoText_example", featureTaglines: ["featureTaglines_example"], hasAuditing: false, hasFlexPricing: false, enableSAML: false, flexPageLoadCostCents: 123, flexPageLoadUnit: 123, flexCommentCostCents: 123, flexCommentUnit: 123, flexSSOUserCostCents: 123, flexSSOUserUnit: 123, flexAPICreditCostCents: 123, flexAPICreditUnit: 123, flexSmallWidgetsCreditCostCents: 123, flexSmallWidgetsCreditUnit: 123, flexModeratorCostCents: 123, flexModeratorUnit: 123, flexAdminCostCents: 123, flexAdminUnit: 123, flexDomainCostCents: 123, flexDomainUnit: 123, flexLLMCostCents: 123, flexLLMUnit: 123, flexMinimumCostCents: 123, flexManagedTenantCostCents: 123, flexSSOAdminCostCents: 123, flexSSOAdminUnit: 123, flexSSOModeratorCostCents: 123, flexSSOModeratorUnit: 123) // CreateTenantPackageBody | 
DefaultAPI.createTenantPackage(tenantId: tenantId, createTenantPackageBody: createTenantPackageBody) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deleteTenantPackage

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
id	string	path	是

响应

返回: APIEmptyResponse

示例

deleteTenantPackage 示例

Copy

// 以下代码示例仍为测试版。如遇任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
DefaultAPI.deleteTenantPackage(tenantId: tenantId, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getTenantPackage

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
id	string	path	是

响应

返回: GetTenantPackageResponse

示例

getTenantPackage 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // 字符串 | 
let id = "id_example" // 字符串 | 
DefaultAPI.getTenantPackage(tenantId: tenantId, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getTenantPackages

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
skip	number	query	否

响应

返回: GetTenantPackagesResponse

示例

getTenantPackages 示例

Copy

// 以下代码示例仍为测试版。若有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let skip = 987 // Double |  (可选)
DefaultAPI.getTenantPackages(tenantId: tenantId, skip: skip) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

replaceTenantPackage

参数

Name	Type	Location	Required	Description
tenantId	string	query	是
id	string	path	是

响应

返回: APIEmptyResponse

示例

replaceTenantPackage 示例

Copy

// 以下代码示例仍处于测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let replaceTenantPackageBody = ReplaceTenantPackageBody(name: "name_example", monthlyCostUSD: 123, yearlyCostUSD: 123, maxMonthlyPageLoads: 123, maxMonthlyAPICredits: 123, maxMonthlyComments: 123, maxConcurrentUsers: 123, maxTenantUsers: 123, maxSSOUsers: 123, maxModerators: 123, maxDomains: 123, maxCustomCollectionSize: 123, hasDebranding: false, forWhoText: "forWhoText_example", featureTaglines: ["featureTaglines_example"], hasFlexPricing: false, flexPageLoadCostCents: 123, flexPageLoadUnit: 123, flexCommentCostCents: 123, flexCommentUnit: 123, flexSSOUserCostCents: 123, flexSSOUserUnit: 123, flexAPICreditCostCents: 123, flexAPICreditUnit: 123, flexModeratorCostCents: 123, flexModeratorUnit: 123, flexAdminCostCents: 123, flexAdminUnit: 123, flexDomainCostCents: 123, flexDomainUnit: 123, flexMinimumCostCents: 123) // ReplaceTenantPackageBody | 
DefaultAPI.replaceTenantPackage(tenantId: tenantId, id: id, replaceTenantPackageBody: replaceTenantPackageBody) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

updateTenantPackage

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
id	string	path	是

响应

返回: APIEmptyResponse

示例

updateTenantPackage 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let updateTenantPackageBody = UpdateTenantPackageBody(name: "name_example", monthlyCostUSD: 123, yearlyCostUSD: 123, maxMonthlyPageLoads: 123, maxMonthlyAPICredits: 123, maxMonthlyComments: 123, maxConcurrentUsers: 123, maxTenantUsers: 123, maxSSOUsers: 123, maxModerators: 123, maxDomains: 123, maxCustomCollectionSize: 123, hasDebranding: false, hasWhiteLabeling: false, forWhoText: "forWhoText_example", featureTaglines: ["featureTaglines_example"], hasFlexPricing: false, flexPageLoadCostCents: 123, flexPageLoadUnit: 123, flexCommentCostCents: 123, flexCommentUnit: 123, flexSSOUserCostCents: 123, flexSSOUserUnit: 123, flexAPICreditCostCents: 123, flexAPICreditUnit: 123, flexModeratorCostCents: 123, flexModeratorUnit: 123, flexAdminCostCents: 123, flexAdminUnit: 123, flexDomainCostCents: 123, flexDomainUnit: 123, flexMinimumCostCents: 123) // UpdateTenantPackageBody | 
DefaultAPI.updateTenantPackage(tenantId: tenantId, id: id, updateTenantPackageBody: updateTenantPackageBody) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

createTenantUser

参数

Name	Type	Location	Required	Description
tenantId	string	query	是

Response

返回: CreateTenantUserResponse

示例

createTenantUser 示例

Copy

// 以下代码示例仍处于测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let createTenantUserBody = CreateTenantUserBody(username: "username_example", email: "email_example", displayName: "displayName_example", websiteUrl: "websiteUrl_example", signUpDate: 123, locale: "locale_example", verified: false, loginCount: 123, optedInNotifications: false, optedInTenantNotifications: false, hideAccountCode: false, avatarSrc: "avatarSrc_example", isHelpRequestAdmin: false, isAccountOwner: false, isAdminAdmin: false, isBillingAdmin: false, isAnalyticsAdmin: false, isCustomizationAdmin: false, isManageDataAdmin: false, isCommentModeratorAdmin: false, isAPIAdmin: false, moderatorIds: ["moderatorIds_example"], digestEmailFrequency: 123, displayLabel: "displayLabel_example") // CreateTenantUserBody | 
DefaultAPI.createTenantUser(tenantId: tenantId, createTenantUserBody: createTenantUserBody) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deleteTenantUser

参数

名称	类型	位置	必填
tenantId	string	query	是
id	string	path	是
deleteComments	string	query	否
commentDeleteMode	string	query	否

响应

返回：APIEmptyResponse

示例

deleteTenantUser 示例

Copy

// 以下代码示例仍处于测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let deleteComments = "deleteComments_example" // String |  (optional)
let commentDeleteMode = "commentDeleteMode_example" // String |  (optional)
DefaultAPI.deleteTenantUser(tenantId: tenantId, id: id, options: DefaultAPI.DeleteTenantUserOptions(deleteComments: deleteComments, commentDeleteMode: commentDeleteMode)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getTenantUser

参数

Name	Type	Location	Required	Description
tenantId	string	query	Yes
id	string	path	Yes

Response

返回: GetTenantUserResponse

示例

getTenantUser 示例

Copy

// 以下代码示例仍处于测试版。如遇任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
DefaultAPI.getTenantUser(tenantId: tenantId, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getTenantUsers

参数

Name	Type	Location	Required	Description
tenantId	string	query	是
skip	number	query	否

响应

返回: GetTenantUsersResponse

示例

getTenantUsers 示例

Copy

// 以下代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 提交报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let skip = 987 // Double |  (可选)
DefaultAPI.getTenantUsers(tenantId: tenantId, skip: skip) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

replaceTenantUser

参数

Name	Type	Location	Required
tenantId	string	query	是
id	string	path	是
updateComments	string	query	否

响应

返回: APIEmptyResponse

示例

replaceTenantUser 示例

Copy

// 以下代码示例仍处于测试版。如遇到任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let replaceTenantUserBody = ReplaceTenantUserBody(username: "username_example", email: "email_example", displayName: "displayName_example", websiteUrl: "websiteUrl_example", signUpDate: 123, locale: "locale_example", verified: false, loginCount: 123, optedInNotifications: false, optedInTenantNotifications: false, hideAccountCode: false, avatarSrc: "avatarSrc_example", isHelpRequestAdmin: false, isAccountOwner: false, isAdminAdmin: false, isBillingAdmin: false, isAnalyticsAdmin: false, isCustomizationAdmin: false, isManageDataAdmin: false, isCommentModeratorAdmin: false, isAPIAdmin: false, moderatorIds: ["moderatorIds_example"], digestEmailFrequency: 123, displayLabel: "displayLabel_example", createdFromUrlId: "createdFromUrlId_example", createdFromTenantId: "createdFromTenantId_example", lastLoginDate: 123, karma: 123) // ReplaceTenantUserBody | 
let updateComments = "updateComments_example" // String |  (可选)
DefaultAPI.replaceTenantUser(tenantId: tenantId, id: id, replaceTenantUserBody: replaceTenantUserBody, updateComments: updateComments) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

sendLoginLink

参数

Name	Type	Location	Required
tenantId	string	query	是
id	string	path	是
redirectURL	string	query	否

响应

返回: APIEmptyResponse

示例

sendLoginLink 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let redirectURL = "redirectURL_example" // String |  (可选)
DefaultAPI.sendLoginLink(tenantId: tenantId, id: id, redirectURL: redirectURL) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

updateTenantUser

参数

Name	Type	Location	Required
tenantId	string	query	是
id	string	path	是
updateComments	string	query	否

响应

返回：APIEmptyResponse

示例

updateTenantUser 示例

Copy

// 以下代码示例仍处于测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let updateTenantUserBody = UpdateTenantUserBody(username: "username_example", displayName: "displayName_example", websiteUrl: "websiteUrl_example", email: "email_example", signUpDate: 123, verified: false, loginCount: 123, optedInNotifications: false, optedInTenantNotifications: false, hideAccountCode: false, avatarSrc: "avatarSrc_example", isHelpRequestAdmin: false, isAccountOwner: false, isAdminAdmin: false, isBillingAdmin: false, isAnalyticsAdmin: false, isCustomizationAdmin: false, isManageDataAdmin: false, isCommentModeratorAdmin: false, isAPIAdmin: false, moderatorIds: ["moderatorIds_example"], locale: "locale_example", digestEmailFrequency: 123, displayLabel: "displayLabel_example") // UpdateTenantUserBody | 
let updateComments = "updateComments_example" // String |  (可选)
DefaultAPI.updateTenantUser(tenantId: tenantId, id: id, updateTenantUserBody: updateTenantUserBody, updateComments: updateComments) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

createTenant

参数

名称	类型	位置	必填	描述
tenantId	string	query	是

响应

返回：CreateTenantResponse

示例

createTenant 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let createTenantBody = CreateTenantBody(name: "name_example", domainConfiguration: [APIDomainConfiguration(id: "id_example", domain: "domain_example", emailFromName: "emailFromName_example", emailFromEmail: "emailFromEmail_example", emailHeaders: "TODO", wpSyncToken: "wpSyncToken_example", wpSynced: false, wpURL: "wpURL_example", createdAt: Date(), autoAddedDate: Date(), siteType: ImportedSiteType(), logoSrc: "logoSrc_example", logoSrc100px: "logoSrc100px_example", footerUnsubscribeURL: "footerUnsubscribeURL_example", disableUnsubscribeLinks: false)], email: "email_example", signUpDate: 123, packageId: "packageId_example", paymentFrequency: 123, billingInfoValid: false, billingHandledExternally: false, isSetup: false, billingInfo: BillingInfo(name: "name_example", address: "address_example", city: "city_example", state: "state_example", zip: "zip_example", country: "country_example", currency: "currency_example", email: "email_example", vatId: "vatId_example"), stripeCustomerId: "stripeCustomerId_example", stripeSubscriptionId: "stripeSubscriptionId_example", stripePlanId: "stripePlanId_example", enableProfanityFilter: false, enableSpamFilter: false, removeUnverifiedComments: false, unverifiedCommentsTTLms: 123, commentsRequireApproval: false, autoApproveCommentOnVerification: false, sendProfaneToSpam: false, deAnonIpAddr: 123, meta: "TODO") // CreateTenantBody | 
DefaultAPI.createTenant(tenantId: tenantId, createTenantBody: createTenantBody) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deleteTenant

参数

Name	Type	Location	Required
tenantId	string	query	是
id	string	path	是
sure	string	query	否

响应

返回：APIEmptyResponse

示例

deleteTenant 示例

Copy

// 以下代码样例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let sure = "sure_example" // String |  (可选)
DefaultAPI.deleteTenant(tenantId: tenantId, id: id, sure: sure) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getTenant

参数

Name	Type	Location	Required	Description
tenantId	string	query	是
id	string	path	是

响应

返回: GetTenantResponse

示例

getTenant 示例

Copy

// 以下代码示例仍处于测试版。如有问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
DefaultAPI.getTenant(tenantId: tenantId, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getTenants

参数

名称	类型	位置	必填
tenantId	string	query	是
meta	string	query	否
skip	number	query	否

响应

返回：GetTenantsResponse

示例

getTenants 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let meta = "meta_example" // String |  (可选)
let skip = 987 // Double |  (可选)
DefaultAPI.getTenants(tenantId: tenantId, options: DefaultAPI.GetTenantsOptions(meta: meta, skip: skip)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

updateTenant

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
id	string	path	是

响应

返回: APIEmptyResponse

示例

updateTenant 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let updateTenantBody = UpdateTenantBody(name: "name_example", email: "email_example", signUpDate: 123, packageId: "packageId_example", paymentFrequency: 123, billingInfoValid: false, billingHandledExternally: false, isSetup: false, domainConfiguration: [APIDomainConfiguration(id: "id_example", domain: "domain_example", emailFromName: "emailFromName_example", emailFromEmail: "emailFromEmail_example", emailHeaders: "TODO", wpSyncToken: "wpSyncToken_example", wpSynced: false, wpURL: "wpURL_example", createdAt: Date(), autoAddedDate: Date(), siteType: ImportedSiteType(), logoSrc: "logoSrc_example", logoSrc100px: "logoSrc100px_example", footerUnsubscribeURL: "footerUnsubscribeURL_example", disableUnsubscribeLinks: false)], billingInfo: BillingInfo(name: "name_example", address: "address_example", city: "city_example", state: "state_example", zip: "zip_example", country: "country_example", currency: "currency_example", email: "email_example", vatId: "vatId_example"), stripeCustomerId: "stripeCustomerId_example", stripeSubscriptionId: "stripeSubscriptionId_example", stripePlanId: "stripePlanId_example", enableProfanityFilter: false, enableSpamFilter: false, removeUnverifiedComments: false, unverifiedCommentsTTLms: 123, commentsRequireApproval: false, autoApproveCommentOnVerification: false, sendProfaneToSpam: false, deAnonIpAddr: 123, meta: "TODO", managedByTenantId: "managedByTenantId_example") // UpdateTenantBody | 
DefaultAPI.updateTenant(tenantId: tenantId, id: id, updateTenantBody: updateTenantBody) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

changeTicketState

参数

Name	Type	Location	Required
tenantId	string	query	是
userId	string	query	是
id	string	path	是

响应

返回: ChangeTicketStateResponse

示例

changeTicketState 示例

Copy

// 以下代码示例仍处于测试版。如遇问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let userId = "userId_example" // String | 
let id = "id_example" // String | 
let changeTicketStateBody = ChangeTicketStateBody(state: 123) // ChangeTicketStateBody | 
DefaultAPI.changeTicketState(tenantId: tenantId, userId: userId, id: id, changeTicketStateBody: changeTicketStateBody) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

createTicket

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
userId	string	query	是

响应

返回: CreateTicketResponse

示例

createTicket 示例

Copy

// 以下代码示例仍处于测试阶段。如遇任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let userId = "userId_example" // String | 
let createTicketBody = CreateTicketBody(subject: "subject_example") // CreateTicketBody | 
DefaultAPI.createTicket(tenantId: tenantId, userId: userId, createTicketBody: createTicketBody) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getTicket

参数

Name	Type	Location	Required
tenantId	string	query	是
id	string	path	是
userId	string	query	否

响应

返回: GetTicketResponse

示例

getTicket 示例

Copy

// 以下代码示例仍处于测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let userId = "userId_example" // String |  (可选)
DefaultAPI.getTicket(tenantId: tenantId, id: id, userId: userId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getTickets

参数

名称	类型	位置	必填
tenantId	string	query	是
userId	string	query	否
state	number	query	否
skip	number	query	否
limit	number	query	否

响应

返回：GetTicketsResponse

示例

getTickets 示例

Copy

// 以下代码示例仍处于 beta 版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let userId = "userId_example" // String |  (可选)
let state = 987 // Double |  (可选)
let skip = 987 // Double |  (可选)
let limit = 987 // Double |  (可选)
DefaultAPI.getTickets(tenantId: tenantId, options: DefaultAPI.GetTicketsOptions(userId: userId, state: state, skip: skip, limit: limit)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getTranslations

参数

名称	类型	位置	必需
namespace	string	path	是
component	string	path	是
locale	string	query	否
useFullTranslationIds	boolean	query	否

响应

返回：GetTranslationsResponse

示例

getTranslations 示例

Copy

// 以下代码示例仍处于beta阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let namespace = "namespace_example" // String | 
let component = "component_example" // String | 
let locale = "locale_example" // String |  （可选）
let useFullTranslationIds = true // Bool |  （可选）
PublicAPI.getTranslations(namespace: namespace, component: component, options: PublicAPI.GetTranslationsOptions(locale: locale, useFullTranslationIds: useFullTranslationIds)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

uploadImage

上传并调整图像大小

参数

名称	类型	位置	必需	描述
tenantId	string	path	Yes
sizePreset	string	query	No	尺寸预设："Default" (1000x1000px) 或 "CrossPlatform" (为流行设备创建尺寸)
urlId	string	query	No	上传所在页面的 ID，用于配置

响应

Returns: UploadImageResponse

示例

uploadImage 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let file = URL(string: "https://example.com")! // URL | 
let sizePreset = SizePreset() // SizePreset | 尺寸预设：\"Default\" (1000x1000px) 或 \"CrossPlatform\" (为流行设备创建尺寸) (可选)
let urlId = "urlId_example" // String | 上传所在页面的 ID，用于配置 (可选)
PublicAPI.uploadImage(tenantId: tenantId, file: file, options: PublicAPI.UploadImageOptions(sizePreset: sizePreset, urlId: urlId)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getUserBadgeProgressById

参数

名称	类型	位置	必填	说明
tenantId	string	query	是
id	string	path	是

响应

返回: APIGetUserBadgeProgressResponse

示例

getUserBadgeProgressById 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // 字符串 | 
let id = "id_example" // 字符串 | 
DefaultAPI.getUserBadgeProgressById(tenantId: tenantId, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getUserBadgeProgressByUserId

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
userId	string	path	是

响应

返回: APIGetUserBadgeProgressResponse

示例

getUserBadgeProgressByUserId 示例

Copy

// 以下代码示例仍处于测试阶段。如有问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let userId = "userId_example" // String | 
DefaultAPI.getUserBadgeProgressByUserId(tenantId: tenantId, userId: userId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getUserBadgeProgressList

参数

名称	类型	位置	必需
tenantId	string	query	是
userId	string	query	否
limit	number	query	否
skip	number	query	否

响应

返回: APIGetUserBadgeProgressListResponse

示例

getUserBadgeProgressList 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let userId = "userId_example" // String |  （可选）
let limit = 987 // Double |  （可选）
let skip = 987 // Double |  （可选）
DefaultAPI.getUserBadgeProgressList(tenantId: tenantId, options: DefaultAPI.GetUserBadgeProgressListOptions(userId: userId, limit: limit, skip: skip)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

createUserBadge

参数

名称	类型	位置	必填	描述
tenantId	string	query	是

响应

返回：APICreateUserBadgeResponse

示例

createUserBadge 示例

Copy

// 以下代码示例仍处于测试阶段。如遇任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let createUserBadgeParams = CreateUserBadgeParams(userId: "userId_example", badgeId: "badgeId_example", displayedOnComments: false) // CreateUserBadgeParams | 
DefaultAPI.createUserBadge(tenantId: tenantId, createUserBadgeParams: createUserBadgeParams) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deleteUserBadge

参数

Name	Type	Location	Required	Description
tenantId	string	query	是
id	string	path	是

响应

返回: APIEmptySuccessResponse

示例

deleteUserBadge 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // 字符串 | 
let id = "id_example" // 字符串 | 
DefaultAPI.deleteUserBadge(tenantId: tenantId, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getUserBadge

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
id	string	path	是

响应

返回: APIGetUserBadgeResponse

示例

getUserBadge 示例

Copy

// 以下代码示例仍处于测试版。如遇任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
DefaultAPI.getUserBadge(tenantId: tenantId, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getUserBadges

参数

名称	类型	位置	必填
tenantId	string	查询	是
userId	string	查询	否
badgeId	string	查询	否
type	number	查询	否
displayedOnComments	boolean	查询	否
limit	number	查询	否
skip	number	查询	否

响应

返回: APIGetUserBadgesResponse

示例

getUserBadges 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let userId = "userId_example" // String |  （可选）
let badgeId = "badgeId_example" // String |  （可选）
let type = 987 // Double |  （可选）
let displayedOnComments = true // Bool |  （可选）
let limit = 987 // Double |  （可选）
let skip = 987 // Double |  （可选）
DefaultAPI.getUserBadges(tenantId: tenantId, options: DefaultAPI.GetUserBadgesOptions(userId: userId, badgeId: badgeId, type: type, displayedOnComments: displayedOnComments, limit: limit, skip: skip)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

updateUserBadge

参数

Name	Type	Location	Required	Description
tenantId	string	query	是
id	string	path	是

响应

返回: APIEmptySuccessResponse

示例

updateUserBadge 示例

Copy

// 以下代码示例仍处于测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let updateUserBadgeParams = UpdateUserBadgeParams(displayedOnComments: false) // UpdateUserBadgeParams | 
DefaultAPI.updateUserBadge(tenantId: tenantId, id: id, updateUserBadgeParams: updateUserBadgeParams) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getUserNotificationCount

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
sso	string	query	否

响应

返回: GetUserNotificationCountResponse

示例

getUserNotificationCount 示例

Copy

// 以下代码示例仍为测试版。如有问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let sso = "sso_example" // String |  (可选)
PublicAPI.getUserNotificationCount(tenantId: tenantId, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getUserNotifications

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
urlId	string	query	否	用于确定当前页面是否已订阅。
pageSize	integer	query	否
afterId	string	query	否
includeContext	boolean	query	否
afterCreatedAt	integer	query	否
unreadOnly	boolean	query	否
dmOnly	boolean	query	否
noDm	boolean	query	否
includeTranslations	boolean	query	否
includeTenantNotifications	boolean	query	否
sso	string	query	否

响应

返回：GetMyNotificationsResponse

示例

获取用户通知示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let urlId = "urlId_example" // String | 用于确定当前页面是否已订阅。 （可选）
let pageSize = 987 // Int | （可选）
let afterId = "afterId_example" // String | （可选）
let includeContext = true // Bool | （可选）
let afterCreatedAt = 987 // Int64 | （可选）
let unreadOnly = true // Bool | （可选）
let dmOnly = true // Bool | （可选）
let noDm = true // Bool | （可选）
let includeTranslations = true // Bool | （可选）
let includeTenantNotifications = true // Bool | （可选）
let sso = "sso_example" // String | （可选）
PublicAPI.getUserNotifications(tenantId: tenantId, options: PublicAPI.GetUserNotificationsOptions(urlId: urlId, pageSize: pageSize, afterId: afterId, includeContext: includeContext, afterCreatedAt: afterCreatedAt, unreadOnly: unreadOnly, dmOnly: dmOnly, noDm: noDm, includeTranslations: includeTranslations, includeTenantNotifications: includeTenantNotifications, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

resetUserNotificationCount

参数

Name	Type	Location	Required	Description
tenantId	string	query	是
sso	string	query	否

响应

返回：ResetUserNotificationsResponse

示例

resetUserNotificationCount 示例

Copy

// 以下代码示例仍处于测试阶段。如遇到任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let sso = "sso_example" // String |  (可选)
PublicAPI.resetUserNotificationCount(tenantId: tenantId, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

resetUserNotifications

参数

名称	类型	位置	必需
tenantId	string	query	Yes
afterId	string	query	No
afterCreatedAt	integer	query	No
unreadOnly	boolean	query	No
dmOnly	boolean	query	No
noDm	boolean	query	No
sso	string	query	No

响应

返回: ResetUserNotificationsResponse

示例

resetUserNotifications 示例

Copy

// 以下代码示例仍为 Beta 版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let afterId = "afterId_example" // String |  (可选)
let afterCreatedAt = 987 // Int64 |  (可选)
let unreadOnly = true // Bool |  (可选)
let dmOnly = true // Bool |  (可选)
let noDm = true // Bool |  (可选)
let sso = "sso_example" // String |  (可选)
PublicAPI.resetUserNotifications(tenantId: tenantId, options: PublicAPI.ResetUserNotificationsOptions(afterId: afterId, afterCreatedAt: afterCreatedAt, unreadOnly: unreadOnly, dmOnly: dmOnly, noDm: noDm, sso: sso)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

updateUserNotificationCommentSubscriptionStatus

启用或禁用针对特定评论的通知。

参数

名称	类型	位置	必填
tenantId	string	查询	是
notificationId	string	路径	是
optedInOrOut	string	路径	是
commentId	string	查询	是
sso	string	查询	否

响应

返回：UpdateUserNotificationCommentSubscriptionStatusResponse

示例

updateUserNotificationCommentSubscriptionStatus 示例

Copy

// 以下代码示例仍处于测试版。如遇问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // 字符串 | 
let notificationId = "notificationId_example" // 字符串 | 
let optedInOrOut = "optedInOrOut_example" // 字符串 | 
let commentId = "commentId_example" // 字符串 | 
let sso = "sso_example" // 字符串 |  (可选)
PublicAPI.updateUserNotificationCommentSubscriptionStatus(tenantId: tenantId, notificationId: notificationId, optedInOrOut: optedInOrOut, commentId: commentId, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

updateUserNotificationPageSubscriptionStatus

启用或禁用页面的通知。当用户订阅页面时，会为新的根评论创建通知，并且还会

参数

名称	类型	位置	必填
tenantId	string	query	是
urlId	string	query	是
url	string	query	是
pageTitle	string	query	是
subscribedOrUnsubscribed	string	path	是
sso	string	query	否

响应

返回: UpdateUserNotificationPageSubscriptionStatusResponse

示例

updateUserNotificationPageSubscriptionStatus 示例

Copy

// 以下代码示例仍处于测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let urlId = "urlId_example" // String | 
let url = "url_example" // String | 
let pageTitle = "pageTitle_example" // String | 
let subscribedOrUnsubscribed = "subscribedOrUnsubscribed_example" // String | 
let sso = "sso_example" // String |  (optional)
PublicAPI.updateUserNotificationPageSubscriptionStatus(tenantId: tenantId, urlId: urlId, url: url, pageTitle: pageTitle, subscribedOrUnsubscribed: subscribedOrUnsubscribed, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

updateUserNotificationStatus

参数

名称	类型	位置	必需
tenantId	string	query	是
notificationId	string	path	是
newStatus	string	path	是
sso	string	query	否

响应

返回: UpdateUserNotificationStatusResponse

示例

updateUserNotificationStatus 示例

Copy

// 以下代码示例仍处于测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let notificationId = "notificationId_example" // String | 
let newStatus = "newStatus_example" // String | 
let sso = "sso_example" // String |  (可选)
PublicAPI.updateUserNotificationStatus(tenantId: tenantId, notificationId: notificationId, newStatus: newStatus, sso: sso) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getUserPresenceStatuses

参数

Name	Type	Location	Required
tenantId	string	query	Yes
urlIdWS	string	query	Yes
userIds	string	query	Yes

响应

返回: GetUserPresenceStatusesResponse

示例

getUserPresenceStatuses 示例

Copy

// 以下代码示例仍处于测试阶段。如有问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let urlIdWS = "urlIdWS_example" // String | 
let userIds = "userIds_example" // String | 
PublicAPI.getUserPresenceStatuses(tenantId: tenantId, urlIdWS: urlIdWS, userIds: userIds) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

searchUsers

参数

名称	类型	位置	必需
tenantId	string	path	是
urlId	string	query	是
usernameStartsWith	string	query	否
mentionGroupIds	array	query	否
sso	string	query	否
searchSection	string	query	否

响应

返回：SearchUsersResult

示例

searchUsers 示例

Copy

// 以下代码示例仍处于 beta 阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let urlId = "urlId_example" // String | 
let usernameStartsWith = "usernameStartsWith_example" // String |  (optional)
let mentionGroupIds = ["inner_example"] // [String] |  (optional)
let sso = "sso_example" // String |  (optional)
let searchSection = "searchSection_example" // String |  (optional)
PublicAPI.searchUsers(tenantId: tenantId, urlId: urlId, options: PublicAPI.SearchUsersOptions(usernameStartsWith: usernameStartsWith, mentionGroupIds: mentionGroupIds, sso: sso, searchSection: searchSection)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getUser

参数

Name	Type	Location	Required	Description
tenantId	string	query	是
id	string	path	是

响应

返回: GetUserResponse

示例

getUser 示例

Copy

// 以下示例代码仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
DefaultAPI.getUser(tenantId: tenantId, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

createVote

参数

名称	类型	位置	必填
tenantId	string	query	是
commentId	string	query	是
direction	string	query	是
userId	string	query	否
anonUserId	string	query	否

响应

返回：VoteResponse

示例

createVote 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let commentId = "commentId_example" // String | 
let direction = "direction_example" // String | 
let userId = "userId_example" // String |  (可选)
let anonUserId = "anonUserId_example" // String |  (可选)
DefaultAPI.createVote(tenantId: tenantId, commentId: commentId, direction: direction, options: DefaultAPI.CreateVoteOptions(userId: userId, anonUserId: anonUserId)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deleteVote

参数

名称	类型	位置	必填
tenantId	string	query	是
id	string	path	是
editKey	string	query	否

响应

返回：VoteDeleteResponse

示例

deleteVote 示例

Copy

// 以下代码示例仍属测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
let editKey = "editKey_example" // String |  (可选)
DefaultAPI.deleteVote(tenantId: tenantId, id: id, editKey: editKey) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getVotes

参数

Name	Type	Location	Required	Description
tenantId	string	query	Yes
urlId	string	query	Yes

响应

返回: GetVotesResponse

示例

getVotes 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let urlId = "urlId_example" // String | 
DefaultAPI.getVotes(tenantId: tenantId, urlId: urlId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getVotesForUser

参数

名称	类型	位置	必填
tenantId	string	query	Yes
urlId	string	query	Yes
userId	string	query	No
anonUserId	string	query	No

响应

返回：GetVotesForUserResponse

示例

getVotesForUser 示例

Copy

// 以下代码示例仍为测试版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let urlId = "urlId_example" // String | 
let userId = "userId_example" // String |  (optional)
let anonUserId = "anonUserId_example" // String |  (optional)
DefaultAPI.getVotesForUser(tenantId: tenantId, urlId: urlId, options: DefaultAPI.GetVotesForUserOptions(userId: userId, anonUserId: anonUserId)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

createWebhook

将 URL 订阅到评论事件（REST hook 订阅）。再次将相同的 URL 订阅到相同的事件和域时，将返回已有的订阅。交付采用 HMAC 签名，请参阅 webhooks 指南；旧版 token 头部永不发送到 API 订阅。

参数

名称	类型	位置	必需	描述
tenantId	string	query	是

响应

返回：CreateWebhookResponse

示例

createWebhook 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let createWebhookParams = CreateWebhookParams(url: "url_example", event: WebhookEventName(), domain: "domain_example", method: WebhookHTTPMethod()) // CreateWebhookParams | 
DefaultAPI.createWebhook(tenantId: tenantId, createWebhookParams: createWebhookParams) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

deleteWebhook

取消订阅（REST hook 取消订阅）。只能删除通过此 API 创建的订阅；在仪表板中管理的 webhook 请在仪表板中编辑。

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
id	string	path	是

响应

返回: APIEmptyResponse

示例

deleteWebhook 示例

Copy

// 以下代码示例仍处于测试阶段。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let id = "id_example" // String | 
DefaultAPI.deleteWebhook(tenantId: tenantId, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getWebhooks

列出为租户配置的 webhook，包括仪表板管理的行和 API 订阅。

参数

名称	类型	位置	必填
tenantId	string	query	是
event	string	query	否
domain	string	query	否
source	string	query	否
skip	number	query	否

响应

返回: GetWebhooksResponse

示例

getWebhooks 示例

Copy

// 以下代码示例仍处于 beta 版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let event = WebhookEventName() // WebhookEventName |  （可选）
let domain = "domain_example" // String |  （可选）
let source = WebhookSource() // WebhookSource |  （可选）
let skip = 987 // Double |  （可选）
DefaultAPI.getWebhooks(tenantId: tenantId, options: DefaultAPI.GetWebhooksOptions(event: event, domain: domain, source: source, skip: skip)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

getWebhookSamplePayloads

Recent comments in exactly the shape webhook deliveries use, for building integrations (for example Zapier sample data). Every event delivers the same comment object, so event only has to be valid.

参数

名称	类型	位置	必填
tenantId	string	query	是
event	string	query	否
limit	number	query	否

响应

返回: GetWebhookSamplePayloadsResponse

示例

getWebhookSamplePayloads 示例

Copy

// 以下代码示例仍处于 beta 版。如有任何问题，请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
import FastCommentsSwift
let tenantId = "tenantId_example" // String | 
let event = WebhookEventName() // WebhookEventName |  （可选）
let limit = 987 // Double |  （可选）
DefaultAPI.getWebhookSamplePayloads(tenantId: tenantId, options: DefaultAPI.GetWebhookSamplePayloadsOptions(event: event, limit: limit)) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

需要帮助？

如果您在使用 Swift SDK 时遇到任何问题或有疑问，请：

贡献

欢迎贡献！请访问 GitHub 仓库以查看贡献指南。

语言 🇨🇳 简体中文

文档

入门

API 参考

备注

代理租户

聚合

审计日志

认证

批处理作业

从评论阻止

检查被阻止的评论

评论

用户评论

域配置

电子邮件模板

事件日志

动态帖子

标记评论

动图

标签

我的信息

审核

版主

通知计数

通知

页面互动

页面

待处理的 Webhook 事件

投票记录

投票

问题配置

问题结果

问题结果聚合

单点登录用户

订阅

租户每日使用情况

租户套餐

租户用户

租户

工单

翻译

上传图片

用户徽章进度

用户徽章

用户通知

用户在线状态

用户搜索

用户

Webhook

FastComments Swift SDK

仓库

AI coding agents

Installation

Swift Package Manager

系统要求

Library Contents

Quick Start

使用公共 API

使用已认证 API

使用审查 API

使用 SSO 进行身份验证

安全 SSO（推荐用于生产环境）

简单 SSO（用于开发/测试）

API Clients

PublicAPI - 客户端安全方法

DefaultAPI - 服务器端方法

ModerationAPI - 版主仪表盘方法

Making API Calls

Common Issues

401 未授权错误

SSO 令牌问题

SSL/TLS 错误

Notes

广播 ID

createAgentTenant

Response

Example

aggregate

参数