FastComments.com

FastComments Swift SDK


这是 FastComments 的官方 Swift SDK。

FastComments API 的官方 Swift SDK

仓库

在 GitHub 上查看


安装 Internal Link


Swift 包管理器

将以下内容添加到你的 Package.swift 文件:

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

或者在 Xcode 中:

  1. 选择 File > Add Packages...
  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)端点
    • 完整的 async/await 支持
    • 参见 client/README.md 以获取详细的 API 文档
  • SSO 模块 - 服务器端单点登录工具

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

快速开始 Internal Link


使用公共 API

import FastCommentsSwift

// 创建 API 客户端
let publicApi = PublicAPI()

// 获取页面的评论
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 密钥创建配置
let defaultApi = DefaultAPI()
defaultApi.apiKey = "your-api-key"

// 使用已认证的 API 获取评论
do {
    let response = try await defaultApi.getComments(
        tenantId: "your-tenant-id",
        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)")
}

使用 SSO 进行认证

安全 SSO(推荐用于生产环境)

import FastCommentsSwift

let apiKey = "your-api-key"

// 创建安全 SSO 用户数据(仅限服务器端!)
let userData = SecureSSOUserData(
    id: "user-123",              // 用户 ID
    email: "user@example.com",   // 电子邮件
    username: "johndoe",         // 用户名
    avatar: "https://example.com/avatar.jpg" // 头像 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

The FastComments SDK 提供两类 API 端点:

PublicAPI - 客户端安全端点

The PublicAPI contains endpoints that are safe to call from client-side code (iOS/macOS apps). These endpoints:

  • 不需要 API 密钥
  • 可以使用 SSO 令牌进行身份验证
  • 对每个用户/设备进行速率限制
  • 适用于面向终端用户的应用

Example use case: 在您的 iOS 应用中获取和创建评论

DefaultAPI - 服务器端端点

The DefaultAPI contains authenticated endpoints that require an API key. These endpoints:

  • 需要您的 FastComments API 密钥
  • 仅应从服务器端代码调用
  • 提供对您的 FastComments 数据的完全访问
  • 按租户限流

Example use case: 管理操作、批量数据导出、审核工具

IMPORTANT: 切勿在客户端代码中暴露您的 API 密钥。API 密钥只应在服务器端使用。

调用 API Internal Link

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

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

常见问题 Internal Link

401 Unauthorized Errors

If you're getting 401 errors when using the authenticated API:

  1. Check your API key: Ensure you're using the correct API key from your FastComments dashboard
  2. Verify the tenant ID: Make sure the tenant ID matches your account
  3. API key format: The API key should be set on the API client:
let defaultApi = DefaultAPI()
defaultApi.apiKey = "YOUR_API_KEY"
  1. Using the wrong API: Make sure you're using DefaultAPI (not PublicAPI) for authenticated calls

SSO Token Issues

If SSO tokens aren't working:

  1. Use secure mode for production: Always use FastCommentsSSO.createSecure() with your API key for production
  2. Server-side only: Generate secure SSO tokens on your server, never expose your API key to clients
  3. Check user data: Ensure all required fields (id, email, username) are provided
  4. Token expiration: Secure SSO tokens include a timestamp and may expire. Generate fresh tokens as needed.

SSL/TLS Errors

If you encounter SSL/TLS errors:

  1. Ensure your app's Info.plist allows HTTPS connections to fastcomments.com
  2. Check that you're not using App Transport Security exceptions that might block the connection

注意事项 Internal Link

广播 ID

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

let broadcastId = UUID().uuidString

聚合 Internal Link

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

参数

NameTypeLocationRequiredDescription
tenantIdstring查询
parentTenantIdstring查询
includeStatsboolean查询

响应

返回:AggregationResponse

示例

聚合 示例
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 | (可选)
8let includeStats = true // Bool | (可选)
9
10DefaultAPI.aggregate(tenantId: tenantId, aggregationRequest: aggregationRequest, 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

响应

返回:GetAuditLogs200Response

示例

getAuditLogs 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。若有任何问题,请通过 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, 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

参数

NameTypeLocationRequiredDescription
tenantIdstring查询
commentIdstring路径
ssostring查询

响应

返回: BlockFromCommentPublic200Response

示例

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

响应

返回: UnBlockCommentPublic200Response

示例

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

参数

名称类型位置必需描述
tenantIdstringquery
commentIdsstringquery以逗号分隔的评论 ID 列表。
ssostringquery

响应

返回: CheckedCommentsForBlocked200Response

示例

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

响应

返回: BlockFromCommentPublic200Response

示例

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, 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

参数

名称类型位置必需描述
tenantIdstringpath
urlIdstringquery
broadcastIdstringquery
sessionIdstringquery
ssostringquery

响应

返回: CreateCommentPublic200Response

示例

createCommentPublic 示例
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 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) // CommentData |
9let sessionId = "sessionId_example" // String | (可选)
10let sso = "sso_example" // String | (可选)
11
12PublicAPI.createCommentPublic(tenantId: tenantId, urlId: urlId, broadcastId: broadcastId, commentData: commentData, 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

参数

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
contextUserIdstringqueryNo
isLivebooleanqueryNo

响应

返回: DeleteComment200Response

示例

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 | (optional)
8let isLive = true // Bool | (optional)
9
10DefaultAPI.deleteComment(tenantId: tenantId, id: id, 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

响应

返回:DeleteCommentPublic200Response

示例

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, 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

参数

名称类型位置必需描述
tenantIdstringpath
commentIdstringpath
voteIdstringpath
urlIdstringquery
broadcastIdstringquery
editKeystringquery
ssostringquery

响应

返回: DeleteCommentVote200Response

示例

deleteCommentVote 示例
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 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, 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

响应

返回:FlagComment200Response

示例

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, 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

响应

返回:GetComment200Response

示例

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

响应

返回: GetComments200Response

示例

getComments 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 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 | (可选)
20
21DefaultAPI.getComments(tenantId: tenantId, 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) { (response, error) in
22 guard error == nil else {
23 print(error)
24 return
25 }
26
27 if (response) {
28 dump(response)
29 }
30}
31

公开获取评论 Internal Link

req tenantId urlId

参数

NameTypeLocationRequiredDescription
tenantIdstringpath
urlIdstringquery
pageintegerquery
directionstringquery
ssostringquery
skipintegerquery
skipChildrenintegerquery
limitintegerquery
limitChildrenintegerquery
countChildrenbooleanquery
fetchPageForCommentIdstringquery
includeConfigbooleanquery
countAllbooleanquery
includei10nbooleanquery
localestringquery
modulesstringquery
isCrawlerbooleanquery
includeNotificationCountbooleanquery
asTreebooleanquery
maxTreeDepthintegerquery
useFullTranslationIdsbooleanquery
parentIdstringquery
searchTextstringquery
hashTagsarrayquery
userIdstringquery
customConfigStrstringquery
afterCommentIdstringquery
beforeCommentIdstringquery

响应

返回: GetCommentsPublic200Response

示例

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 | (可选)
8let direction = SortDirections() // SortDirections | (可选)
9let sso = "sso_example" // String | (可选)
10let skip = 987 // Int | (可选)
11let skipChildren = 987 // Int | (可选)
12let limit = 987 // Int | (可选)
13let limitChildren = 987 // Int | (可选)
14let countChildren = true // Bool | (可选)
15let fetchPageForCommentId = "fetchPageForCommentId_example" // String | (可选)
16let includeConfig = true // Bool | (可选)
17let countAll = true // Bool | (可选)
18let includei10n = true // Bool | (可选)
19let locale = "locale_example" // String | (可选)
20let modules = "modules_example" // String | (可选)
21let isCrawler = true // Bool | (可选)
22let includeNotificationCount = true // Bool | (可选)
23let asTree = true // Bool | (可选)
24let maxTreeDepth = 987 // Int | (可选)
25let useFullTranslationIds = true // Bool | (可选)
26let parentId = "parentId_example" // String | (可选)
27let searchText = "searchText_example" // String | (可选)
28let hashTags = ["inner_example"] // [String] | (可选)
29let userId = "userId_example" // String | (可选)
30let customConfigStr = "customConfigStr_example" // String | (可选)
31let afterCommentId = "afterCommentId_example" // String | (可选)
32let beforeCommentId = "beforeCommentId_example" // String | (可选)
33
34PublicAPI.getCommentsPublic(tenantId: tenantId, urlId: urlId, 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

响应

返回: GetCommentText200Response

示例

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 | (可选)
8let sso = "sso_example" // String | (可选)
9
10PublicAPI.getCommentText(tenantId: tenantId, commentId: commentId, 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

响应

返回: GetCommentVoteUserNames200Response

示例

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

参数

NameTypeLocationRequiredDescription
tenantIdstringpath
commentIdstringpath
broadcastIdstringquery
ssostringquery

响应

返回: LockComment200Response

示例

lockComment 示例
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.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

参数

NameTypeLocationRequiredDescription
tenantIdstring路径
commentIdstring路径
broadcastIdstring查询
ssostring查询

响应

返回: PinComment200Response

示例

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

参数

名称类型位置必需描述
tenantIdstringquery
isLivebooleanquery
doSpamCheckbooleanquery
sendEmailsbooleanquery
populateNotificationsbooleanquery

响应

返回:SaveComment200Response

示例

saveComment 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如遇任何问题,请通过 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, 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 | (可选)
8let doSpamCheck = true // Bool | (可选)
9let sendEmails = true // Bool | (可选)
10let populateNotifications = true // Bool | (可选)
11
12DefaultAPI.saveComment(tenantId: tenantId, createCommentParams: createCommentParams, 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

响应

返回: [SaveComment200Response]

示例

saveCommentsBulk 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如遇任何问题,请通过 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, 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 | (可选)
8let doSpamCheck = true // Bool | (可选)
9let sendEmails = true // Bool | (可选)
10let populateNotifications = true // Bool | (可选)
11
12DefaultAPI.saveCommentsBulk(tenantId: tenantId, createCommentParams: createCommentParams, 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

参数

NameTypeLocationRequiredDescription
tenantIdstringpath
commentIdstringpath
broadcastIdstringquery
editKeystringquery
ssostringquery

响应

返回: SetCommentText200Response

示例

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, 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

参数

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
userIdstringquery
anonUserIdstringquery

响应

返回:UnBlockCommentPublic200Response

示例

unBlockUserFromComment 示例
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 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, 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

参数

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
userIdstringquery
anonUserIdstringquery

响应

返回: FlagComment200Response

示例

unFlagComment 示例
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.unFlagComment(tenantId: tenantId, id: id, 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

响应

返回:LockComment200Response

示例

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

参数

NameTypeLocationRequiredDescription
tenantIdstringpath
commentIdstringpath
broadcastIdstringquery
ssostringquery

响应

返回: PinComment200Response

示例

unPinComment 示例
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.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

参数

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
contextUserIdstringquery
doSpamCheckbooleanquery
isLivebooleanquery

响应

返回: FlagCommentPublic200Response

示例

updateComment 示例
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 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 | (可选)
9let doSpamCheck = true // Bool | (可选)
10let isLive = true // Bool | (可选)
11
12DefaultAPI.updateComment(tenantId: tenantId, id: id, updatableCommentParams: updatableCommentParams, 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

参数

NameTypeLocationRequiredDescription
tenantIdstringpath
commentIdstringpath
urlIdstringquery
broadcastIdstringquery
sessionIdstringquery
ssostringquery

响应

返回: VoteComment200Response

示例

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, 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

参数

NameTypeLocationRequiredDescription
tenantIdstringquery

响应

返回:AddDomainConfig200Response

示例

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

参数

名称类型位置必需描述
tenantIdstring查询
domainstring路径

响应

返回: DeleteDomainConfig200Response

示例

deleteDomainConfig 示例
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.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

响应

返回: GetDomainConfig200Response

示例

getDomainConfig 示例
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.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

响应

返回值: GetDomainConfigs200Response

示例

getDomainConfigs 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // 字符串 |
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
tenantIdstring查询
domainToUpdatestring路径

响应

返回: GetDomainConfig200Response

示例

patchDomainConfig 示例
Copy Copy
1
2// 以下代码示例仍处于 beta。若有任何问题,请通过 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

参数

NameTypeLocationRequiredDescription
tenantIdstringquery
domainToUpdatestringpath

响应

返回:GetDomainConfig200Response

示例

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

参数

名称类型位置必需描述
tenantIdstringquery

响应

返回: CreateEmailTemplate200Response

示例

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

响应

返回: FlagCommentPublic200Response

示例

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

响应

返回: FlagCommentPublic200Response

示例

deleteEmailTemplateRenderError 示例
Copy Copy
1
2// 以下代码示例仍为测试版。如果有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // 字符串 |
6let id = "id_example" // 字符串 |
7let errorId = "errorId_example" // 字符串 |
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

参数

NameTypeLocationRequiredDescription
tenantIdstring查询
idstring路径

响应

返回: GetEmailTemplate200Response

示例

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

响应

返回: GetEmailTemplateDefinitions200Response

示例

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

参数

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

响应

返回: GetEmailTemplateRenderErrors200Response

示例

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

响应

返回:GetEmailTemplates200Response

示例

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

响应

返回: RenderEmailTemplate200Response

示例

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

响应

返回: FlagCommentPublic200Response

示例

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

参数

名称类型位置必需描述
tenantIdstringpath
urlIdstringquery
userIdWSstringquery
startTimeintegerquery
endTimeintegerquery

响应

返回: GetEventLog200Response

示例

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

参数

名称类型位置必填描述
tenantIdstringpath
urlIdstringquery
userIdWSstringquery
startTimeintegerquery
endTimeintegerquery

响应

返回: GetEventLog200Response

示例

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

参数

NameTypeLocationRequiredDescription
tenantIdstringquery
broadcastIdstringquery
isLivebooleanquery
doSpamCheckbooleanquery
skipDupCheckbooleanquery

响应

返回: CreateFeedPost200Response

示例

createFeedPost 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 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, 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

响应

返回: CreateFeedPostPublic200Response

示例

createFeedPostPublic 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如遇任何问题,请通过 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, 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
tenantIdstringpath
postIdstringpath
broadcastIdstringquery
ssostringquery

响应

返回: DeleteFeedPostPublic200Response

示例

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, 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

req tenantId afterId

参数

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
afterIdstringqueryNo
limitintegerqueryNo
tagsarrayqueryNo

响应

返回: GetFeedPosts200Response

示例

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, 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

请求 tenantId afterId

参数

NameTypeLocationRequiredDescription
tenantIdstringpath
afterIdstringquery
limitintegerquery
tagsarrayquery
ssostringquery
isCrawlerbooleanquery
includeUserInfobooleanquery

响应

返回: GetFeedPostsPublic200Response

示例

getFeedPostsPublic 示例
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] | (可选)
9let sso = "sso_example" // String | (可选)
10let isCrawler = true // Bool | (可选)
11let includeUserInfo = true // Bool | (可选)
12
13PublicAPI.getFeedPostsPublic(tenantId: tenantId, 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

参数

名称类型位置必需描述
tenantIdstringpath
postIdsarrayquery
ssostringquery

响应

返回: GetFeedPostsStats200Response

示例

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

参数

名称类型位置必需描述
tenantIdstringpath
postIdsarrayquery
ssostringquery

响应

返回: GetUserReactsPublic200Response

示例

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, 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

参数

名称TypeLocation必需描述
tenantIdstringpath
postIdstringpath
isUndobooleanquery
broadcastIdstringquery
ssostringquery

响应

返回: ReactFeedPostPublic200Response

示例

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 | (可选)
9let broadcastId = "broadcastId_example" // String | (可选)
10let sso = "sso_example" // String | (可选)
11
12PublicAPI.reactFeedPostPublic(tenantId: tenantId, postId: postId, reactBodyParams: reactBodyParams, 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

参数

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

响应

返回: FlagCommentPublic200Response

示例

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

响应

返回: CreateFeedPostPublic200Response

示例

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 | (可选)
9let sso = "sso_example" // String | (可选)
10
11PublicAPI.updateFeedPostPublic(tenantId: tenantId, postId: postId, updateFeedPostParams: updateFeedPostParams, 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

参数

NameTypeLocationRequiredDescription
tenantIdstringquery
commentIdstringpath
isFlaggedbooleanquery
ssostringquery

响应

返回: FlagCommentPublic200Response

示例

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

添加话题标签 Internal Link

参数

名称类型位置必需描述
tenantIdstringquery

响应

返回:AddHashTag200Response

示例

addHashTag 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如遇任何问题,请通过 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

响应

返回: AddHashTagsBulk200Response

示例

addHashTagsBulk 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 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 | (可选)
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

参数

名称类型位置必需描述
tagstring路径
tenantIdstring查询

响应

返回: FlagCommentPublic200Response

示例

deleteHashTag 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tag = "tag_example" // String |
6let tenantId = "tenantId_example" // String | (可选)
7let deleteHashTagRequest = DeleteHashTag_request(tenantId: "tenantId_example") // DeleteHashTagRequest | (可选)
8
9DefaultAPI.deleteHashTag(tag: tag, tenantId: tenantId, deleteHashTagRequest: deleteHashTagRequest) { (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

响应

返回: GetHashTags200Response

示例

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

参数

NameTypeLocationRequiredDescription
tagstring路径
tenantIdstring查询

响应

返回: PatchHashTag200Response

示例

patchHashTag 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tag = "tag_example" // String |
6let tenantId = "tenantId_example" // String | (可选)
7let updateHashTagBody = UpdateHashTagBody(tenantId: "tenantId_example", url: "url_example", tag: "tag_example") // UpdateHashTagBody | (可选)
8
9DefaultAPI.patchHashTag(tag: tag, tenantId: tenantId, 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

响应

返回:CreateModerator200Response

示例

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

参数

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

响应

返回:FlagCommentPublic200Response

示例

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 | (optional)
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


参数

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

响应

返回: GetModerator200Response

示例

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

参数

NameTypeLocationRequiredDescription
tenantIdstringquery
skipnumberquery

响应

返回: GetModerators200Response

示例

getModerators 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // 字符串 |
6let skip = 987 // 数字 | (可选)
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


参数

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

响应

返回: FlagCommentPublic200Response

示例

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

响应

返回: FlagCommentPublic200Response

示例

updateModerator 示例
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 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

参数

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

响应

返回: FlagCommentPublic200Response

示例

deleteNotificationCount 示例
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.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

参数

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

响应

返回: GetCachedNotificationCount200Response

示例

getCachedNotificationCount 示例
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.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

参数

NameTypeLocationRequiredDescription
tenantIdstringquery
userIdstringquery
urlIdstringquery
fromCommentIdstringquery
viewedbooleanquery
typestringquery

响应

返回: GetNotificationCount200Response

示例

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, 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

参数

NameTypeLocationRequiredDescription
tenantIdstringquery
userIdstringquery
urlIdstringquery
fromCommentIdstringquery
viewedbooleanquery
typestringquery
skipnumberquery

响应

返回: GetNotifications200Response

示例

getNotifications 示例
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 | (可选)
11let skip = 987 // Double | (可选)
12
13DefaultAPI.getNotifications(tenantId: tenantId, 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

响应

返回: FlagCommentPublic200Response

示例

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

添加页面 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

按 URLId 获取页面 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

参数

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

响应

返回: FlagCommentPublic200Response

示例

deletePendingWebhookEvent 示例
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.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

参数

名称类型位置必需描述
tenantIdstringquery
commentIdstringquery
externalIdstringquery
eventTypestringquery
typestringquery
domainstringquery
attemptCountGTnumberquery

响应

返回: GetPendingWebhookEventCount200Response

示例

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, 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

参数

名称类型位置必需描述
tenantIdstring查询
commentIdstring查询
externalIdstring查询
eventTypestring查询
typestring查询
domainstring查询
attemptCountGTnumber查询
skipnumber查询

响应

返回: GetPendingWebhookEvents200Response

示例

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, 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

响应

返回: CreateQuestionConfig200Response

示例

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

参数

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

Response

返回: FlagCommentPublic200Response

示例

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

参数

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

响应

返回: GetQuestionConfig200Response

示例

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

参数

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

响应

返回: GetQuestionConfigs200Response

示例

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

参数

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

响应

返回: FlagCommentPublic200Response

示例

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

参数

名称类型位置必需描述
tenantIdstringqueryYes

响应

返回:CreateQuestionResult200Response

示例

createQuestionResult 示例
Copy Copy
1
2// 以下示例代码仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // 字符串 |
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

参数

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

响应

返回:FlagCommentPublic200Response

示例

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

响应

返回: GetQuestionResult200Response

示例

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

参数

NameTypeLocationRequiredDescription
tenantIdstring查询
urlIdstring查询
userIdstring查询
startDatestring查询
questionIdstring查询
questionIdsstring查询
skipnumber查询

响应

返回: GetQuestionResults200Response

示例

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, 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

响应

返回: FlagCommentPublic200Response

示例

updateQuestionResult 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。若发现任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // 字符串 |
6let id = "id_example" // 字符串 |
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

参数

NameTypeLocationRequiredDescription
tenantIdstringquery
questionIdstringquery
questionIdsarrayquery
urlIdstringquery
timeBucketstringquery
startDatestringquery
forceRecalculatebooleanquery

Response

返回: AggregateQuestionResults200Response

示例

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 | (可选)
7let questionIds = ["inner_example"] // [String] | (可选)
8let urlId = "urlId_example" // String | (可选)
9let timeBucket = AggregateTimeBucket() // AggregateTimeBucket | (可选)
10let startDate = Date() // Date | (可选)
11let forceRecalculate = true // Bool | (可选)
12
13DefaultAPI.aggregateQuestionResults(tenantId: tenantId, 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

响应

返回: BulkAggregateQuestionResults200Response

示例

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

响应

返回: CombineCommentsWithQuestionResults200Response

示例

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, 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

参数

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

响应

返回: DeleteSSOUserAPIResponse

示例

deleteSSOUser 示例
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 = true // Bool | (可选)
8let commentDeleteMode = "commentDeleteMode_example" // String | (可选)
9
10DefaultAPI.deleteSSOUser(tenantId: tenantId, id: id, 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

响应

返回:GetSSOUsers200Response

示例

getSSOUsers 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let skip = 987 // Int | (可选)
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

参数

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
yearNumbernumberqueryNo
monthNumbernumberqueryNo
dayNumbernumberqueryNo
skipnumberqueryNo

响应

返回:GetTenantDailyUsages200Response

示例

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, 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

参数

NameTypeLocationRequiredDescription
tenantIdstringquery

响应

返回: CreateTenantPackage200Response

示例

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

响应

返回: FlagCommentPublic200Response

示例

deleteTenantPackage 示例
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 |
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

响应

返回: GetTenantPackage200Response

示例

getTenantPackage 示例
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.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

响应

返回:GetTenantPackages200Response

示例

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

参数

名称类型位置必需描述
tenantIdstring查询
idstring路径

响应

返回: FlagCommentPublic200Response

示例

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

参数

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

响应

返回: FlagCommentPublic200Response

示例

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

响应

返回: CreateTenantUser200Response

示例

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

参数

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
deleteCommentsstringquery
commentDeleteModestringquery

响应

返回: FlagCommentPublic200Response

示例

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 | (可选)
8let commentDeleteMode = "commentDeleteMode_example" // String | (可选)
9
10DefaultAPI.deleteTenantUser(tenantId: tenantId, id: id, 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

参数

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

响应

返回: GetTenantUser200Response

示例

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

参数

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

响应

返回: GetTenantUsers200Response

示例

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

响应

返回: FlagCommentPublic200Response

示例

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

参数

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

响应

返回: FlagCommentPublic200Response

示例

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

参数

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

响应

返回: FlagCommentPublic200Response

示例

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

响应

返回: CreateTenant200Response

示例

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

响应

返回: FlagCommentPublic200Response

示例

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
tenantIdstring查询
idstring路径

响应

返回:GetTenant200Response

示例

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

响应

返回: GetTenants200Response

示例

getTenants 示例
Copy Copy
1
2// 以下代码示例仍处于测试阶段。若有任何问题,请通过 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, 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

参数

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

响应

返回: FlagCommentPublic200Response

示例

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

参数

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

响应

返回: ChangeTicketState200Response

示例

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

参数

NameTypeLocationRequiredDescription
tenantIdstringquery
userIdstringquery

响应

返回: CreateTicket200Response

示例

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

参数

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

响应

返回: GetTicket200Response

示例

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

响应

返回: GetTickets200Response

示例

getTickets 示例
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 state = 987 // Double | (可选)
8let skip = 987 // Double | (可选)
9let limit = 987 // Double | (可选)
10
11DefaultAPI.getTickets(tenantId: tenantId, 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

上传并调整图像大小

参数

NameTypeLocationRequiredDescription
tenantIdstringpath
sizePresetstringquery尺寸预设: "Default" (1000x1000px) 或 "CrossPlatform" (为常见设备创建尺寸)
urlIdstringquery上传发生的页面 id,用于配置

响应

返回: UploadImageResponse

示例

uploadImage 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有任何问题,请通过 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, 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

响应

返回: GetUserBadgeProgressById200Response

示例

getUserBadgeProgressById 示例
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.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

响应

返回: GetUserBadgeProgressById200Response

示例

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

参数

NameTypeLocationRequiredDescription
tenantIdstringquery
userIdstringquery
limitnumberquery
skipnumberquery

响应

返回: GetUserBadgeProgressList200Response

示例

getUserBadgeProgressList 示例
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 limit = 987 // Double | (可选)
8let skip = 987 // Double | (可选)
9
10DefaultAPI.getUserBadgeProgressList(tenantId: tenantId, 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

参数

名称类型位置必需描述
tenantIdstringqueryYes

响应

返回: CreateUserBadge200Response

示例

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

响应

返回: UpdateUserBadge200Response

示例

deleteUserBadge 示例
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.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

响应

返回:GetUserBadge200Response

示例

getUserBadge 示例
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.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

参数

名称类型位置必填描述
tenantIdstringquery
userIdstringquery
badgeIdstringquery
typenumberquery
displayedOnCommentsbooleanquery
limitnumberquery
skipnumberquery

响应

返回: GetUserBadges200Response

示例

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, 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


参数

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

响应

返回: UpdateUserBadge200Response

示例

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

参数

NameTypeLocationRequiredDescription
tenantIdstringquery
ssostringquery

响应

返回: GetUserNotificationCount200Response

示例

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
pageSizeintegerquery
afterIdstringquery
includeContextbooleanquery
afterCreatedAtintegerquery
unreadOnlybooleanquery
dmOnlybooleanquery
noDmbooleanquery
includeTranslationsbooleanquery
ssostringquery

响应

返回: GetUserNotifications200Response

示例

getUserNotifications 示例
Copy Copy
1
2// 以下代码示例仍处于测试版。如有任何问题,请通过 http://github.com/OpenAPITools/openapi-generator/issues/new 报告
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let pageSize = 987 // Int | (可选)
7let afterId = "afterId_example" // String | (可选)
8let includeContext = true // Bool | (可选)
9let afterCreatedAt = 987 // Int64 | (可选)
10let unreadOnly = true // Bool | (可选)
11let dmOnly = true // Bool | (可选)
12let noDm = true // Bool | (可选)
13let includeTranslations = true // Bool | (可选)
14let sso = "sso_example" // String | (可选)
15
16PublicAPI.getUserNotifications(tenantId: tenantId, pageSize: pageSize, afterId: afterId, includeContext: includeContext, afterCreatedAt: afterCreatedAt, unreadOnly: unreadOnly, dmOnly: dmOnly, noDm: noDm, includeTranslations: includeTranslations, 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

重置用户通知计数 Internal Link

参数

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

响应

返回: ResetUserNotifications200Response

示例

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

参数

名称类型位置必填描述
tenantIdstringquery
afterIdstringquery
afterCreatedAtintegerquery
unreadOnlybooleanquery
dmOnlybooleanquery
noDmbooleanquery
ssostringquery

Response

返回: ResetUserNotifications200Response

示例

resetUserNotifications 示例
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 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, 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

为特定评论启用或禁用通知。

参数

名称类型位置必需描述
tenantIdstringquery
notificationIdstringpath
optedInOrOutstringpath
commentIdstringquery
ssostringquery

响应

返回:UpdateUserNotificationStatus200Response

示例

updateUserNotificationCommentSubscriptionStatus 示例
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 optedInOrOut = "optedInOrOut_example" // String |
8let commentId = "commentId_example" // String |
9let sso = "sso_example" // String | (可选)
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

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

参数

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
urlIdstringqueryYes
urlstringqueryYes
pageTitlestringqueryYes
subscribedOrUnsubscribedstringpathYes
ssostringqueryNo

响应

返回: UpdateUserNotificationStatus200Response

示例

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 | (可选)
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

参数

NameTypeLocationRequiredDescription
tenantIdstringquery
notificationIdstringpath
newStatusstringpath
ssostringquery

响应

返回:UpdateUserNotificationStatus200Response

示例

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
tenantIdstringquery
urlIdWSstringquery
userIdsstringquery

响应

返回:GetUserPresenceStatuses200Response

示例

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

响应

返回:SearchUsers200Response

示例

searchUsers 示例
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 usernameStartsWith = "usernameStartsWith_example" // String | (可选)
8let mentionGroupIds = ["inner_example"] // [String] | (可选)
9let sso = "sso_example" // String | (可选)
10let searchSection = "searchSection_example" // String | (可选)
11
12PublicAPI.searchUsers(tenantId: tenantId, urlId: urlId, 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
tenantIdstringqueryYes
idstringpathYes

响应

返回: GetUser200Response

示例

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

参数

NameTypeLocationRequiredDescription
tenantIdstringquery
commentIdstringquery
directionstringquery
userIdstringquery
anonUserIdstringquery

响应

返回: VoteComment200Response

示例

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, 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

响应

返回: DeleteCommentVote200Response

示例

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

参数

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

响应

返回: GetVotes200Response

示例

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

参数

名称类型位置必需描述
tenantIdstringquery
urlIdstringquery
userIdstringquery
anonUserIdstringquery

响应

返回:GetVotesForUser200Response

示例

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 | (可选)
8let anonUserId = "anonUserId_example" // String | (可选)
9
10DefaultAPI.getVotesForUser(tenantId: tenantId, urlId: urlId, 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 仓库 以查看贡献指南。