FastComments.com

FastComments Swift SDK


这是 FastComments 的官方 Swift SDK。

FastComments API 的官方 Swift SDK

仓库

在 GitHub 上查看


AI 编码代理 Internal Link

skills.sh

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

npx skills add fastcomments/skills

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

安装 Internal Link

Swift 包管理器

在你的 Package.swift 文件中添加以下内容:

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

或者在 Xcode 中:

  1. 文件 > 添加包...
  2. 输入仓库 URL: https://github.com/fastcomments/fastcomments-swift.git
  3. 选择你想使用的版本

要求

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

库内容 Internal Link

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

  • 客户端模块 - 用于 FastComments REST API 的客户端

    • 为所有 API 模型提供完整的类型定义
    • 包含验证(DefaultAPI)、公共(PublicAPI)和审核(ModerationAPI)方法
    • 完整的 async/await 支持
    • 详见 client/README.md 获取详细的 API 文档
  • SSO 模块 - 服务器端单点登录实用工具

    • 用于用户认证的安全令牌生成
    • 支持简单和安全两种 SSO 模式
    • 使用 CryptoKit 基于 HMAC-SHA256 的令牌签名

快速入门 Internal Link

使用公共 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 客户端 Internal Link

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 密钥应仅在服务器端使用。

发起 API 调用 Internal Link


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

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

常见问题 Internal Link

401 未授权错误

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

  1. 检查您的 API 密钥:确保使用来自 FastComments 仪表板的正确 API 密钥
  2. 验证租户 ID:确保租户 ID 与您的账户匹配
  3. API 密钥格式:API 密钥应在共享配置中设置为 x-api-key 头部:
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "YOUR_API_KEY"
  1. 使用错误的 API:确保在已认证调用中使用 DefaultAPI(而不是 PublicAPI)

SSO 令牌问题

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

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

SSL/TLS 错误

如果遇到 SSL/TLS 错误:

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

备注 Internal Link

广播 ID

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

let broadcastId = UUID().uuidString

聚合 Internal Link

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

参数

名称类型位置必需描述
tenantIdstringqueryYes
parentTenantIdstringqueryNo
includeStatsbooleanqueryNo

响应

返回: AggregateResponse

示例

聚合 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let 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 |
7let parentTenantId = "parentTenantId_example" // String | (optional)
8let includeStats = true // Bool | (optional)
9
10DefaultAPI.aggregate(tenantId: tenantId, aggregationRequest: aggregationRequest, options: DefaultAPI.AggregateOptions(parentTenantId: parentTenantId, includeStats: includeStats)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

获取审计日志 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
limitnumberquery否
skipnumberquery否
orderstringquery否
afternumberquery否
beforenumberquery否

响应

返回: GetAuditLogsResponse

示例

getAuditLogs 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let limit = 987 // Double | (可选)
7let skip = 987 // Double | (可选)
8let order = SORT_DIR() // SORTDIR | (可选)
9let after = 987 // Double | (可选)
10let before = 987 // Double | (可选)
11
12DefaultAPI.getAuditLogs(tenantId: tenantId, options: DefaultAPI.GetAuditLogsOptions(limit: limit, skip: skip, order: order, after: after, before: before)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

公开登出 Internal Link

响应

返回:APIEmptyResponse

示例

logoutPublic 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5
6PublicAPI.logoutPublic() { (response, error) in
7 guard error == nil else {
8 print(error)
9 return
10 }
11
12 if (response) {
13 dump(response)
14 }
15}
16

公开阻止评论 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
commentIdstringpath是
ssostringquery否

响应

返回: BlockSuccess

示例

blockFromCommentPublic 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let publicBlockFromCommentParams = PublicBlockFromCommentParams(commentIds: ["commentIds_example"]) // PublicBlockFromCommentParams |
8let sso = "sso_example" // String | (可选)
9
10PublicAPI.blockFromCommentPublic(tenantId: tenantId, commentId: commentId, publicBlockFromCommentParams: publicBlockFromCommentParams, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

公开解除阻止评论 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
commentIdstringpath是
ssostringquery否

响应

返回: UnblockSuccess

示例

unBlockCommentPublic 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如遇任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let publicBlockFromCommentParams = PublicBlockFromCommentParams(commentIds: ["commentIds_example"]) // PublicBlockFromCommentParams |
8let sso = "sso_example" // String | (可选)
9
10PublicAPI.unBlockCommentPublic(tenantId: tenantId, commentId: commentId, publicBlockFromCommentParams: publicBlockFromCommentParams, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

已检查阻止的评论 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
commentIdsstringquery是以逗号分隔的评论 id 列表。
ssostringquery否

响应

返回: CheckBlockedCommentsResponse

示例

checkedCommentsForBlocked 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentIds = "commentIds_example" // String | 以逗号分隔的评论 id 列表。
7let sso = "sso_example" // String | (可选)
8
9PublicAPI.checkedCommentsForBlocked(tenantId: tenantId, commentIds: commentIds, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

阻止用户评论 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
idstringpath是
userIdstringquery否
anonUserIdstringquery否

响应

返回: BlockSuccess

示例

blockUserFromComment 示例
Copy Copy
1
2// 以下代码示例仍在测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let blockFromCommentParams = BlockFromCommentParams(commentIdsToCheck: ["commentIdsToCheck_example"]) // BlockFromCommentParams |
8let userId = "userId_example" // String | (可选)
9let anonUserId = "anonUserId_example" // String | (可选)
10
11DefaultAPI.blockUserFromComment(tenantId: tenantId, id: id, blockFromCommentParams: blockFromCommentParams, options: DefaultAPI.BlockUserFromCommentOptions(userId: userId, anonUserId: anonUserId)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

公开创建评论 Internal Link

参数

名称类型位置必需描述
tenantIdstringpathYes
urlIdstringqueryYes
broadcastIdstringqueryYes
sessionIdstringqueryNo
ssostringqueryNo

响应

返回: SaveCommentsResponseWithPresence

示例

createCommentPublic 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let broadcastId = "broadcastId_example" // String |
8let 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", tos: false, botId: "botId_example") // CommentData |
9let sessionId = "sessionId_example" // String | (可选)
10let sso = "sso_example" // String | (可选)
11
12PublicAPI.createCommentPublic(tenantId: tenantId, urlId: urlId, broadcastId: broadcastId, commentData: commentData, options: PublicAPI.CreateCommentPublicOptions(sessionId: sessionId, sso: sso)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

删除评论 Internal Link

参数

名称类型位置必填描述
tenantIdstringqueryYes
idstringpathYes
contextUserIdstringqueryNo
isLivebooleanqueryNo

响应

返回:DeleteCommentResult

示例

deleteComment 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。若有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let contextUserId = "contextUserId_example" // String | (可选)
8let isLive = true // Bool | (可选)
9
10DefaultAPI.deleteComment(tenantId: tenantId, id: id, options: DefaultAPI.DeleteCommentOptions(contextUserId: contextUserId, isLive: isLive)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

公开删除评论 Internal Link

参数

名称类型位置必需描述
tenantIdstringpath是
commentIdstringpath是
broadcastIdstringquery是
editKeystringquery否
ssostringquery否

响应

返回: PublicAPIDeleteCommentResponse

示例

deleteCommentPublic 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String |
8let editKey = "editKey_example" // String | (可选)
9let sso = "sso_example" // String | (可选)
10
11PublicAPI.deleteCommentPublic(tenantId: tenantId, commentId: commentId, broadcastId: broadcastId, options: PublicAPI.DeleteCommentPublicOptions(editKey: editKey, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

删除评论投票 Internal Link

参数

名称类型位置必填描述
tenantIdstringpathYes
commentIdstringpathYes
voteIdstringpathYes
urlIdstringqueryYes
broadcastIdstringqueryYes
editKeystringqueryNo
ssostringqueryNo

响应

返回:VoteDeleteResponse

示例

deleteCommentVote 示例
Copy Copy
1
2// 以下代码示例仍在 beta 阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let voteId = "voteId_example" // String |
8let urlId = "urlId_example" // String |
9let broadcastId = "broadcastId_example" // String |
10let editKey = "editKey_example" // String | (可选)
11let sso = "sso_example" // String | (可选)
12
13PublicAPI.deleteCommentVote(tenantId: tenantId, commentId: commentId, voteId: voteId, urlId: urlId, broadcastId: broadcastId, options: PublicAPI.DeleteCommentVoteOptions(editKey: editKey, sso: sso)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

标记评论 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
idstringpath是
userIdstringquery否
anonUserIdstringquery否

响应

返回:FlagCommentResponse

示例

flagComment 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let userId = "userId_example" // String | (可选)
8let anonUserId = "anonUserId_example" // String | (可选)
9
10DefaultAPI.flagComment(tenantId: tenantId, id: id, options: DefaultAPI.FlagCommentOptions(userId: userId, anonUserId: anonUserId)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

获取评论 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
idstringpath是

响应

返回: APIGetCommentResponse

示例

getComment 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getComment(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取评论列表 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
pageintegerquery否
limitintegerquery否
skipintegerquery否
asTreebooleanquery否
skipChildrenintegerquery否
limitChildrenintegerquery否
maxTreeDepthintegerquery否
urlIdstringquery否
userIdstringquery否
anonUserIdstringquery否
contextUserIdstringquery否
hashTagstringquery否
parentIdstringquery否
directionstringquery否
fromDateintegerquery否
toDateintegerquery否

响应

返回:APIGetCommentsResponse

示例

获取评论 示例
Copy Copy
1
2// 以下代码示例仍为 beta 版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let page = 987 // Int | (可选)
7let limit = 987 // Int | (可选)
8let skip = 987 // Int | (可选)
9let asTree = true // Bool | (可选)
10let skipChildren = 987 // Int | (可选)
11let limitChildren = 987 // Int | (可选)
12let maxTreeDepth = 987 // Int | (可选)
13let urlId = "urlId_example" // String | (可选)
14let userId = "userId_example" // String | (可选)
15let anonUserId = "anonUserId_example" // String | (可选)
16let contextUserId = "contextUserId_example" // String | (可选)
17let hashTag = "hashTag_example" // String | (可选)
18let parentId = "parentId_example" // String | (可选)
19let direction = SortDirections() // SortDirections | (可选)
20let fromDate = 987 // Int64 | (可选)
21let toDate = 987 // Int64 | (可选)
22
23DefaultAPI.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
24 guard error == nil else {
25 print(error)
26 return
27 }
28
29 if (response) {
30 dump(response)
31 }
32}
33

公开获取评论 Internal Link

req
tenantId
urlId

参数

名称类型位置必需描述
tenantIdstringpathYes
urlIdstringqueryYes
pageintegerqueryNo
directionstringqueryNo
ssostringqueryNo
skipintegerqueryNo
skipChildrenintegerqueryNo
limitintegerqueryNo
limitChildrenintegerqueryNo
countChildrenbooleanqueryNo
fetchPageForCommentIdstringqueryNo
includeConfigbooleanqueryNo
countAllbooleanqueryNo
includei10nbooleanqueryNo
localestringqueryNo
modulesstringqueryNo
isCrawlerbooleanqueryNo
includeNotificationCountbooleanqueryNo
asTreebooleanqueryNo
maxTreeDepthintegerqueryNo
useFullTranslationIdsbooleanqueryNo
parentIdstringqueryNo
searchTextstringqueryNo
hashTagsarrayqueryNo
userIdstringqueryNo
customConfigStrstringqueryNo
afterCommentIdstringqueryNo
beforeCommentIdstringqueryNo

响应

返回: GetCommentsResponseWithPresencePublicComment

示例

getCommentsPublic 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。若有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let page = 987 // Int | (optional)
8let direction = SortDirections() // SortDirections | (optional)
9let sso = "sso_example" // String | (optional)
10let skip = 987 // Int | (optional)
11let skipChildren = 987 // Int | (optional)
12let limit = 987 // Int | (optional)
13let limitChildren = 987 // Int | (optional)
14let countChildren = true // Bool | (optional)
15let fetchPageForCommentId = "fetchPageForCommentId_example" // String | (optional)
16let includeConfig = true // Bool | (optional)
17let countAll = true // Bool | (optional)
18let includei10n = true // Bool | (optional)
19let locale = "locale_example" // String | (optional)
20let modules = "modules_example" // String | (optional)
21let isCrawler = true // Bool | (optional)
22let includeNotificationCount = true // Bool | (optional)
23let asTree = true // Bool | (optional)
24let maxTreeDepth = 987 // Int | (optional)
25let useFullTranslationIds = true // Bool | (optional)
26let parentId = "parentId_example" // String | (optional)
27let searchText = "searchText_example" // String | (optional)
28let hashTags = ["inner_example"] // [String] | (optional)
29let userId = "userId_example" // String | (optional)
30let customConfigStr = "customConfigStr_example" // String | (optional)
31let afterCommentId = "afterCommentId_example" // String | (optional)
32let beforeCommentId = "beforeCommentId_example" // String | (optional)
33
34PublicAPI.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)) { (response, error) in
35 guard error == nil else {
36 print(error)
37 return
38 }
39
40 if (response) {
41 dump(response)
42 }
43}
44

获取评论文本 Internal Link

参数

名称类型位置必需描述
tenantIdstringpath是
commentIdstringpath是
editKeystringquery否
ssostringquery否

响应

Returns: PublicAPIGetCommentTextResponse

示例

getCommentText 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let editKey = "editKey_example" // String | (optional)
8let sso = "sso_example" // String | (optional)
9
10PublicAPI.getCommentText(tenantId: tenantId, commentId: commentId, options: PublicAPI.GetCommentTextOptions(editKey: editKey, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

获取评论投票用户名 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringpath是
commentIdstringpath是
dirintegerquery是
ssostringquery否

响应

返回: GetCommentVoteUserNamesSuccessResponse

示例

getCommentVoteUserNames 示例
Copy Copy
1
2// 以下代码示例仍在测试阶段。如遇任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let dir = 987 // Int |
8let sso = "sso_example" // String | (可选)
9
10PublicAPI.getCommentVoteUserNames(tenantId: tenantId, commentId: commentId, dir: dir, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

锁定评论 Internal Link


参数

名称类型位置必需描述
tenantIdstringpath是
commentIdstringpath是
broadcastIdstringquery是
ssostringquery否

响应

返回: APIEmptyResponse

示例

lockComment 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String |
8let sso = "sso_example" // String | (可选)
9
10PublicAPI.lockComment(tenantId: tenantId, commentId: commentId, broadcastId: broadcastId, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

置顶评论 Internal Link

参数

名称类型位置必填描述
tenantIdstringpath是
commentIdstringpath是
broadcastIdstringquery是
ssostringquery否

响应

返回: ChangeCommentPinStatusResponse

示例

pinComment 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String |
8let sso = "sso_example" // String | (可选)
9
10PublicAPI.pinComment(tenantId: tenantId, commentId: commentId, broadcastId: broadcastId, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

保存评论 Internal Link

参数

名称类型位置必填描述
tenantIdstringqueryYes
isLivebooleanqueryNo
doSpamCheckbooleanqueryNo
sendEmailsbooleanqueryNo
populateNotificationsbooleanqueryNo

响应

Returns: APISaveCommentResponse

示例

saveComment 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 阶段。如有问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let 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", 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 |
7let isLive = true // Bool | (optional)
8let doSpamCheck = true // Bool | (optional)
9let sendEmails = true // Bool | (optional)
10let populateNotifications = true // Bool | (optional)
11
12DefaultAPI.saveComment(tenantId: tenantId, createCommentParams: createCommentParams, options: DefaultAPI.SaveCommentOptions(isLive: isLive, doSpamCheck: doSpamCheck, sendEmails: sendEmails, populateNotifications: populateNotifications)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

批量保存评论 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
isLivebooleanquery否
doSpamCheckbooleanquery否
sendEmailsbooleanquery否
populateNotificationsbooleanquery否

响应

返回:[SaveCommentsBulkResponse]

示例

saveCommentsBulk 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let 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", 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] |
7let isLive = true // Bool | (optional)
8let doSpamCheck = true // Bool | (optional)
9let sendEmails = true // Bool | (optional)
10let populateNotifications = true // Bool | (optional)
11
12DefaultAPI.saveCommentsBulk(tenantId: tenantId, createCommentParams: createCommentParams, options: DefaultAPI.SaveCommentsBulkOptions(isLive: isLive, doSpamCheck: doSpamCheck, sendEmails: sendEmails, populateNotifications: populateNotifications)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

设置评论文本 Internal Link

参数

名称类型位置必需描述
tenantIdstringpath是
commentIdstringpath是
broadcastIdstringquery是
editKeystringquery否
ssostringquery否

响应

返回: PublicAPISetCommentTextResponse

示例

setCommentText 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String |
8let 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 |
9let editKey = "editKey_example" // String | (可选)
10let sso = "sso_example" // String | (可选)
11
12PublicAPI.setCommentText(tenantId: tenantId, commentId: commentId, broadcastId: broadcastId, commentTextUpdateRequest: commentTextUpdateRequest, options: PublicAPI.SetCommentTextOptions(editKey: editKey, sso: sso)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

解除用户评论阻止 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
idstringpath是
userIdstringquery否
anonUserIdstringquery否

响应

返回:UnblockSuccess

示例

unBlockUserFromComment 示例
Copy Copy
1
2// 以下代码示例仍为 beta 版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let unBlockFromCommentParams = UnBlockFromCommentParams(commentIdsToCheck: ["commentIdsToCheck_example"]) // UnBlockFromCommentParams |
8let userId = "userId_example" // String | (可选)
9let anonUserId = "anonUserId_example" // String | (可选)
10
11DefaultAPI.unBlockUserFromComment(tenantId: tenantId, id: id, unBlockFromCommentParams: unBlockFromCommentParams, options: DefaultAPI.UnBlockUserFromCommentOptions(userId: userId, anonUserId: anonUserId)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

取消标记评论 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
idstringpath是
userIdstringquery否
anonUserIdstringquery否

响应

返回:FlagCommentResponse

示例

unFlagComment 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let userId = "userId_example" // String | (可选)
8let anonUserId = "anonUserId_example" // String | (可选)
9
10DefaultAPI.unFlagComment(tenantId: tenantId, id: id, options: DefaultAPI.UnFlagCommentOptions(userId: userId, anonUserId: anonUserId)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

解锁评论 Internal Link

参数

名称类型位置必填描述
tenantIdstringpath是
commentIdstringpath是
broadcastIdstringquery是
ssostringquery否

响应

返回: APIEmptyResponse

示例

unLockComment 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。若有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String |
8let sso = "sso_example" // String | (可选)
9
10PublicAPI.unLockComment(tenantId: tenantId, commentId: commentId, broadcastId: broadcastId, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

取消置顶评论 Internal Link

参数

名称类型位置必需描述
tenantIdstringpath是
commentIdstringpath是
broadcastIdstringquery是
ssostringquery否

响应

返回:ChangeCommentPinStatusResponse

示例

unPinComment 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如遇任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // 字符串 |
6let commentId = "commentId_example" // 字符串 |
7let broadcastId = "broadcastId_example" // 字符串 |
8let sso = "sso_example" // 字符串 | (可选)
9
10PublicAPI.unPinComment(tenantId: tenantId, commentId: commentId, broadcastId: broadcastId, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

更新评论 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
idstringpath是
contextUserIdstringquery否
doSpamCheckbooleanquery否
isLivebooleanquery否

响应

返回: APIEmptyResponse

示例

updateComment 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let 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 |
8let contextUserId = "contextUserId_example" // String | (optional)
9let doSpamCheck = true // Bool | (optional)
10let isLive = true // Bool | (optional)
11
12DefaultAPI.updateComment(tenantId: tenantId, id: id, updatableCommentParams: updatableCommentParams, options: DefaultAPI.UpdateCommentOptions(contextUserId: contextUserId, doSpamCheck: doSpamCheck, isLive: isLive)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

评论投票 Internal Link

参数

名称类型位置必填描述
tenantIdstringpathYes
commentIdstringpathYes
urlIdstringqueryYes
broadcastIdstringqueryYes
sessionIdstringqueryNo
ssostringqueryNo

响应

返回:VoteResponse

示例

voteComment 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let urlId = "urlId_example" // String |
8let broadcastId = "broadcastId_example" // String |
9let voteBodyParams = VoteBodyParams(commenterEmail: "commenterEmail_example", commenterName: "commenterName_example", voteDir: "voteDir_example", url: "url_example") // VoteBodyParams |
10let sessionId = "sessionId_example" // String | (可选)
11let sso = "sso_example" // String | (可选)
12
13PublicAPI.voteComment(tenantId: tenantId, commentId: commentId, urlId: urlId, broadcastId: broadcastId, voteBodyParams: voteBodyParams, options: PublicAPI.VoteCommentOptions(sessionId: sessionId, sso: sso)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

获取用户评论 Internal Link

参数

名称类型位置必需描述
userIdstringquery否
directionstringquery否
repliesToUserIdstringquery否
pagenumberquery否
includei10nbooleanquery否
localestringquery否
isCrawlerbooleanquery否

响应

返回:GetCommentsForUserResponse

示例

getCommentsForUser 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 提交报告
3import FastCommentsSwift
4
5let userId = "userId_example" // String | (可选)
6let direction = SortDirections() // SortDirections | (可选)
7let repliesToUserId = "repliesToUserId_example" // String | (可选)
8let page = 987 // Double | (可选)
9let includei10n = true // Bool | (可选)
10let locale = "locale_example" // String | (可选)
11let isCrawler = true // Bool | (可选)
12
13PublicAPI.getCommentsForUser(options: PublicAPI.GetCommentsForUserOptions(userId: userId, direction: direction, repliesToUserId: repliesToUserId, page: page, includei10n: includei10n, locale: locale, isCrawler: isCrawler)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

添加域配置 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是

响应

返回: AddDomainConfigResponse

示例

addDomainConfig 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let addDomainConfigParams = AddDomainConfigParams(domain: "domain_example", emailFromName: "emailFromName_example", emailFromEmail: "emailFromEmail_example", logoSrc: "logoSrc_example", logoSrc100px: "logoSrc100px_example", footerUnsubscribeURL: "footerUnsubscribeURL_example", emailHeaders: "TODO") // AddDomainConfigParams |
7
8DefaultAPI.addDomainConfig(tenantId: tenantId, addDomainConfigParams: addDomainConfigParams) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

删除域配置 Internal Link


参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
domainstringpath是

响应

返回: DeleteDomainConfigResponse

示例

deleteDomainConfig 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如遇问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let domain = "domain_example" // String |
7
8DefaultAPI.deleteDomainConfig(tenantId: tenantId, domain: domain) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取域配置 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
domainstringpath是

响应

返回: GetDomainConfigResponse

示例

getDomainConfig 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // 字符串 |
6let domain = "domain_example" // 字符串 |
7
8DefaultAPI.getDomainConfig(tenantId: tenantId, domain: domain) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取域配置列表 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是

响应

返回: GetDomainConfigsResponse

示例

getDomainConfigs 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6
7DefaultAPI.getDomainConfigs(tenantId: tenantId) { (response, error) in
8 guard error == nil else {
9 print(error)
10 return
11 }
12
13 if (response) {
14 dump(response)
15 }
16}
17

修补域配置 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
domainToUpdatestringpathYes

响应

返回: PatchDomainConfigResponse

示例

patchDomainConfig 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如遇任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let domainToUpdate = "domainToUpdate_example" // String |
7let patchDomainConfigParams = PatchDomainConfigParams(domain: "domain_example", emailFromName: "emailFromName_example", emailFromEmail: "emailFromEmail_example", logoSrc: "logoSrc_example", logoSrc100px: "logoSrc100px_example", footerUnsubscribeURL: "footerUnsubscribeURL_example", emailHeaders: "TODO") // PatchDomainConfigParams |
8
9DefaultAPI.patchDomainConfig(tenantId: tenantId, domainToUpdate: domainToUpdate, patchDomainConfigParams: patchDomainConfigParams) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

放置域配置 Internal Link


参数

名称类型位置必需描述
tenantIdstringquery是
domainToUpdatestringpath是

返回

返回:PutDomainConfigResponse

示例

putDomainConfig 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let domainToUpdate = "domainToUpdate_example" // String |
7let updateDomainConfigParams = UpdateDomainConfigParams(domain: "domain_example", emailFromName: "emailFromName_example", emailFromEmail: "emailFromEmail_example", logoSrc: "logoSrc_example", logoSrc100px: "logoSrc100px_example", footerUnsubscribeURL: "footerUnsubscribeURL_example", emailHeaders: "TODO") // UpdateDomainConfigParams |
8
9DefaultAPI.putDomainConfig(tenantId: tenantId, domainToUpdate: domainToUpdate, updateDomainConfigParams: updateDomainConfigParams) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

创建邮件模板 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是

响应

返回: CreateEmailTemplateResponse

示例

createEmailTemplate 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如遇任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createEmailTemplateBody = CreateEmailTemplateBody(emailTemplateId: "emailTemplateId_example", displayName: "displayName_example", ejs: "ejs_example", domain: "domain_example", translationOverridesByLocale: "TODO", testData: "TODO") // CreateEmailTemplateBody |
7
8DefaultAPI.createEmailTemplate(tenantId: tenantId, createEmailTemplateBody: createEmailTemplateBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

删除邮件模板 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
idstringpath是

Response

返回: APIEmptyResponse

示例

deleteEmailTemplate 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.deleteEmailTemplate(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

删除邮件模板渲染错误 Internal Link


参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是
errorIdstringpath是

响应

返回:APIEmptyResponse

示例

deleteEmailTemplateRenderError 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let errorId = "errorId_example" // String |
8
9DefaultAPI.deleteEmailTemplateRenderError(tenantId: tenantId, id: id, errorId: errorId) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

获取邮件模板 Internal Link

参数

名称类型位置是否必需描述
tenantIdstringquery是
idstringpath是

响应

返回: GetEmailTemplateResponse

示例

getEmailTemplate 示例
Copy Copy
1
2// 下面的代码示例仍处于测试阶段。如有问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getEmailTemplate(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取邮件模板定义 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是

响应

返回: GetEmailTemplateDefinitionsResponse

示例

getEmailTemplateDefinitions 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如遇到任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6
7DefaultAPI.getEmailTemplateDefinitions(tenantId: tenantId) { (response, error) in
8 guard error == nil else {
9 print(error)
10 return
11 }
12
13 if (response) {
14 dump(response)
15 }
16}
17

获取邮件模板渲染错误 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是
skipnumberquery否

响应

返回: GetEmailTemplateRenderErrorsResponse

示例

getEmailTemplateRenderErrors 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let skip = 987 // Double | (可选)
8
9DefaultAPI.getEmailTemplateRenderErrors(tenantId: tenantId, id: id, skip: skip) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

获取邮件模板列表 Internal Link


参数

名称类型位置必填描述
tenantIdstringquery是
skipnumberquery否

响应

返回:GetEmailTemplatesResponse

示例

getEmailTemplates 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let skip = 987 // Double | (可选)
7
8DefaultAPI.getEmailTemplates(tenantId: tenantId, skip: skip) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

渲染邮件模板 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
localestringquery否

响应

返回: RenderEmailTemplateResponse

示例

renderEmailTemplate 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let renderEmailTemplateBody = RenderEmailTemplateBody(emailTemplateId: "emailTemplateId_example", ejs: "ejs_example", testData: "TODO", translationOverridesByLocale: "TODO") // RenderEmailTemplateBody |
7let locale = "locale_example" // String | (可选)
8
9DefaultAPI.renderEmailTemplate(tenantId: tenantId, renderEmailTemplateBody: renderEmailTemplateBody, locale: locale) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

更新邮件模板 Internal Link


参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是

响应

返回: APIEmptyResponse

示例

updateEmailTemplate 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateEmailTemplateBody = UpdateEmailTemplateBody(emailTemplateId: "emailTemplateId_example", displayName: "displayName_example", ejs: "ejs_example", domain: "domain_example", translationOverridesByLocale: "TODO", testData: "TODO") // UpdateEmailTemplateBody |
8
9DefaultAPI.updateEmailTemplate(tenantId: tenantId, id: id, updateEmailTemplateBody: updateEmailTemplateBody) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

获取事件日志 Internal Link

req tenantId urlId userIdWS

参数

NameTypeLocationRequiredDescription
tenantIdstringpath是
urlIdstringquery是
userIdWSstringquery是
startTimeintegerquery是
endTimeintegerquery否

Response

返回: GetEventLogResponse

示例

getEventLog 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let userIdWS = "userIdWS_example" // String |
8let startTime = 987 // Int64 |
9let endTime = 987 // Int64 | (可选)
10
11PublicAPI.getEventLog(tenantId: tenantId, urlId: urlId, userIdWS: userIdWS, startTime: startTime, endTime: endTime) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

获取全局事件日志 Internal Link

req tenantId urlId userIdWS

参数

NameTypeLocationRequiredDescription
tenantIdstringpath是
urlIdstringquery是
userIdWSstringquery是
startTimeintegerquery是
endTimeintegerquery否

响应

返回: GetEventLogResponse

示例

getGlobalEventLog 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let userIdWS = "userIdWS_example" // String |
8let startTime = 987 // Int64 |
9let endTime = 987 // Int64 | (可选)
10
11PublicAPI.getGlobalEventLog(tenantId: tenantId, urlId: urlId, userIdWS: userIdWS, startTime: startTime, endTime: endTime) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

创建动态帖子 Internal Link

参数

名称类型位置必需描述
tenantIdstringqueryYes
broadcastIdstringqueryNo
isLivebooleanqueryNo
doSpamCheckbooleanqueryNo
skipDupCheckbooleanqueryNo

响应

返回:CreateFeedPostsResponse

示例

createFeedPost 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let 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 |
7let broadcastId = "broadcastId_example" // String | (可选)
8let isLive = true // Bool | (可选)
9let doSpamCheck = true // Bool | (可选)
10let skipDupCheck = true // Bool | (可选)
11
12DefaultAPI.createFeedPost(tenantId: tenantId, createFeedPostParams: createFeedPostParams, options: DefaultAPI.CreateFeedPostOptions(broadcastId: broadcastId, isLive: isLive, doSpamCheck: doSpamCheck, skipDupCheck: skipDupCheck)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

公开创建动态帖子 Internal Link

参数

名称类型位置必填描述
tenantIdstringpath是
broadcastIdstringquery否
ssostringquery否

响应

返回:CreateFeedPostResponse

示例

createFeedPostPublic 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let 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 |
7let broadcastId = "broadcastId_example" // String | (可选)
8let sso = "sso_example" // String | (可选)
9
10PublicAPI.createFeedPostPublic(tenantId: tenantId, createFeedPostParams: createFeedPostParams, options: PublicAPI.CreateFeedPostPublicOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

公开删除动态帖子 Internal Link


参数

名称类型位置必填描述
tenantIdstringpath是
postIdstringpath是
broadcastIdstringquery否
ssostringquery否

响应

返回:DeleteFeedPostPublicResponse

示例

deleteFeedPostPublic 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告。
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let postId = "postId_example" // String |
7let broadcastId = "broadcastId_example" // String | (可选)
8let sso = "sso_example" // String | (可选)
9
10PublicAPI.deleteFeedPostPublic(tenantId: tenantId, postId: postId, options: PublicAPI.DeleteFeedPostPublicOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

获取动态帖子 Internal Link

请求
tenantId
afterId

参数

名称类型位置必需描述
tenantIdstringqueryYes
afterIdstringqueryNo
limitintegerqueryNo
tagsarrayqueryNo

响应

返回:GetFeedPostsResponse

示例

getFeedPosts 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。若有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let afterId = "afterId_example" // String | (可选)
7let limit = 987 // Int | (可选)
8let tags = ["inner_example"] // [String] | (可选)
9
10DefaultAPI.getFeedPosts(tenantId: tenantId, options: DefaultAPI.GetFeedPostsOptions(afterId: afterId, limit: limit, tags: tags)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

公开获取动态帖子 Internal Link

req tenantId afterId

参数

NameTypeLocationRequiredDescription
tenantIdstringpath是
afterIdstringquery否
limitintegerquery否
tagsarrayquery否
ssostringquery否
isCrawlerbooleanquery否
includeUserInfobooleanquery否

响应

返回:PublicFeedPostsResponse

示例

getFeedPostsPublic 示例
Copy Copy
1
2// 以下代码示例仍为 beta 版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告。
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let afterId = "afterId_example" // String | (可选)
7let limit = 987 // Int | (可选)
8let tags = ["inner_example"] // [String] | (可选)
9let sso = "sso_example" // String | (可选)
10let isCrawler = true // Bool | (可选)
11let includeUserInfo = true // Bool | (可选)
12
13PublicAPI.getFeedPostsPublic(tenantId: tenantId, options: PublicAPI.GetFeedPostsPublicOptions(afterId: afterId, limit: limit, tags: tags, sso: sso, isCrawler: isCrawler, includeUserInfo: includeUserInfo)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

获取动态帖子统计 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringpath是
postIdsarrayquery是
ssostringquery否

响应

返回: FeedPostsStatsResponse

示例

getFeedPostsStats 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let postIds = ["inner_example"] // [String] |
7let sso = "sso_example" // String | (可选)
8
9PublicAPI.getFeedPostsStats(tenantId: tenantId, postIds: postIds, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

公开获取用户反应 Internal Link

参数

名称类型位置必填描述
tenantIdstringpathYes
postIdsarrayqueryNo
ssostringqueryNo

响应

返回:UserReactsResponse

示例

getUserReactsPublic 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let postIds = ["inner_example"] // [String] | (可选)
7let sso = "sso_example" // String | (可选)
8
9PublicAPI.getUserReactsPublic(tenantId: tenantId, options: PublicAPI.GetUserReactsPublicOptions(postIds: postIds, sso: sso)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

公开对动态帖子反应 Internal Link

参数

名称类型位置必需描述
tenantIdstringpath是
postIdstringpath是
isUndobooleanquery否
broadcastIdstringquery否
ssostringquery否

响应

返回: ReactFeedPostResponse

示例

reactFeedPostPublic 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let postId = "postId_example" // String |
7let reactBodyParams = ReactBodyParams(reactType: "reactType_example") // ReactBodyParams |
8let isUndo = true // Bool | (optional)
9let broadcastId = "broadcastId_example" // String | (optional)
10let sso = "sso_example" // String | (optional)
11
12PublicAPI.reactFeedPostPublic(tenantId: tenantId, postId: postId, reactBodyParams: reactBodyParams, options: PublicAPI.ReactFeedPostPublicOptions(isUndo: isUndo, broadcastId: broadcastId, sso: sso)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

更新动态帖子 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
idstringpath是

响应

返回:APIEmptyResponse

示例

updateFeedPost 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。若遇到任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let 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 |
8
9DefaultAPI.updateFeedPost(tenantId: tenantId, id: id, feedPost: feedPost) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

公开更新动态帖子 Internal Link

参数

名称类型位置必需描述
tenantIdstringpath是
postIdstringpath是
broadcastIdstringquery否
ssostringquery否

响应

返回:CreateFeedPostResponse

示例

updateFeedPostPublic 示例
Copy Copy
1
2// 以下代码示例仍在测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let postId = "postId_example" // String |
7let 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 |
8let broadcastId = "broadcastId_example" // String | (optional)
9let sso = "sso_example" // String | (optional)
10
11PublicAPI.updateFeedPostPublic(tenantId: tenantId, postId: postId, updateFeedPostParams: updateFeedPostParams, options: PublicAPI.UpdateFeedPostPublicOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

公开标记评论 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
commentIdstringpath是
isFlaggedbooleanquery是
ssostringquery否

响应

返回: APIEmptyResponse

示例

flagCommentPublic 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如遇任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let isFlagged = true // Bool |
8let sso = "sso_example" // String | (可选)
9
10PublicAPI.flagCommentPublic(tenantId: tenantId, commentId: commentId, isFlagged: isFlagged, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

获取大尺寸 GIF Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringpath是
largeInternalURLSanitizedstringquery是

响应

返回:GifGetLargeResponse

示例

getGifLarge 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let largeInternalURLSanitized = "largeInternalURLSanitized_example" // String |
7
8PublicAPI.getGifLarge(tenantId: tenantId, largeInternalURLSanitized: largeInternalURLSanitized) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

搜索动图 Internal Link

参数

名称类型位置必填描述
tenantIdstring路径是
searchstring查询是
localestring查询否
ratingstring查询否
pagenumber查询否

响应

返回:GetGifsSearchResponse

示例

getGifsSearch 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let search = "search_example" // String |
7let locale = "locale_example" // String | (可选)
8let rating = "rating_example" // String | (可选)
9let page = 987 // Double | (可选)
10
11PublicAPI.getGifsSearch(tenantId: tenantId, search: search, options: PublicAPI.GetGifsSearchOptions(locale: locale, rating: rating, page: page)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

热门动图 Internal Link

参数

名称类型位置必填描述
tenantIdstringpath是
localestringquery否
ratingstringquery否
pagenumberquery否

响应

返回:GetGifsTrendingResponse

示例

getGifsTrending 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let locale = "locale_example" // String | (可选)
7let rating = "rating_example" // String | (可选)
8let page = 987 // Double | (可选)
9
10PublicAPI.getGifsTrending(tenantId: tenantId, options: PublicAPI.GetGifsTrendingOptions(locale: locale, rating: rating, page: page)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

添加标签 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

响应

返回: CreateHashTagResponse

示例

addHashTag 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 版。如果有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createHashTagBody = CreateHashTagBody(tenantId: "tenantId_example", tag: "tag_example", url: "url_example") // CreateHashTagBody | (可选)
7
8DefaultAPI.addHashTag(tenantId: tenantId, createHashTagBody: createHashTagBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

批量添加标签 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是

响应

返回:BulkCreateHashTagsResponse

示例

addHashTagsBulk 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let bulkCreateHashTagsBody = BulkCreateHashTagsBody(tenantId: "tenantId_example", tags: [BulkCreateHashTagsBody_tags_inner(url: "url_example", tag: "tag_example")]) // BulkCreateHashTagsBody | (optional)
7
8DefaultAPI.addHashTagsBulk(tenantId: tenantId, bulkCreateHashTagsBody: bulkCreateHashTagsBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

删除标签 Internal Link

参数

名称类型位置必填描述
tenantIdstringqueryYes
tagstringpathYes

响应

返回:APIEmptyResponse

示例

deleteHashTag 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let tag = "tag_example" // String |
7let deleteHashTagRequestBody = DeleteHashTagRequestBody(tenantId: "tenantId_example") // DeleteHashTagRequestBody | (optional)
8
9DefaultAPI.deleteHashTag(tenantId: tenantId, tag: tag, deleteHashTagRequestBody: deleteHashTagRequestBody) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

获取标签 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
pagenumberquery否

响应

返回: GetHashTagsResponse

示例

getHashTags 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let page = 987 // Double | (可选)
7
8DefaultAPI.getHashTags(tenantId: tenantId, page: page) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

修补标签 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
tagstringpath是

响应

返回: UpdateHashTagResponse

示例

patchHashTag 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let tag = "tag_example" // String |
7let updateHashTagBody = UpdateHashTagBody(tenantId: "tenantId_example", url: "url_example", tag: "tag_example") // UpdateHashTagBody | (可选)
8
9DefaultAPI.patchHashTag(tenantId: tenantId, tag: tag, updateHashTagBody: updateHashTagBody) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

删除审核投票 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
commentIdstringpath是
voteIdstringpath是
broadcastIdstringquery否
ssostringquery否

响应

返回:VoteDeleteResponse

示例

deleteModerationVote 示例
Copy Copy
1
2// 以下代码示例仍为 Beta 版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let voteId = "voteId_example" // String |
8let broadcastId = "broadcastId_example" // String | (可选)
9let sso = "sso_example" // String | (可选)
10
11ModerationAPI.deleteModerationVote(tenantId: tenantId, commentId: commentId, voteId: voteId, options: ModerationAPI.DeleteModerationVoteOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

获取 API 评论 Internal Link

参数

名称类型位置必填描述
tenantIdstring查询是
pagenumber查询否
countnumber查询否
text-searchstring查询否
byIPFromCommentstring查询否
filtersstring查询否
searchFiltersstring查询否
sortsstring查询否
demoboolean查询否
ssostring查询否

响应

返回:ModerationAPIGetCommentsResponse

示例

getApiComments 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let page = 987 // Double | (optional)
7let count = 987 // Double | (optional)
8let textSearch = "textSearch_example" // String | (optional)
9let byIPFromComment = "byIPFromComment_example" // String | (optional)
10let filters = "filters_example" // String | (optional)
11let searchFilters = "searchFilters_example" // String | (optional)
12let sorts = "sorts_example" // String | (optional)
13let demo = true // Bool | (optional)
14let sso = "sso_example" // String | (optional)
15
16ModerationAPI.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
17 guard error == nil else {
18 print(error)
19 return
20 }
21
22 if (response) {
23 dump(response)
24 }
25}
26

获取 API 导出状态 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
batchJobIdstringquery否
ssostringquery否

响应

返回: ModerationExportStatusResponse

示例

getApiExportStatus 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let batchJobId = "batchJobId_example" // String | (可选)
7let sso = "sso_example" // String | (可选)
8
9ModerationAPI.getApiExportStatus(tenantId: tenantId, options: ModerationAPI.GetApiExportStatusOptions(batchJobId: batchJobId, sso: sso)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

获取 API ID Internal Link

参数

名称类型位置必填描述
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
afterIdstringqueryNo
demobooleanqueryNo
ssostringqueryNo

响应

返回:ModerationAPIGetCommentIdsResponse

示例

getApiIds 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let textSearch = "textSearch_example" // String | (可选)
7let byIPFromComment = "byIPFromComment_example" // String | (可选)
8let filters = "filters_example" // String | (可选)
9let searchFilters = "searchFilters_example" // String | (可选)
10let afterId = "afterId_example" // String | (可选)
11let demo = true // Bool | (可选)
12let sso = "sso_example" // String | (可选)
13
14ModerationAPI.getApiIds(tenantId: tenantId, options: ModerationAPI.GetApiIdsOptions(textSearch: textSearch, byIPFromComment: byIPFromComment, filters: filters, searchFilters: searchFilters, afterId: afterId, demo: demo, sso: sso)) { (response, error) in
15 guard error == nil else {
16 print(error)
17 return
18 }
19
20 if (response) {
21 dump(response)
22 }
23}
24

获取因评论被封禁的用户 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
commentIdstringpath是
ssostringquery否

响应

返回: GetBannedUsersFromCommentResponse

示例

getBanUsersFromComment 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let sso = "sso_example" // String | (可选)
8
9ModerationAPI.getBanUsersFromComment(tenantId: tenantId, commentId: commentId, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

获取评论封禁状态 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
commentIdstringpath是
ssostringquery否

响应

返回:GetCommentBanStatusResponse

示例

getCommentBanStatus 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let sso = "sso_example" // String | (可选)
8
9ModerationAPI.getCommentBanStatus(tenantId: tenantId, commentId: commentId, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

获取评论子项 Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringquery是
commentIdstringpath是
ssostringquery否

Response

返回: ModerationAPIChildCommentsResponse

示例

获取评论子项 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let sso = "sso_example" // String | (可选)
8
9ModerationAPI.getCommentChildren(tenantId: tenantId, commentId: commentId, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

获取计数 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
text-searchstringquery否
byIPFromCommentstringquery否
filterstringquery否
searchFiltersstringquery否
demobooleanquery否
ssostringquery否

响应

返回:ModerationAPICountCommentsResponse

示例

getCount 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let textSearch = "textSearch_example" // String | (可选)
7let byIPFromComment = "byIPFromComment_example" // String | (可选)
8let filter = "filter_example" // String | (可选)
9let searchFilters = "searchFilters_example" // String | (可选)
10let demo = true // Bool | (可选)
11let sso = "sso_example" // String | (可选)
12
13ModerationAPI.getCount(tenantId: tenantId, options: ModerationAPI.GetCountOptions(textSearch: textSearch, byIPFromComment: byIPFromComment, filter: filter, searchFilters: searchFilters, demo: demo, sso: sso)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

获取计数列表 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
ssostringqueryNo

响应

返回:GetBannedUsersCountResponse

示例

getCounts 示例
Copy Copy
1
2// 以下代码示例仍在测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let sso = "sso_example" // String | (可选)
7
8ModerationAPI.getCounts(tenantId: tenantId, sso: sso) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取日志 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
commentIdstringpath是
ssostringquery否

响应

返回:ModerationAPIGetLogsResponse

示例

getLogs 示例
Copy Copy
1
2// 以下代码示例仍在测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let sso = "sso_example" // String | (可选)
8
9ModerationAPI.getLogs(tenantId: tenantId, commentId: commentId, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

获取手动徽章 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
ssostringquery否

响应

返回: GetTenantManualBadgesResponse

示例

getManualBadges 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let sso = "sso_example" // String | (可选)
7
8ModerationAPI.getManualBadges(tenantId: tenantId, sso: sso) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取用户手动徽章 Internal Link

参数

名称类型位置必填描述
tenantIdstringqueryYes
badgesUserIdstringqueryNo
commentIdstringqueryNo
ssostringqueryNo

响应

返回: GetUserManualBadgesResponse

示例

getManualBadgesForUser 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let badgesUserId = "badgesUserId_example" // String | (optional)
7let commentId = "commentId_example" // String | (optional)
8let sso = "sso_example" // String | (optional)
9
10ModerationAPI.getManualBadgesForUser(tenantId: tenantId, options: ModerationAPI.GetManualBadgesForUserOptions(badgesUserId: badgesUserId, commentId: commentId, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

获取审核评论 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
commentIdstringpath是
includeEmailbooleanquery否
includeIPbooleanquery否
ssostringquery否

响应

返回:ModerationAPICommentResponse

示例

getModerationComment 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let includeEmail = true // Bool | (optional)
8let includeIP = true // Bool | (optional)
9let sso = "sso_example" // String | (optional)
10
11ModerationAPI.getModerationComment(tenantId: tenantId, commentId: commentId, options: ModerationAPI.GetModerationCommentOptions(includeEmail: includeEmail, includeIP: includeIP, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

获取审核评论文本 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
commentIdstringpath是
ssostringquery否

响应

返回: GetCommentTextResponse

示例

getModerationCommentText 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 版。如有问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let sso = "sso_example" // String | (可选)
8
9ModerationAPI.getModerationCommentText(tenantId: tenantId, commentId: commentId, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

获取预封禁摘要 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
commentIdstringpath是
includeByUserIdAndEmailbooleanquery否
includeByIPbooleanquery否
includeByEmailDomainbooleanquery否
ssostringquery否

响应

返回:PreBanSummary

示例

getPreBanSummary 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 状态。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let includeByUserIdAndEmail = true // Bool | (optional)
8let includeByIP = true // Bool | (optional)
9let includeByEmailDomain = true // Bool | (optional)
10let sso = "sso_example" // String | (optional)
11
12ModerationAPI.getPreBanSummary(tenantId: tenantId, commentId: commentId, options: ModerationAPI.GetPreBanSummaryOptions(includeByUserIdAndEmail: includeByUserIdAndEmail, includeByIP: includeByIP, includeByEmailDomain: includeByEmailDomain, sso: sso)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

获取搜索评论摘要 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
valuestringquery否
filtersstringquery否
searchFiltersstringquery否
ssostringquery否

响应

返回:ModerationCommentSearchResponse

示例

getSearchCommentsSummary 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let value = "value_example" // String | (可选)
7let filters = "filters_example" // String | (可选)
8let searchFilters = "searchFilters_example" // String | (可选)
9let sso = "sso_example" // String | (可选)
10
11ModerationAPI.getSearchCommentsSummary(tenantId: tenantId, options: ModerationAPI.GetSearchCommentsSummaryOptions(value: value, filters: filters, searchFilters: searchFilters, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

获取搜索页面 Internal Link

参数

名称类型位置必填描述
tenantIdstringqueryYes
valuestringqueryNo
ssostringqueryNo

响应

返回:ModerationPageSearchResponse

示例

getSearchPages 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 阶段。若有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let value = "value_example" // String | (可选)
7let sso = "sso_example" // String | (可选)
8
9ModerationAPI.getSearchPages(tenantId: tenantId, options: ModerationAPI.GetSearchPagesOptions(value: value, sso: sso)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

获取搜索站点 Internal Link

参数

名称类型位置必需描述
tenantIdstringqueryYes
valuestringqueryNo
ssostringqueryNo

响应

返回:ModerationSiteSearchResponse

示例

getSearchSites 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let value = "value_example" // String | (optional)
7let sso = "sso_example" // String | (optional)
8
9ModerationAPI.getSearchSites(tenantId: tenantId, options: ModerationAPI.GetSearchSitesOptions(value: value, sso: sso)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

获取搜索建议 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
text-searchstringquery否
ssostringquery否

响应

返回:ModerationSuggestResponse

示例

getSearchSuggest 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let textSearch = "textSearch_example" // String | (可选)
7let sso = "sso_example" // String | (可选)
8
9ModerationAPI.getSearchSuggest(tenantId: tenantId, options: ModerationAPI.GetSearchSuggestOptions(textSearch: textSearch, sso: sso)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

获取搜索用户 Internal Link

参数

名称类型位置必需描述
tenantIdstringqueryYes
valuestringqueryNo
ssostringqueryNo

响应

返回: ModerationUserSearchResponse

示例

getSearchUsers 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let value = "value_example" // String | (可选)
7let sso = "sso_example" // String | (可选)
8
9ModerationAPI.getSearchUsers(tenantId: tenantId, options: ModerationAPI.GetSearchUsersOptions(value: value, sso: sso)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

获取信任因子 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
userIdstringquery否
ssostringquery否

响应

Returns: GetUserTrustFactorResponse

示例

getTrustFactor 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String | (可选)
7let sso = "sso_example" // String | (可选)
8
9ModerationAPI.getTrustFactor(tenantId: tenantId, options: ModerationAPI.GetTrustFactorOptions(userId: userId, sso: sso)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

获取用户封禁偏好 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
ssostringquery否

响应

返回:APIModerateGetUserBanPreferencesResponse

示例

getUserBanPreference 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let sso = "sso_example" // String | (可选)
7
8ModerationAPI.getUserBanPreference(tenantId: tenantId, sso: sso) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取用户内部资料 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
commentIdstringquery否
ssostringquery否

响应

返回:GetUserInternalProfileResponse

示例

getUserInternalProfile 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String | (optional)
7let sso = "sso_example" // String | (optional)
8
9ModerationAPI.getUserInternalProfile(tenantId: tenantId, options: ModerationAPI.GetUserInternalProfileOptions(commentId: commentId, sso: sso)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

调整评论投票 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
commentIdstringpath是
broadcastIdstringquery否
ssostringquery否

响应

返回:AdjustVotesResponse

示例

postAdjustCommentVotes 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let adjustCommentVotesParams = AdjustCommentVotesParams(adjustVoteAmount: 123) // AdjustCommentVotesParams |
8let broadcastId = "broadcastId_example" // String | (可选)
9let sso = "sso_example" // String | (可选)
10
11ModerationAPI.postAdjustCommentVotes(tenantId: tenantId, commentId: commentId, adjustCommentVotesParams: adjustCommentVotesParams, options: ModerationAPI.PostAdjustCommentVotesOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

API 导出 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
sortsstringqueryNo
ssostringqueryNo

响应

返回: ModerationExportResponse

示例

postApiExport 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 提交报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let textSearch = "textSearch_example" // String | (可选)
7let byIPFromComment = "byIPFromComment_example" // String | (可选)
8let filters = "filters_example" // String | (可选)
9let searchFilters = "searchFilters_example" // String | (可选)
10let sorts = "sorts_example" // String | (可选)
11let sso = "sso_example" // String | (可选)
12
13ModerationAPI.postApiExport(tenantId: tenantId, options: ModerationAPI.PostApiExportOptions(textSearch: textSearch, byIPFromComment: byIPFromComment, filters: filters, searchFilters: searchFilters, sorts: sorts, sso: sso)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

封禁用户评论 Internal Link

参数

名称类型位置必填描述
tenantIdstringqueryYes
commentIdstringpathYes
banEmailbooleanqueryNo
banEmailDomainbooleanqueryNo
banIPbooleanqueryNo
deleteAllUsersCommentsbooleanqueryNo
bannedUntilstringqueryNo
isShadowBanbooleanqueryNo
updateIdstringqueryNo
banReasonstringqueryNo
ssostringqueryNo

响应

返回: BanUserFromCommentResult

示例

postBanUserFromComment 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let banEmail = true // Bool | (optional)
8let banEmailDomain = true // Bool | (optional)
9let banIP = true // Bool | (optional)
10let deleteAllUsersComments = true // Bool | (optional)
11let bannedUntil = "bannedUntil_example" // String | (optional)
12let isShadowBan = true // Bool | (optional)
13let updateId = "updateId_example" // String | (optional)
14let banReason = "banReason_example" // String | (optional)
15let sso = "sso_example" // String | (optional)
16
17ModerationAPI.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
18 guard error == nil else {
19 print(error)
20 return
21 }
22
23 if (response) {
24 dump(response)
25 }
26}
27

撤销封禁用户 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
ssostringquery否

响应

返回:APIEmptyResponse

示例

postBanUserUndo 示例
Copy Copy
1
2// 以下代码示例仍为 beta 版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let 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 |
7let sso = "sso_example" // String | (可选)
8
9ModerationAPI.postBanUserUndo(tenantId: tenantId, banUserUndoParams: banUserUndoParams, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

批量预封禁摘要 Internal Link

参数

名称类型位置必填描述
tenantIdstringqueryYes
includeByUserIdAndEmailbooleanqueryNo
includeByIPbooleanqueryNo
includeByEmailDomainbooleanqueryNo
ssostringqueryNo

响应

返回: BulkPreBanSummary

示例

postBulkPreBanSummary 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let bulkPreBanParams = BulkPreBanParams(commentIds: ["commentIds_example"]) // BulkPreBanParams |
7let includeByUserIdAndEmail = true // Bool | (optional)
8let includeByIP = true // Bool | (optional)
9let includeByEmailDomain = true // Bool | (optional)
10let sso = "sso_example" // String | (optional)
11
12ModerationAPI.postBulkPreBanSummary(tenantId: tenantId, bulkPreBanParams: bulkPreBanParams, options: ModerationAPI.PostBulkPreBanSummaryOptions(includeByUserIdAndEmail: includeByUserIdAndEmail, includeByIP: includeByIP, includeByEmailDomain: includeByEmailDomain, sso: sso)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

按 ID 获取评论 Internal Link

参数

名称类型位置必填描述
tenantIdstringqueryYes
ssostringqueryNo

响应

返回: ModerationAPIChildCommentsResponse

示例

postCommentsByIds 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentsByIdsParams = CommentsByIdsParams(ids: ["ids_example"]) // CommentsByIdsParams |
7let sso = "sso_example" // String | (可选)
8
9ModerationAPI.postCommentsByIds(tenantId: tenantId, commentsByIdsParams: commentsByIdsParams, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

标记评论 Internal Link

参数

名称类型位置必需描述
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

响应

返回: APIEmptyResponse

示例

postFlagComment 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String | (可选)
8let sso = "sso_example" // String | (可选)
9
10ModerationAPI.postFlagComment(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostFlagCommentOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

移除评论 Internal Link

参数

名称类型位置必填描述
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

响应

返回: PostRemoveCommentApiResponse

示例

postRemoveComment 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String | (可选)
8let sso = "sso_example" // String | (可选)
9
10ModerationAPI.postRemoveComment(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostRemoveCommentOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

恢复已删除评论 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
commentIdstringpath是
broadcastIdstringquery否
ssostringquery否

响应

返回:APIEmptyResponse

示例

postRestoreDeletedComment 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String | (可选)
8let sso = "sso_example" // String | (可选)
9
10ModerationAPI.postRestoreDeletedComment(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostRestoreDeletedCommentOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

设置评论批准状态 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
approvedbooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

响应

返回: SetCommentApprovedResponse

示例

postSetCommentApprovalStatus 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 状态。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let approved = true // Bool | (optional)
8let broadcastId = "broadcastId_example" // String | (optional)
9let sso = "sso_example" // String | (optional)
10
11ModerationAPI.postSetCommentApprovalStatus(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostSetCommentApprovalStatusOptions(approved: approved, broadcastId: broadcastId, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

设置评论审查状态 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
commentIdstringpath是
reviewedbooleanquery否
broadcastIdstringquery否
ssostringquery否

响应

返回: APIEmptyResponse

示例

postSetCommentReviewStatus 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 版本。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let reviewed = true // Bool | (optional)
8let broadcastId = "broadcastId_example" // String | (optional)
9let sso = "sso_example" // String | (optional)
10
11ModerationAPI.postSetCommentReviewStatus(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostSetCommentReviewStatusOptions(reviewed: reviewed, broadcastId: broadcastId, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

设置评论垃圾状态 Internal Link

参数

名称类型位置必需描述
tenantIdstring查询是
commentIdstring路径是
spamboolean查询否
permNotSpamboolean查询否
broadcastIdstring查询否
ssostring查询否

响应

返回:APIEmptyResponse

示例

postSetCommentSpamStatus 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let spam = true // Bool | (optional)
8let permNotSpam = true // Bool | (optional)
9let broadcastId = "broadcastId_example" // String | (optional)
10let sso = "sso_example" // String | (optional)
11
12ModerationAPI.postSetCommentSpamStatus(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostSetCommentSpamStatusOptions(spam: spam, permNotSpam: permNotSpam, broadcastId: broadcastId, sso: sso)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

设置评论文本 Internal Link

参数

名称类型位置必需描述
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

响应

返回: SetCommentTextResponse

示例

postSetCommentText 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let setCommentTextParams = SetCommentTextParams(comment: "comment_example") // SetCommentTextParams |
8let broadcastId = "broadcastId_example" // String | (optional)
9let sso = "sso_example" // String | (optional)
10
11ModerationAPI.postSetCommentText(tenantId: tenantId, commentId: commentId, setCommentTextParams: setCommentTextParams, options: ModerationAPI.PostSetCommentTextOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

取消标记评论 Internal Link

参数

名称类型位置必填描述
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

响应

返回: APIEmptyResponse

示例

postUnFlagComment 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String | (可选)
8let sso = "sso_example" // String | (可选)
9
10ModerationAPI.postUnFlagComment(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostUnFlagCommentOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

投票 Internal Link

参数

名称类型位置必填描述
tenantIdstringqueryYes
commentIdstringpathYes
directionstringqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

响应

返回: VoteResponse

示例

postVote 示例
Copy Copy
1
2// 以下代码示例仍为 beta 版。如有问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let direction = "direction_example" // String | (optional)
8let broadcastId = "broadcastId_example" // String | (optional)
9let sso = "sso_example" // String | (optional)
10
11ModerationAPI.postVote(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostVoteOptions(direction: direction, broadcastId: broadcastId, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

授予徽章 Internal Link

参数

名称类型位置必填描述
tenantIdstringqueryYes
badgeIdstringqueryYes
userIdstringqueryNo
commentIdstringqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

响应

Returns: AwardUserBadgeResponse

示例

putAwardBadge 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let badgeId = "badgeId_example" // String |
7let userId = "userId_example" // String | (可选)
8let commentId = "commentId_example" // String | (可选)
9let broadcastId = "broadcastId_example" // String | (可选)
10let sso = "sso_example" // String | (可选)
11
12ModerationAPI.putAwardBadge(tenantId: tenantId, badgeId: badgeId, options: ModerationAPI.PutAwardBadgeOptions(userId: userId, commentId: commentId, broadcastId: broadcastId, sso: sso)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

关闭线程 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
urlIdstringquery是
ssostringquery否

响应

返回:APIEmptyResponse

示例

putCloseThread 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let sso = "sso_example" // String | (可选)
8
9ModerationAPI.putCloseThread(tenantId: tenantId, urlId: urlId, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

移除徽章 Internal Link

参数

名称类型位置必填描述
tenantIdstringqueryYes
badgeIdstringqueryYes
userIdstringqueryNo
commentIdstringqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

响应

Returns: RemoveUserBadgeResponse

示例

putRemoveBadge 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 提交报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let badgeId = "badgeId_example" // String |
7let userId = "userId_example" // String | (optional)
8let commentId = "commentId_example" // String | (optional)
9let broadcastId = "broadcastId_example" // String | (optional)
10let sso = "sso_example" // String | (optional)
11
12ModerationAPI.putRemoveBadge(tenantId: tenantId, badgeId: badgeId, options: ModerationAPI.PutRemoveBadgeOptions(userId: userId, commentId: commentId, broadcastId: broadcastId, sso: sso)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

重新打开线程 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
urlIdstringquery是
ssostringquery否

响应

返回:APIEmptyResponse

示例

putReopenThread 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 阶段。如有问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let sso = "sso_example" // String | (可选)
8
9ModerationAPI.putReopenThread(tenantId: tenantId, urlId: urlId, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

设置信任因子 Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
userIdstringqueryNo
trustFactorstringqueryNo
ssostringqueryNo

Response

返回: SetUserTrustFactorResponse

Example

setTrustFactor 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String | (可选)
7let trustFactor = "trustFactor_example" // String | (可选)
8let sso = "sso_example" // String | (可选)
9
10ModerationAPI.setTrustFactor(tenantId: tenantId, options: ModerationAPI.SetTrustFactorOptions(userId: userId, trustFactor: trustFactor, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

创建版主 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是

响应

返回: CreateModeratorResponse

示例

createModerator 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createModeratorBody = CreateModeratorBody(name: "name_example", email: "email_example", userId: "userId_example", moderationGroupIds: ["moderationGroupIds_example"]) // CreateModeratorBody |
7
8DefaultAPI.createModerator(tenantId: tenantId, createModeratorBody: createModeratorBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

删除版主 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是
sendEmailstringquery否

响应

返回: APIEmptyResponse

示例

deleteModerator 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let sendEmail = "sendEmail_example" // String | (可选)
8
9DefaultAPI.deleteModerator(tenantId: tenantId, id: id, sendEmail: sendEmail) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

获取版主 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是

响应

返回: GetModeratorResponse

示例

getModerator 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getModerator(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取版主列表 Internal Link

参数

名称类型位置必需描述
tenantIdstring查询是
skipnumber查询否

响应

返回: GetModeratorsResponse

示例

getModerators 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如遇任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let skip = 987 // Double | (可选)
7
8DefaultAPI.getModerators(tenantId: tenantId, skip: skip) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

发送邀请 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是
fromNamestringquery是

响应

返回: APIEmptyResponse

示例

sendInvite 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let fromName = "fromName_example" // String |
8
9DefaultAPI.sendInvite(tenantId: tenantId, id: id, fromName: fromName) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

更新版主 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是

响应

返回: APIEmptyResponse

示例

updateModerator 示例
Copy Copy
1
2// 以下代码示例仍为 beta。如遇任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateModeratorBody = UpdateModeratorBody(name: "name_example", email: "email_example", userId: "userId_example", moderationGroupIds: ["moderationGroupIds_example"]) // UpdateModeratorBody |
8
9DefaultAPI.updateModerator(tenantId: tenantId, id: id, updateModeratorBody: updateModeratorBody) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

删除通知计数 Internal Link


参数

名称类型位置必需描述
tenantIdstringquery是
idstringpath是

返回

返回:APIEmptyResponse

示例

deleteNotificationCount 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // 字符串 |
6let id = "id_example" // 字符串 |
7
8DefaultAPI.deleteNotificationCount(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取缓存的通知计数 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是

Response

返回: GetCachedNotificationCountResponse

示例

getCachedNotificationCount 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如遇问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getCachedNotificationCount(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取通知计数 Internal Link

参数

名称类型位置必填描述
tenantIdstringqueryYes
userIdstringqueryNo
urlIdstringqueryNo
fromCommentIdstringqueryNo
viewedbooleanqueryNo
typestringqueryNo

响应

返回:GetNotificationCountResponse

示例

getNotificationCount 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。若出现任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String | (可选)
7let urlId = "urlId_example" // String | (可选)
8let fromCommentId = "fromCommentId_example" // String | (可选)
9let viewed = true // Bool | (可选)
10let type = "type_example" // String | (可选)
11
12DefaultAPI.getNotificationCount(tenantId: tenantId, options: DefaultAPI.GetNotificationCountOptions(userId: userId, urlId: urlId, fromCommentId: fromCommentId, viewed: viewed, type: type)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

获取通知 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
userIdstringquery否
urlIdstringquery否
fromCommentIdstringquery否
viewedbooleanquery否
typestringquery否
skipnumberquery否

响应

返回: GetNotificationsResponse

示例

getNotifications 示例
Copy Copy
1
2// 以下代码示例仍属Beta。如有问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String | (可选)
7let urlId = "urlId_example" // String | (可选)
8let fromCommentId = "fromCommentId_example" // String | (可选)
9let viewed = true // Bool | (可选)
10let type = "type_example" // String | (可选)
11let skip = 987 // Double | (可选)
12
13DefaultAPI.getNotifications(tenantId: tenantId, options: DefaultAPI.GetNotificationsOptions(userId: userId, urlId: urlId, fromCommentId: fromCommentId, viewed: viewed, type: type, skip: skip)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

更新通知 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是
userIdstringquery否

响应

返回: APIEmptyResponse

示例

updateNotification 示例
Copy Copy
1
2// 下列代码示例仍处于测试版。如遇任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateNotificationBody = UpdateNotificationBody(viewed: false, optedOut: false) // UpdateNotificationBody |
8let userId = "userId_example" // String | (可选)
9
10DefaultAPI.updateNotification(tenantId: tenantId, id: id, updateNotificationBody: updateNotificationBody, userId: userId) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

创建 V1 页面反应 Internal Link

参数

名称类型位置必需描述
tenantIdstringpath是
urlIdstringquery是
titlestringquery否

响应

返回: CreateV1PageReact

示例

createV1PageReact 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如遇任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 提交报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let title = "title_example" // String | (可选)
8
9PublicAPI.createV1PageReact(tenantId: tenantId, urlId: urlId, title: title) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

创建 V2 页面反应 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringpath是
urlIdstringquery是
idstringquery是
titlestringquery否

响应

返回: CreateV1PageReact

示例

createV2PageReact 示例
Copy Copy
1
2// 以下代码示例仍属测试版。 如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let id = "id_example" // String |
8let title = "title_example" // String | (可选)
9
10PublicAPI.createV2PageReact(tenantId: tenantId, urlId: urlId, id: id, title: title) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

删除 V1 页面反应 Internal Link

参数

名称类型位置必需描述
tenantIdstringpath是
urlIdstringquery是

响应

返回: CreateV1PageReact

示例

deleteV1PageReact 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 提交报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7
8PublicAPI.deleteV1PageReact(tenantId: tenantId, urlId: urlId) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

删除 V2 页面反应 Internal Link


参数

名称类型位置必需描述
tenantIdstringpath是
urlIdstringquery是
idstringquery是

响应

返回: CreateV1PageReact

示例

deleteV2PageReact 示例
Copy Copy
1
2// 以下代码示例仍为测试版。若出现任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let id = "id_example" // String |
8
9PublicAPI.deleteV2PageReact(tenantId: tenantId, urlId: urlId, id: id) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

获取 V1 页面点赞 Internal Link

参数

名称类型位置必填描述
tenantIdstring路径是
urlIdstring查询是

响应

返回: GetV1PageLikes

示例

getV1PageLikes 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。若有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7
8PublicAPI.getV1PageLikes(tenantId: tenantId, urlId: urlId) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取 V2 页面反应 Internal Link


参数

名称类型位置必需描述
tenantIdstringpath是
urlIdstringquery是

响应

返回:GetV2PageReacts

示例

getV2PageReacts 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7
8PublicAPI.getV2PageReacts(tenantId: tenantId, urlId: urlId) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取 V2 页面反应用户 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringpath是
urlIdstringquery是
idstringquery是

响应

返回: GetV2PageReactUsersResponse

示例

getV2PageReactUsers 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。若有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let id = "id_example" // String |
8
9PublicAPI.getV2PageReactUsers(tenantId: tenantId, urlId: urlId, id: id) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

添加页面 Internal Link


参数

NameTypeLocationRequiredDescription
tenantIdstringquery是

响应

返回: AddPageAPIResponse

示例

addPage 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createAPIPageData = CreateAPIPageData(accessibleByGroupIds: ["accessibleByGroupIds_example"], rootCommentCount: 123, commentCount: 123, title: "title_example", url: "url_example", urlId: "urlId_example") // CreateAPIPageData |
7
8DefaultAPI.addPage(tenantId: tenantId, createAPIPageData: createAPIPageData) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

删除页面 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是

响应

返回: DeletePageAPIResponse

示例

deletePage 示例
Copy Copy
1
2// 下面的代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.deletePage(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取离线用户 Internal Link

Past commenters on the page who are NOT currently online. Sorted by displayName.
页面上过去的评论者(当前不在线)。按 displayName 排序。

Use this after exhausting /users/online to render a "Members" section.
在用尽 /users/online 之后使用,以呈现 “Members” 部分。

Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
在 commenterName 上使用游标分页:服务器从 afterName 向前遍历部分 {tenantId, urlId, commenterName} 索引,使用 $gt,没有 $skip 成本。

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYes页面 URL 标识符(服务器端已清理)。
afterNamestringqueryNo游标:从上一次响应中传递 nextAfterName。(可选)
afterUserIdstringqueryNo游标分割键:从上一次响应中传递 nextAfterUserId。当设置 afterName 时需要,以防名称相同导致条目被忽略。(可选)

Response

Returns: PageUsersOfflineResponse

Example

getOfflineUsers 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String | 页面 URL 标识符(服务器端已清理)。
7let afterName = "afterName_example" // String | 游标:从上一次响应中传递 nextAfterName。(可选)
8let afterUserId = "afterUserId_example" // String | 游标分割键:从上一次响应中传递 nextAfterUserId。当设置 afterName 时需要,以防名称相同导致条目被忽略。(可选)
9
10PublicAPI.getOfflineUsers(tenantId: tenantId, urlId: urlId, options: PublicAPI.GetOfflineUsersOptions(afterName: afterName, afterUserId: afterUserId)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

获取在线用户 Internal Link

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

参数

名称类型位置必需描述
tenantIdstringpathYes
urlIdstringqueryYes页面 URL 标识符(服务器端清理后)。
afterNamestringqueryNo光标:从上一次响应中传递 nextAfterName。
afterUserIdstringqueryNo光标平局解决器:从上一次响应中传递 nextAfterUserId。当设置 afterName 时需要此字段,以防止名称平局导致条目丢失。

响应

返回:PageUsersOnlineResponse

示例

获取在线用户 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String | 页面 URL 标识符(服务器端清理后)。
7let afterName = "afterName_example" // String | 光标:从上一次响应中传递 nextAfterName。(可选)
8let afterUserId = "afterUserId_example" // String | 光标平局解决器:从上一次响应中传递 nextAfterUserId。当设置 afterName 时需要此字段,以防止名称平局导致条目丢失。(可选)
9
10PublicAPI.getOnlineUsers(tenantId: tenantId, urlId: urlId, options: PublicAPI.GetOnlineUsersOptions(afterName: afterName, afterUserId: afterUserId)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

按 URL ID 获取页面 Internal Link

参数

名称类型位置必填描述
tenantIdstringqueryYes
urlIdstringqueryYes

响应

返回: GetPageByURLIdAPIResponse

示例

getPageByURLId 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7
8DefaultAPI.getPageByURLId(tenantId: tenantId, urlId: urlId) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取页面列表 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是

响应

返回: GetPagesAPIResponse

示例

getPages 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // 字符串 |
6
7DefaultAPI.getPages(tenantId: tenantId) { (response, error) in
8 guard error == nil else {
9 print(error)
10 return
11 }
12
13 if (response) {
14 dump(response)
15 }
16}
17

公开获取页面 Internal Link

List pages for a tenant. Used by the FChat desktop client to populate its room list.
Requires enableFChat to be true on the resolved custom config for each page.
Pages that require SSO are filtered against the requesting user's group access.

Parameters

名称类型位置必填描述
tenantIdstringpathYes
cursorstringqueryNo不透明的分页游标,由先前请求返回的 nextCursor 提供。与相同的 sortBy 关联。
limitintegerqueryNo1..200,默认 50
qstringqueryNo可选的大小写不敏感的标题前缀过滤器。
sortBystringqueryNo排序顺序。updatedAt(默认,最新优先),commentCount(评论数最高优先),或 title(字母顺序)。
hasCommentsbooleanqueryNo如果为 true,则仅返回至少有一条评论的页面。

Response

Returns: GetPublicPagesResponse

Example

getPagesPublic 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let cursor = "cursor_example" // String | 不透明的分页游标,由先前请求返回的 `nextCursor` 提供。与相同的 `sortBy` 关联。(可选)
7let limit = 987 // Int | 1..200,默认 50(可选)
8let q = "q_example" // String | 可选的大小写不敏感的标题前缀过滤器。(可选)
9let sortBy = PagesSortBy() // PagesSortBy | 排序顺序。`updatedAt`(默认,最新优先),`commentCount`(评论数最高优先),或 `title`(字母顺序)。(可选)
10let hasComments = true // Bool | 如果为 true,则仅返回至少有一条评论的页面。(可选)
11
12PublicAPI.getPagesPublic(tenantId: tenantId, options: PublicAPI.GetPagesPublicOptions(cursor: cursor, limit: limit, q: q, sortBy: sortBy, hasComments: hasComments)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

获取用户信息 Internal Link

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

参数

名称类型位置必需描述
tenantIdstringpath是
idsstringquery是以逗号分隔的 userIds。

响应

返回:PageUsersInfoResponse

示例

getUsersInfo 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如遇任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let ids = "ids_example" // String | 以逗号分隔的 userIds。
7
8PublicAPI.getUsersInfo(tenantId: tenantId, ids: ids) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

修补页面 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

响应

返回: PatchPageAPIResponse

示例

patchPage 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如果有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateAPIPageData = UpdateAPIPageData(isClosed: false, accessibleByGroupIds: ["accessibleByGroupIds_example"], title: "title_example", url: "url_example", urlId: "urlId_example") // UpdateAPIPageData |
8
9DefaultAPI.patchPage(tenantId: tenantId, id: id, updateAPIPageData: updateAPIPageData) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

删除待处理 webhook 事件 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
idstringpath是

响应

返回: APIEmptyResponse

示例

deletePendingWebhookEvent 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // 字符串 |
6let id = "id_example" // 字符串 |
7
8DefaultAPI.deletePendingWebhookEvent(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取待处理 webhook 事件计数 Internal Link

参数

名称类型位置必填描述
tenantIdstringqueryYes
commentIdstringqueryNo
externalIdstringqueryNo
eventTypestringqueryNo
typestringqueryNo
domainstringqueryNo
attemptCountGTnumberqueryNo

响应

返回:GetPendingWebhookEventCountResponse

示例

getPendingWebhookEventCount 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String | (可选)
7let externalId = "externalId_example" // String | (可选)
8let eventType = "eventType_example" // String | (可选)
9let type = "type_example" // String | (可选)
10let domain = "domain_example" // String | (可选)
11let attemptCountGT = 987 // Double | (可选)
12
13DefaultAPI.getPendingWebhookEventCount(tenantId: tenantId, options: DefaultAPI.GetPendingWebhookEventCountOptions(commentId: commentId, externalId: externalId, eventType: eventType, type: type, domain: domain, attemptCountGT: attemptCountGT)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

获取待处理 webhook 事件 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
commentIdstringquery否
externalIdstringquery否
eventTypestringquery否
typestringquery否
domainstringquery否
attemptCountGTnumberquery否
skipnumberquery否

响应

返回:GetPendingWebhookEventsResponse

示例

getPendingWebhookEvents 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String | (可选)
7let externalId = "externalId_example" // String | (可选)
8let eventType = "eventType_example" // String | (可选)
9let type = "type_example" // String | (可选)
10let domain = "domain_example" // String | (可选)
11let attemptCountGT = 987 // Double | (可选)
12let skip = 987 // Double | (可选)
13
14DefaultAPI.getPendingWebhookEvents(tenantId: tenantId, options: DefaultAPI.GetPendingWebhookEventsOptions(commentId: commentId, externalId: externalId, eventType: eventType, type: type, domain: domain, attemptCountGT: attemptCountGT, skip: skip)) { (response, error) in
15 guard error == nil else {
16 print(error)
17 return
18 }
19
20 if (response) {
21 dump(response)
22 }
23}
24

创建问题配置 Internal Link


参数

NameTypeLocationRequiredDescription
tenantIdstringquery是

Response

返回: CreateQuestionConfigResponse

示例

createQuestionConfig 示例
Copy Copy
1
2// 以下代码示例仍在测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let 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, reportingOrder: 123) // CreateQuestionConfigBody |
7
8DefaultAPI.createQuestionConfig(tenantId: tenantId, createQuestionConfigBody: createQuestionConfigBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

删除问题配置 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
idstringpath是

响应

返回:APIEmptyResponse

示例

deleteQuestionConfig 示例
Copy Copy
1
2// 下面的代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.deleteQuestionConfig(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取问题配置 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是

响应

返回:GetQuestionConfigResponse

示例

getQuestionConfig 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getQuestionConfig(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取问题配置列表 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
skipnumberquery否

响应

返回:GetQuestionConfigsResponse

示例

getQuestionConfigs 示例
Copy Copy
1
2// 下列代码示例仍处于测试阶段。如遇任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let skip = 987 // Double | (可选)
7
8DefaultAPI.getQuestionConfigs(tenantId: tenantId, skip: skip) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

更新问题配置 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是

响应

返回: APIEmptyResponse

示例

updateQuestionConfig 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let 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, reportingOrder: 123) // UpdateQuestionConfigBody |
8
9DefaultAPI.updateQuestionConfig(tenantId: tenantId, id: id, updateQuestionConfigBody: updateQuestionConfigBody) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

创建问题结果 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是

响应

返回: CreateQuestionResultResponse

示例

createQuestionResult 示例
Copy Copy
1
2// 以下代码示例仍属测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createQuestionResultBody = CreateQuestionResultBody(urlId: "urlId_example", value: 123, questionId: "questionId_example", anonUserId: "anonUserId_example", userId: "userId_example", commentId: "commentId_example", meta: [MetaItem(name: "name_example", values: ["values_example"])]) // CreateQuestionResultBody |
7
8DefaultAPI.createQuestionResult(tenantId: tenantId, createQuestionResultBody: createQuestionResultBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

删除问题结果 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

响应

返回: APIEmptyResponse

示例

deleteQuestionResult 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.deleteQuestionResult(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取问题结果 Internal Link


参数

名称类型位置必填描述
tenantIdstringquery是
idstringpath是

响应

返回:GetQuestionResultResponse

示例

getQuestionResult 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getQuestionResult(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取问题结果列表 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
urlIdstringquery否
userIdstringquery否
startDatestringquery否
questionIdstringquery否
questionIdsstringquery否
skipnumberquery否

响应

返回:GetQuestionResultsResponse

示例

getQuestionResults 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。若有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String | (可选)
7let userId = "userId_example" // String | (可选)
8let startDate = "startDate_example" // String | (可选)
9let questionId = "questionId_example" // String | (可选)
10let questionIds = "questionIds_example" // String | (可选)
11let skip = 987 // Double | (可选)
12
13DefaultAPI.getQuestionResults(tenantId: tenantId, options: DefaultAPI.GetQuestionResultsOptions(urlId: urlId, userId: userId, startDate: startDate, questionId: questionId, questionIds: questionIds, skip: skip)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

更新问题结果 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
idstringpath是

响应

返回: APIEmptyResponse

示例

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

聚合问题结果 Internal Link

参数

名称类型位置必需描述
tenantIdstringqueryYes
questionIdstringqueryNo
questionIdsarrayqueryNo
urlIdstringqueryNo
timeBucketstringqueryNo
startDatestringqueryNo
forceRecalculatebooleanqueryNo

响应

返回: AggregateQuestionResultsResponse

示例

aggregateQuestionResults 示例
Copy Copy
1
2// 以下代码示例仍在测试阶段。 如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let questionId = "questionId_example" // String | (optional) => // String | (可选)
7let questionIds = ["inner_example"] // [String] | (optional) => // [String] | (可选)
8let urlId = "urlId_example" // String | (optional) => // String | (可选)
9let timeBucket = AggregateTimeBucket() // AggregateTimeBucket | (optional) => // AggregateTimeBucket | (可选)
10let startDate = Date() // Date | (optional) => // Date | (可选)
11let forceRecalculate = true // Bool | (optional) => // Bool | (可选)
12
13DefaultAPI.aggregateQuestionResults(tenantId: tenantId, options: DefaultAPI.AggregateQuestionResultsOptions(questionId: questionId, questionIds: questionIds, urlId: urlId, timeBucket: timeBucket, startDate: startDate, forceRecalculate: forceRecalculate)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

批量聚合问题结果 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
forceRecalculatebooleanquery否

响应

返回:BulkAggregateQuestionResultsResponse

示例

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

将评论与问题结果合并 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
questionIdstringquery否
questionIdsarrayquery否
urlIdstringquery否
startDatestringquery否
forceRecalculatebooleanquery否
minValuenumberquery否
maxValuenumberquery否
limitnumberquery否

响应

返回:CombineQuestionResultsWithCommentsResponse

示例

combineCommentsWithQuestionResults 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 提交报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let questionId = "questionId_example" // String | (可选)
7let questionIds = ["inner_example"] // [String] | (可选)
8let urlId = "urlId_example" // String | (可选)
9let startDate = Date() // Date | (可选)
10let forceRecalculate = true // Bool | (可选)
11let minValue = 987 // Double | (可选)
12let maxValue = 987 // Double | (可选)
13let limit = 987 // Double | (可选)
14
15DefaultAPI.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
16 guard error == nil else {
17 print(error)
18 return
19 }
20
21 if (response) {
22 dump(response)
23 }
24}
25

添加 SSO 用户 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是

响应

返回:AddSSOUserAPIResponse

示例

addSSOUser 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let 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 |
7
8DefaultAPI.addSSOUser(tenantId: tenantId, createAPISSOUserData: createAPISSOUserData) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

删除 SSO 用户 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
deleteCommentsbooleanqueryNo
commentDeleteModestringqueryNo

响应

返回: DeleteSSOUserAPIResponse

示例

deleteSSOUser 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let deleteComments = true // Bool | (optional)
8let commentDeleteMode = "commentDeleteMode_example" // String | (optional)
9
10DefaultAPI.deleteSSOUser(tenantId: tenantId, id: id, options: DefaultAPI.DeleteSSOUserOptions(deleteComments: deleteComments, commentDeleteMode: commentDeleteMode)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

按邮箱获取 SSO 用户 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
emailstringpath是

响应

返回:GetSSOUserByEmailAPIResponse

示例

getSSOUserByEmail 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let email = "email_example" // String |
7
8DefaultAPI.getSSOUserByEmail(tenantId: tenantId, email: email) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

按 ID 获取 SSO 用户 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
idstringpath是

响应

返回: GetSSOUserByIdAPIResponse

示例

getSSOUserById 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getSSOUserById(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取 SSO 用户列表 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
skipintegerquery否

响应

返回: GetSSOUsersResponse

示例

getSSOUsers 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // 字符串 |
6let skip = 987 // 整数 | (可选)
7
8DefaultAPI.getSSOUsers(tenantId: tenantId, skip: skip) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

修补 SSO 用户 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
idstringpath是
updateCommentsbooleanquery否

响应

返回: PatchSSOUserAPIResponse

示例

patchSSOUser 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let 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 |
8let updateComments = true // Bool | (optional)
9
10DefaultAPI.patchSSOUser(tenantId: tenantId, id: id, updateAPISSOUserData: updateAPISSOUserData, updateComments: updateComments) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

放置 SSO 用户 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是
updateCommentsbooleanquery否

响应

返回: PutSSOUserAPIResponse

示例

putSSOUser 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let 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 |
8let updateComments = true // Bool | (可选)
9
10DefaultAPI.putSSOUser(tenantId: tenantId, id: id, updateAPISSOUserData: updateAPISSOUserData, updateComments: updateComments) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

创建订阅 Internal Link


参数

NameTypeLocationRequiredDescription
tenantIdstringquery是

响应

返回: CreateSubscriptionAPIResponse

示例

createSubscription 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createAPIUserSubscriptionData = CreateAPIUserSubscriptionData(notificationFrequency: 123, pageTitle: "pageTitle_example", url: "url_example", urlId: "urlId_example", anonUserId: "anonUserId_example", userId: "userId_example") // CreateAPIUserSubscriptionData |
7
8DefaultAPI.createSubscription(tenantId: tenantId, createAPIUserSubscriptionData: createAPIUserSubscriptionData) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

删除订阅 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是
userIdstringquery否

响应

返回:DeleteSubscriptionAPIResponse

示例

deleteSubscription 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let userId = "userId_example" // String | (可选)
8
9DefaultAPI.deleteSubscription(tenantId: tenantId, id: id, userId: userId) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

获取订阅列表 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
userIdstringquery否

响应

返回: GetSubscriptionsAPIResponse

示例

getSubscriptions 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String | (可选)
7
8DefaultAPI.getSubscriptions(tenantId: tenantId, userId: userId) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

更新订阅 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是
userIdstringquery否

响应

返回: UpdateSubscriptionAPIResponse

示例

updateSubscription 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateAPIUserSubscriptionData = UpdateAPIUserSubscriptionData(notificationFrequency: 123) // UpdateAPIUserSubscriptionData |
8let userId = "userId_example" // String | (可选)
9
10DefaultAPI.updateSubscription(tenantId: tenantId, id: id, updateAPIUserSubscriptionData: updateAPIUserSubscriptionData, userId: userId) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

获取租户每日使用情况 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
yearNumbernumberquery否
monthNumbernumberquery否
dayNumbernumberquery否
skipnumberquery否

响应

返回: GetTenantDailyUsagesResponse

示例

getTenantDailyUsages 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let yearNumber = 987 // Double | (可选)
7let monthNumber = 987 // Double | (可选)
8let dayNumber = 987 // Double | (可选)
9let skip = 987 // Double | (可选)
10
11DefaultAPI.getTenantDailyUsages(tenantId: tenantId, options: DefaultAPI.GetTenantDailyUsagesOptions(yearNumber: yearNumber, monthNumber: monthNumber, dayNumber: dayNumber, skip: skip)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

创建租户套餐 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是

响应

返回: CreateTenantPackageResponse

示例

createTenantPackage 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let 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 |
7
8DefaultAPI.createTenantPackage(tenantId: tenantId, createTenantPackageBody: createTenantPackageBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

删除租户套餐 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
idstringpath是

响应

返回: APIEmptyResponse

示例

deleteTenantPackage 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如遇任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.deleteTenantPackage(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取租户套餐 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
idstringpath是

响应

返回: GetTenantPackageResponse

示例

getTenantPackage 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // 字符串 |
6let id = "id_example" // 字符串 |
7
8DefaultAPI.getTenantPackage(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取租户套餐列表 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
skipnumberquery否

响应

返回: GetTenantPackagesResponse

示例

getTenantPackages 示例
Copy Copy
1
2// 以下代码示例仍为测试版。若有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let skip = 987 // Double | (可选)
7
8DefaultAPI.getTenantPackages(tenantId: tenantId, skip: skip) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

替换租户套餐 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是

响应

返回: APIEmptyResponse

示例

replaceTenantPackage 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let 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 |
8
9DefaultAPI.replaceTenantPackage(tenantId: tenantId, id: id, replaceTenantPackageBody: replaceTenantPackageBody) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

更新租户套餐 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
idstringpath是

响应

返回: APIEmptyResponse

示例

updateTenantPackage 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let 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 |
8
9DefaultAPI.updateTenantPackage(tenantId: tenantId, id: id, updateTenantPackageBody: updateTenantPackageBody) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

创建租户用户 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是

Response

返回: CreateTenantUserResponse

示例

createTenantUser 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let 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 |
7
8DefaultAPI.createTenantUser(tenantId: tenantId, createTenantUserBody: createTenantUserBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

删除租户用户 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
idstringpath是
deleteCommentsstringquery否
commentDeleteModestringquery否

响应

返回:APIEmptyResponse

示例

deleteTenantUser 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let deleteComments = "deleteComments_example" // String | (optional)
8let commentDeleteMode = "commentDeleteMode_example" // String | (optional)
9
10DefaultAPI.deleteTenantUser(tenantId: tenantId, id: id, options: DefaultAPI.DeleteTenantUserOptions(deleteComments: deleteComments, commentDeleteMode: commentDeleteMode)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

获取租户用户 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

返回: GetTenantUserResponse

示例

getTenantUser 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如遇任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getTenantUser(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取租户用户列表 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
skipnumberquery否

响应

返回: GetTenantUsersResponse

示例

getTenantUsers 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 提交报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let skip = 987 // Double | (可选)
7
8DefaultAPI.getTenantUsers(tenantId: tenantId, skip: skip) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

替换租户用户 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是
updateCommentsstringquery否

响应

返回: APIEmptyResponse

示例

replaceTenantUser 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如遇到任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let 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 |
8let updateComments = "updateComments_example" // String | (可选)
9
10DefaultAPI.replaceTenantUser(tenantId: tenantId, id: id, replaceTenantUserBody: replaceTenantUserBody, updateComments: updateComments) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是
redirectURLstringquery否

响应

返回: APIEmptyResponse

示例

sendLoginLink 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let redirectURL = "redirectURL_example" // String | (可选)
8
9DefaultAPI.sendLoginLink(tenantId: tenantId, id: id, redirectURL: redirectURL) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

更新租户用户 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是
updateCommentsstringquery否

响应

返回:APIEmptyResponse

示例

updateTenantUser 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let 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 |
8let updateComments = "updateComments_example" // String | (可选)
9
10DefaultAPI.updateTenantUser(tenantId: tenantId, id: id, updateTenantUserBody: updateTenantUserBody, updateComments: updateComments) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

创建租户 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是

响应

返回: CreateTenantResponse

示例

createTenant 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let 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, createdBy: "createdBy_example", 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"), 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 |
7
8DefaultAPI.createTenant(tenantId: tenantId, createTenantBody: createTenantBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

删除租户 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是
surestringquery否

响应

返回:APIEmptyResponse

示例

deleteTenant 示例
Copy Copy
1
2// 以下代码样例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let sure = "sure_example" // String | (可选)
8
9DefaultAPI.deleteTenant(tenantId: tenantId, id: id, sure: sure) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

获取租户 Internal Link


参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是

响应

返回: GetTenantResponse

示例

getTenant 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getTenant(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取租户列表 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
metastringquery否
skipnumberquery否

响应

返回:GetTenantsResponse

示例

getTenants 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let meta = "meta_example" // String | (可选)
7let skip = 987 // Double | (可选)
8
9DefaultAPI.getTenants(tenantId: tenantId, options: DefaultAPI.GetTenantsOptions(meta: meta, skip: skip)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

更新租户 Internal Link


参数

名称类型位置必需描述
tenantIdstringquery是
idstringpath是

响应

返回:APIEmptyResponse

示例

updateTenant 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateTenantBody = UpdateTenantBody(name: "name_example", email: "email_example", signUpDate: 123, packageId: "packageId_example", paymentFrequency: 123, billingInfoValid: false, billingHandledExternally: false, createdBy: "createdBy_example", 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"), 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 |
8
9DefaultAPI.updateTenant(tenantId: tenantId, id: id, updateTenantBody: updateTenantBody) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

更改工单状态 Internal Link


参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
userIdstringquery是
idstringpath是

响应

返回: ChangeTicketStateResponse

示例

changeTicketState 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如遇问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String |
7let id = "id_example" // String |
8let changeTicketStateBody = ChangeTicketStateBody(state: 123) // ChangeTicketStateBody |
9
10DefaultAPI.changeTicketState(tenantId: tenantId, userId: userId, id: id, changeTicketStateBody: changeTicketStateBody) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

创建工单 Internal Link


参数

名称类型位置必填描述
tenantIdstringquery是
userIdstringquery是

响应

返回: CreateTicketResponse

示例

createTicket 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如遇任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String |
7let createTicketBody = CreateTicketBody(subject: "subject_example") // CreateTicketBody |
8
9DefaultAPI.createTicket(tenantId: tenantId, userId: userId, createTicketBody: createTicketBody) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

获取工单 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是
userIdstringquery否

响应

返回: GetTicketResponse

示例

getTicket 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let userId = "userId_example" // String | (可选)
8
9DefaultAPI.getTicket(tenantId: tenantId, id: id, userId: userId) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

获取工单列表 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
userIdstringquery否
statenumberquery否
skipnumberquery否
limitnumberquery否

响应

返回:GetTicketsResponse

示例

getTickets 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String | (可选)
7let state = 987 // Double | (可选)
8let skip = 987 // Double | (可选)
9let limit = 987 // Double | (可选)
10
11DefaultAPI.getTickets(tenantId: tenantId, options: DefaultAPI.GetTicketsOptions(userId: userId, state: state, skip: skip, limit: limit)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

获取翻译 Internal Link

参数

名称类型位置必需描述
namespacestringpath是
componentstringpath是
localestringquery否
useFullTranslationIdsbooleanquery否

响应

返回:GetTranslationsResponse

示例

getTranslations 示例
Copy Copy
1
2// 以下代码示例仍处于beta阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let namespace = "namespace_example" // String |
6let component = "component_example" // String |
7let locale = "locale_example" // String | (可选)
8let useFullTranslationIds = true // Bool | (可选)
9
10PublicAPI.getTranslations(namespace: namespace, component: component, options: PublicAPI.GetTranslationsOptions(locale: locale, useFullTranslationIds: useFullTranslationIds)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

上传图片 Internal Link


上传并调整图像大小

参数

名称类型位置必需描述
tenantIdstringpathYes
sizePresetstringqueryNo尺寸预设:"Default" (1000x1000px) 或 "CrossPlatform" (为流行设备创建尺寸)
urlIdstringqueryNo上传所在页面的 ID,用于配置

响应

Returns: UploadImageResponse

示例

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

按 ID 获取用户徽章进度 Internal Link

参数

名称类型位置必填说明
tenantIdstringquery是
idstringpath是

响应

返回: APIGetUserBadgeProgressResponse

示例

getUserBadgeProgressById 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // 字符串 |
6let id = "id_example" // 字符串 |
7
8DefaultAPI.getUserBadgeProgressById(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

按用户 ID 获取徽章进度 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
userIdstringpath是

响应

返回: APIGetUserBadgeProgressResponse

示例

getUserBadgeProgressByUserId 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String |
7
8DefaultAPI.getUserBadgeProgressByUserId(tenantId: tenantId, userId: userId) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取用户徽章进度列表 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
userIdstringquery否
limitnumberquery否
skipnumberquery否

响应

返回: APIGetUserBadgeProgressListResponse

示例

getUserBadgeProgressList 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String | (可选)
7let limit = 987 // Double | (可选)
8let skip = 987 // Double | (可选)
9
10DefaultAPI.getUserBadgeProgressList(tenantId: tenantId, options: DefaultAPI.GetUserBadgeProgressListOptions(userId: userId, limit: limit, skip: skip)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

创建用户徽章 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是

响应

返回:APICreateUserBadgeResponse

示例

createUserBadge 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如遇任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createUserBadgeParams = CreateUserBadgeParams(userId: "userId_example", badgeId: "badgeId_example", displayedOnComments: false) // CreateUserBadgeParams |
7
8DefaultAPI.createUserBadge(tenantId: tenantId, createUserBadgeParams: createUserBadgeParams) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

删除用户徽章 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是

响应

返回: APIEmptySuccessResponse

示例

deleteUserBadge 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // 字符串 |
6let id = "id_example" // 字符串 |
7
8DefaultAPI.deleteUserBadge(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取用户徽章 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
idstringpath是

响应

返回: APIGetUserBadgeResponse

示例

getUserBadge 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如遇任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getUserBadge(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取用户徽章列表 Internal Link

参数

名称类型位置必填描述
tenantIdstring查询是
userIdstring查询否
badgeIdstring查询否
typenumber查询否
displayedOnCommentsboolean查询否
limitnumber查询否
skipnumber查询否

响应

返回: APIGetUserBadgesResponse

示例

getUserBadges 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String | (可选)
7let badgeId = "badgeId_example" // String | (可选)
8let type = 987 // Double | (可选)
9let displayedOnComments = true // Bool | (可选)
10let limit = 987 // Double | (可选)
11let skip = 987 // Double | (可选)
12
13DefaultAPI.getUserBadges(tenantId: tenantId, options: DefaultAPI.GetUserBadgesOptions(userId: userId, badgeId: badgeId, type: type, displayedOnComments: displayedOnComments, limit: limit, skip: skip)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

更新用户徽章 Internal Link


参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是

响应

返回: APIEmptySuccessResponse

示例

updateUserBadge 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateUserBadgeParams = UpdateUserBadgeParams(displayedOnComments: false) // UpdateUserBadgeParams |
8
9DefaultAPI.updateUserBadge(tenantId: tenantId, id: id, updateUserBadgeParams: updateUserBadgeParams) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

获取用户通知计数 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
ssostringquery否

响应

返回: GetUserNotificationCountResponse

示例

getUserNotificationCount 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let sso = "sso_example" // String | (可选)
7
8PublicAPI.getUserNotificationCount(tenantId: tenantId, sso: sso) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取用户通知 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
urlIdstringquery否用于确定当前页面是否已订阅。
pageSizeintegerquery否
afterIdstringquery否
includeContextbooleanquery否
afterCreatedAtintegerquery否
unreadOnlybooleanquery否
dmOnlybooleanquery否
noDmbooleanquery否
includeTranslationsbooleanquery否
includeTenantNotificationsbooleanquery否
ssostringquery否

响应

返回:GetMyNotificationsResponse

示例

获取用户通知 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String | 用于确定当前页面是否已订阅。 (可选)
7let pageSize = 987 // Int | (可选)
8let afterId = "afterId_example" // String | (可选)
9let includeContext = true // Bool | (可选)
10let afterCreatedAt = 987 // Int64 | (可选)
11let unreadOnly = true // Bool | (可选)
12let dmOnly = true // Bool | (可选)
13let noDm = true // Bool | (可选)
14let includeTranslations = true // Bool | (可选)
15let includeTenantNotifications = true // Bool | (可选)
16let sso = "sso_example" // String | (可选)
17
18PublicAPI.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
19 guard error == nil else {
20 print(error)
21 return
22 }
23
24 if (response) {
25 dump(response)
26 }
27}
28

重置用户通知计数 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
ssostringquery否

响应

返回:ResetUserNotificationsResponse

示例

resetUserNotificationCount 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如遇到任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let sso = "sso_example" // String | (可选)
7
8PublicAPI.resetUserNotificationCount(tenantId: tenantId, sso: sso) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

重置用户通知 Internal Link

参数

名称类型位置必需描述
tenantIdstringqueryYes
afterIdstringqueryNo
afterCreatedAtintegerqueryNo
unreadOnlybooleanqueryNo
dmOnlybooleanqueryNo
noDmbooleanqueryNo
ssostringqueryNo

响应

返回: ResetUserNotificationsResponse

示例

resetUserNotifications 示例
Copy Copy
1
2// 以下代码示例仍为 Beta 版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let afterId = "afterId_example" // String | (可选)
7let afterCreatedAt = 987 // Int64 | (可选)
8let unreadOnly = true // Bool | (可选)
9let dmOnly = true // Bool | (可选)
10let noDm = true // Bool | (可选)
11let sso = "sso_example" // String | (可选)
12
13PublicAPI.resetUserNotifications(tenantId: tenantId, options: PublicAPI.ResetUserNotificationsOptions(afterId: afterId, afterCreatedAt: afterCreatedAt, unreadOnly: unreadOnly, dmOnly: dmOnly, noDm: noDm, sso: sso)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

更新用户通知评论订阅状态 Internal Link

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

参数

名称类型位置必填描述
tenantIdstring查询是
notificationIdstring路径是
optedInOrOutstring路径是
commentIdstring查询是
ssostring查询否

响应

返回:UpdateUserNotificationCommentSubscriptionStatusResponse

示例

updateUserNotificationCommentSubscriptionStatus 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如遇问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // 字符串 |
6let notificationId = "notificationId_example" // 字符串 |
7let optedInOrOut = "optedInOrOut_example" // 字符串 |
8let commentId = "commentId_example" // 字符串 |
9let sso = "sso_example" // 字符串 | (可选)
10
11PublicAPI.updateUserNotificationCommentSubscriptionStatus(tenantId: tenantId, notificationId: notificationId, optedInOrOut: optedInOrOut, commentId: commentId, sso: sso) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

更新用户通知页面订阅状态 Internal Link

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

参数

名称类型位置必填描述
tenantIdstringquery是
urlIdstringquery是
urlstringquery是
pageTitlestringquery是
subscribedOrUnsubscribedstringpath是
ssostringquery否

响应

返回: UpdateUserNotificationPageSubscriptionStatusResponse

示例

updateUserNotificationPageSubscriptionStatus 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let url = "url_example" // String |
8let pageTitle = "pageTitle_example" // String |
9let subscribedOrUnsubscribed = "subscribedOrUnsubscribed_example" // String |
10let sso = "sso_example" // String | (optional)
11
12PublicAPI.updateUserNotificationPageSubscriptionStatus(tenantId: tenantId, urlId: urlId, url: url, pageTitle: pageTitle, subscribedOrUnsubscribed: subscribedOrUnsubscribed, sso: sso) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

更新用户通知状态 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery是
notificationIdstringpath是
newStatusstringpath是
ssostringquery否

响应

返回: UpdateUserNotificationStatusResponse

示例

updateUserNotificationStatus 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let notificationId = "notificationId_example" // String |
7let newStatus = "newStatus_example" // String |
8let sso = "sso_example" // String | (可选)
9
10PublicAPI.updateUserNotificationStatus(tenantId: tenantId, notificationId: notificationId, newStatus: newStatus, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

获取用户在线状态 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
urlIdWSstringqueryYes
userIdsstringqueryYes

响应

返回: GetUserPresenceStatusesResponse

示例

getUserPresenceStatuses 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlIdWS = "urlIdWS_example" // String |
7let userIds = "userIds_example" // String |
8
9PublicAPI.getUserPresenceStatuses(tenantId: tenantId, urlIdWS: urlIdWS, userIds: userIds) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

搜索用户 Internal Link

参数

名称类型位置必需描述
tenantIdstringpath是
urlIdstringquery是
usernameStartsWithstringquery否
mentionGroupIdsarrayquery否
ssostringquery否
searchSectionstringquery否

响应

返回:SearchUsersResult

示例

searchUsers 示例
Copy Copy
1
2// 以下代码示例仍处于 beta 阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let usernameStartsWith = "usernameStartsWith_example" // String | (optional)
8let mentionGroupIds = ["inner_example"] // [String] | (optional)
9let sso = "sso_example" // String | (optional)
10let searchSection = "searchSection_example" // String | (optional)
11
12PublicAPI.searchUsers(tenantId: tenantId, urlId: urlId, options: PublicAPI.SearchUsersOptions(usernameStartsWith: usernameStartsWith, mentionGroupIds: mentionGroupIds, sso: sso, searchSection: searchSection)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

获取用户 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是

响应

返回: GetUserResponse

示例

getUser 示例
Copy Copy
1
2// 以下示例代码仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getUser(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

创建投票 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
commentIdstringquery是
directionstringquery是
userIdstringquery否
anonUserIdstringquery否

响应

返回:VoteResponse

示例

createVote 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let direction = "direction_example" // String |
8let userId = "userId_example" // String | (可选)
9let anonUserId = "anonUserId_example" // String | (可选)
10
11DefaultAPI.createVote(tenantId: tenantId, commentId: commentId, direction: direction, options: DefaultAPI.CreateVoteOptions(userId: userId, anonUserId: anonUserId)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

删除投票 Internal Link

参数

名称类型位置必填描述
tenantIdstringquery是
idstringpath是
editKeystringquery否

响应

返回:VoteDeleteResponse

示例

deleteVote 示例
Copy Copy
1
2// 以下代码示例仍属测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let editKey = "editKey_example" // String | (可选)
8
9DefaultAPI.deleteVote(tenantId: tenantId, id: id, editKey: editKey) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

获取投票列表 Internal Link

参数

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
urlIdstringqueryYes

响应

返回: GetVotesResponse

示例

getVotes 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7
8DefaultAPI.getVotes(tenantId: tenantId, urlId: urlId) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

获取用户投票 Internal Link

参数

名称类型位置必填描述
tenantIdstringqueryYes
urlIdstringqueryYes
userIdstringqueryNo
anonUserIdstringqueryNo

响应

返回:GetVotesForUserResponse

示例

getVotesForUser 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let userId = "userId_example" // String | (optional)
8let anonUserId = "anonUserId_example" // String | (optional)
9
10DefaultAPI.getVotesForUser(tenantId: tenantId, urlId: urlId, options: DefaultAPI.GetVotesForUserOptions(userId: userId, anonUserId: anonUserId)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

需要帮助?

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

贡献

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