FastComments.com

FastComments Swift SDK

這是 FastComments 的官方 Swift SDK。

FastComments API 的官方 Swift SDK

儲存庫

在 GitHub 上檢視

AI 程式碼代理 Internal Link

skills.sh

為您的程式編寫代理提供 FastComments 所需的上下文——小工具、設定、Secure SSO、REST API 與 SDK:

npx skills add fastcomments/skills

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

安裝 Internal Link

Swift Package Manager

將以下內容加入您的 Package.swift 檔案:

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

或在 Xcode 中:

  1. File > Add Packages...
  2. 輸入儲存庫網址: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 包含數個模組:

  • Client Module - 用於 FastComments REST APIs 的 API 用戶端

    • 提供所有 API 模型的完整型別定義
    • 已驗證 (DefaultAPI)、公開 (PublicAPI)、以及審核 (ModerationAPI) 方法
    • 完整的 async/await 支援
    • 詳細的 API 文件請參見 client/README.md
  • SSO Module - 伺服器端的 Single Sign-On 實用工具

    • 用於使用者驗證的安全 token 產生
    • 支援簡易與安全兩種 SSO 模式
    • 使用 CryptoKit 的基於 HMAC-SHA256 的 token 簽名

快速入門 Internal Link

使用公開 API

import FastCommentsSwift

// 取得頁面的評論
do {
    let response = try await PublicAPI.getCommentsPublic(
        tenantId: "your-tenant-id",
        urlId: "page-url-id"
    )

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

使用已驗證 API

import FastCommentsSwift

// 在共享設定中配置您的 API 金鑰(作為 x-api-key 標頭傳送)
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "your-api-key"

// 使用已驗證的 API 取得評論
do {
    let response = try await DefaultAPI.getComments(
        tenantId: "your-tenant-id",
        options: .init(urlId: "page-url-id")
    )

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

使用審核 API

import FastCommentsSwift

// 審核方法需要使用 `sso` 令牌授權給執行的審核者
// (使用 FastCommentsSSO 產生,請參閱上面的 SSO 章節。)
do {
    let response = try await ModerationAPI.getApiComments(
        options: .init(
            page: 0,
            count: 30,
            sso: ssoToken
        )
    )

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

使用 SSO 進行驗證

安全 SSO(建議於正式環境使用)

import FastCommentsSwift

let apiKey = "your-api-key"

// 建立安全 SSO 使用者資料(僅限伺服器端!)
let userData = SecureSSOUserData(
    id: "user-123",              // 使用者 ID
    email: "user@example.com",   // 電子郵件
    username: "johndoe",         // 使用者名稱
    avatar: "https://example.com/avatar.jpg" // 大頭貼 URL
)

// Generate SSO token
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"
)

// Generate simple SSO token
let sso = FastCommentsSSO.createSimple(simpleSSOUserData: userData)
do {
    let token = try sso.createToken()
    print("Simple SSO Token: \(token ?? "")")
} catch {
    print("Error creating SSO token: \(error)")
}

API 客戶端 Internal Link

FastComments SDK 提供三種 API 用戶端:

PublicAPI - 用戶端安全的方法

PublicAPI 包含可安全從用戶端程式碼(iOS/macOS 應用程式)呼叫的方法。這些方法:

  • 不需要 API 金鑰
  • 可使用 SSO 權杖進行驗證
  • 依使用者/裝置進行速率限制
  • 適合面向終端使用者的應用程式

範例使用情境:在您的 iOS 應用程式中取得與建立留言

DefaultAPI - 伺服器端方法

DefaultAPI 包含需要 API 金鑰的已驗證方法。這些方法:

  • 需要您的 FastComments API 金鑰
  • 只應從伺服器端程式碼呼叫
  • 提供對您 FastComments 資料的完整存取權限
  • 依租戶進行速率限制

範例使用情境:管理操作、大量資料匯出、使用者管理

ModerationAPI - 審核儀表板方法

ModerationAPI 提供一套廣泛的即時且快速的審核 API。每個 ModerationAPI 方法都接受 sso 參數,並可透過 SSO 或 FastComments.com 的 session cookie 進行驗證。

範例使用情境:為您社群的審核員建立審核體驗

重要事項:切勿在用戶端程式碼中公開您的 API 金鑰。API 金鑰應僅在伺服器端使用。

發送 API 請求 Internal Link

Swift SDK 使用現代的 async/await 語法來呼叫所有 API:

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

常見問題 Internal Link

401 未授權錯誤

如果在使用已驗證的 API 時收到 401 錯誤:

  1. 檢查您的 API 金鑰:確保您使用的是 FastComments 儀表板中正確的 API 金鑰
  2. 驗證租戶 ID:確保租戶 ID 與您的帳戶相符
  3. API 金鑰格式:API 金鑰應在共享設定中以 x-api-key 標頭設定:
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "YOUR_API_KEY"
  1. 使用錯誤的 API:確保在已驗證的呼叫中使用 DefaultAPI(而非 PublicAPI)

SSO 令牌問題

如果 SSO 令牌無法運作:

  1. 在生產環境使用安全模式:在生產環境中,始終使用帶有您的 API 金鑰的 FastCommentsSSO.createSecure()
  2. 僅限伺服器端:在您的伺服器上產生安全的 SSO 令牌,切勿將 API 金鑰暴露給客戶端
  3. 檢查使用者資料:確保提供所有必要欄位(id、email、username)
  4. 令牌過期:安全的 SSO 令牌包含時間戳記,可能會過期。請根據需要產生新的令牌。

SSL/TLS 錯誤

如果您遇到 SSL/TLS 錯誤:

  1. 確保應用程式的 Info.plist 允許連接至 fastcomments.com 的 HTTPS 連線
  2. 檢查您是否未使用可能阻擋連線的 App Transport Security 例外設定

備註 Internal Link

廣播 ID

在某些 API 呼叫中,你會看到需要傳遞 broadcastId。當你接收到事件時,會回傳這個 ID,因此如果你打算在用戶端採取樂觀更新(你可能會想這麼做,因為這能提供最佳體驗),你就可以藉此知道要忽略該事件。請在此處傳遞一個 UUID。該 ID 應足夠唯一,以避免在一次會話中出現重複。

let broadcastId = UUID().uuidString

createAgentTenant Internal Link

為 AI 代理建立新的試用帳戶,無需人工註冊。呼叫此 API 不需要 API 金鑰。

回應包含租戶 ID、可立即用於 REST API 與 MCP 伺服器的 API 金鑰,以及一個認領 URL。請將認領 URL 提供給您所服務的人員:在登入 FastComments 的狀態下開啟該連結,即可將帳戶綁定至該使用者。未認領的帳戶及其金鑰將在建立後 72 小時刪除。在認領之前,該帳戶受標準試用限制約束。

回應

回傳:CreateAgentTenantResponse

範例

createAgentTenant 範例
Copy Copy
1
2// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
3import FastCommentsSwift
4
5let createAgentTenantBody = CreateAgentTenantBody(name: "name_example", domains: ["domains_example"], agent: "agent_example") // CreateAgentTenantBody |
6
7DefaultAPI.createAgentTenant(createAgentTenantBody: createAgentTenantBody) { (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

Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.

參數

名稱類型位置必填說明
tenantIdstringquery是
parentTenantIdstringquery否
includeStatsbooleanquery否

回應

返回: AggregateResponse

範例

聚合 範例
Copy Copy
1
2// 以下程式碼範例仍屬 beta 版。如有任何問題,請透過 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, options: DefaultAPI.AggregateOptions(parentTenantId: parentTenantId, includeStats: includeStats)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getAuditLogs Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是要讀取稽核日誌的租戶。
limitintegerquery否要返回的日誌數量。最大 10000,預設為 1000。
skipintegerquery否要跳過的日誌數量,用於分頁。
orderstringquery否事件時間的排序方向。預設為 DESC(最新的在前)。
afterintegerquery否
beforeintegerquery否
usernamestringquery否僅返回此使用者名稱執行的事件。
ipstringquery否僅返回來自此 IP 位址的事件。
crudTypestringquery否僅返回此類型的事件:c、r、u、d,或 login。
resourceNamestringquery否僅返回此資源的事件,例如 User 或 Moderator。
targetIdstringquery否僅返回受影響物件具有此 ID 的事件。
targetstringquery否對受影響物件的標籤進行不區分大小寫的子字串匹配,例如使用者名稱或電子郵件。
includeManagedTenantsbooleanquery否同時返回此租戶所管理的租戶的事件。

回應

返回:GetAuditLogsResponse

範例

getAuditLogs 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String | 要讀取稽核日誌的租戶。
6let limit = 987 // Int | 要返回的日誌數量。最大 10000,預設為 1000。(可選)
7let skip = 987 // Int | 要跳過的日誌數量,用於分頁。(可選)
8let order = SORT_DIR() // SORTDIR | 事件時間的排序方向。預設為 DESC(最新的在前)。(可選)
9let after = 987 // Int64 | (可選)
10let before = 987 // Int64 | (可選)
11let username = "username_example" // String | 僅返回此使用者名稱執行的事件。(可選)
12let ip = "ip_example" // String | 僅返回來自此 IP 位址的事件。(可選)
13let crudType = "crudType_example" // String | 僅返回此類型的事件:c、r、u、d,或 login。(可選)
14let resourceName = "resourceName_example" // String | 僅返回此資源的事件,例如 User 或 Moderator。(可選)
15let targetId = "targetId_example" // String | 僅返回受影響物件具有此 ID 的事件。(可選)
16let target = "target_example" // String | 對受影響物件的標籤進行不區分大小寫的子字串匹配,例如使用者名稱或電子郵件。(可選)
17let includeManagedTenants = true // Bool | 同時返回此租戶所管理的租戶的事件。(可選)
18
19DefaultAPI.getAuditLogs(tenantId: tenantId, options: DefaultAPI.GetAuditLogsOptions(limit: limit, skip: skip, order: order, after: after, before: before, username: username, ip: ip, crudType: crudType, resourceName: resourceName, targetId: targetId, target: target, includeManagedTenants: includeManagedTenants)) { (response, error) in
20 guard error == nil else {
21 print(error)
22 return
23 }
24
25 if (response) {
26 dump(response)
27 }
28}
29

logoutPublic Internal Link

回應

回傳: APIEmptyResponse

範例

logoutPublic 範例
Copy Copy
1
2// 下列程式範例仍屬測試版。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5
6PublicAPI.logoutPublic() { (response, error) in
7 guard error == nil else {
8 print(error)
9 return
10 }
11
12 if (response) {
13 dump(response)
14 }
15}
16

getBatchJob Internal Link

狀態、進度以及完成後的批次作業結果。

參數

名稱類型位置必填說明
tenantIdstringqueryYes
idstringpathYes

回應

返回:GetBatchJobAPIResponse

範例

getBatchJob 範例
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.getBatchJob(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

getBatchJobs Internal Link

租戶的批次工作(匯入、匯出、頁面遷移...),依最新排序。

參數

名稱類型位置必填說明
tenantIdstringquery是
typestringquery否僅此類型的工作,例如 migrate-pages。
statusstringquery否僅此狀態的工作:requested、running、success 或 failed。
skipintegerquery否要跳過多少工作,用於分頁。

回應

返回:GetBatchJobsAPIResponse

範例

取得批次工作 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let type = "type_example" // String | 僅此類型的工作,例如 migrate-pages。(可選)
7let status = "status_example" // String | 僅此狀態的工作:requested、running、success 或 failed。(可選)
8let skip = 987 // Int | 要跳過多少工作,用於分頁。(可選)
9
10DefaultAPI.getBatchJobs(tenantId: tenantId, options: DefaultAPI.GetBatchJobsOptions(type: type, status: status, 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

blockFromCommentPublic Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

回應

回傳: BlockSuccess

範例

blockFromCommentPublic 範例
Copy Copy
1
2// 下列程式範例仍處於測試版。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let publicBlockFromCommentParams = PublicBlockFromCommentParams(commentIds: ["commentIds_example"]) // PublicBlockFromCommentParams |
8let sso = "sso_example" // String | (可選)
9
10PublicAPI.blockFromCommentPublic(tenantId: tenantId, commentId: commentId, publicBlockFromCommentParams: publicBlockFromCommentParams, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

unBlockCommentPublic Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
commentIdstringpath是
ssostringquery否

回應

回傳: UnblockSuccess

範例

unBlockCommentPublic 範例
Copy Copy
1
2// 下列程式範例仍為測試版。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let publicBlockFromCommentParams = PublicBlockFromCommentParams(commentIds: ["commentIds_example"]) // PublicBlockFromCommentParams |
8let sso = "sso_example" // String | (選用)
9
10PublicAPI.unBlockCommentPublic(tenantId: tenantId, commentId: commentId, publicBlockFromCommentParams: publicBlockFromCommentParams, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

checkedCommentsForBlocked Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdsstringqueryYes以逗號分隔的評論 ID 列表。
ssostringqueryNo

回應

Returns: CheckBlockedCommentsResponse

範例

checkedCommentsForBlocked 範例
Copy Copy
1
2// 下列程式碼範例仍屬測試版。如遇任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentIds = "commentIds_example" // String | 以逗號分隔的評論 ID 列表。
7let sso = "sso_example" // String | (可選)
8
9PublicAPI.checkedCommentsForBlocked(tenantId: tenantId, commentIds: commentIds, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

blockUserFromComment Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery是
idstringpath是
userIdstringquery否
anonUserIdstringquery否

回應

返回:BlockSuccess

範例

blockUserFromComment 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let blockFromCommentParams = BlockFromCommentParams(commentIdsToCheck: ["commentIdsToCheck_example"]) // BlockFromCommentParams |
8let userId = "userId_example" // String | (可選)
9let anonUserId = "anonUserId_example" // String | (可選)
10
11DefaultAPI.blockUserFromComment(tenantId: tenantId, id: id, blockFromCommentParams: blockFromCommentParams, options: DefaultAPI.BlockUserFromCommentOptions(userId: userId, anonUserId: anonUserId)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

createCommentPublic Internal Link

參數

名稱類型位置必填說明
tenantIdstringpathYes
urlIdstringqueryYes
broadcastIdstringqueryYes
sessionIdstringqueryNo
ssostringqueryNo
localestringqueryNo

回應

返回: SaveCommentsResponseWithPresence

範例

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", poll: CommentPollInput(question: "question_example", options: ["options_example"], closesAt: "closesAt_example", privacy: 123, requireVoteToSeeResults: false), tos: false, botId: "botId_example") // CommentData |
9let sessionId = "sessionId_example" // String | (可選)
10let sso = "sso_example" // String | (可選)
11let locale = "locale_example" // String | (可選)
12
13PublicAPI.createCommentPublic(tenantId: tenantId, urlId: urlId, broadcastId: broadcastId, commentData: commentData, options: PublicAPI.CreateCommentPublicOptions(sessionId: sessionId, sso: sso, locale: locale)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

deleteComment Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery是
idstringpath是
contextUserIdstringquery否
isLivebooleanquery否

回應

返回:DeleteCommentResult

範例

deleteComment 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let contextUserId = "contextUserId_example" // String | (可選)
8let isLive = true // Bool | (可選)
9
10DefaultAPI.deleteComment(tenantId: tenantId, id: id, options: DefaultAPI.DeleteCommentOptions(contextUserId: contextUserId, isLive: isLive)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

deleteCommentPublic Internal Link

參數

名稱類型位置必填說明
tenantIdstringpathYes
commentIdstringpathYes
broadcastIdstringqueryYes
editKeystringqueryNo
ssostringqueryNo

回應

返回: PublicAPIDeleteCommentResponse

範例

deleteCommentPublic 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試階段。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String |
8let editKey = "editKey_example" // String | (可選)
9let sso = "sso_example" // String | (可選)
10
11PublicAPI.deleteCommentPublic(tenantId: tenantId, commentId: commentId, broadcastId: broadcastId, options: PublicAPI.DeleteCommentPublicOptions(editKey: editKey, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

deleteCommentVote Internal Link

Parameters

名稱類型位置必要描述
tenantIdstringpath是
commentIdstringpath是
voteIdstringpath是
urlIdstringquery是
broadcastIdstringquery是
editKeystringquery否
ssostringquery否

Response

返回: VoteDeleteResponse

Example

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, options: PublicAPI.DeleteCommentVoteOptions(editKey: editKey, sso: sso)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

flagComment Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是
idstringpath是
userIdstringquery否
anonUserIdstringquery否

回傳

Returns: FlagCommentResponse

範例

flagComment 範例
Copy Copy
1
2// 以下程式碼範例仍為測試版。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let userId = "userId_example" // String | (可選)
8let anonUserId = "anonUserId_example" // String | (可選)
9
10DefaultAPI.flagComment(tenantId: tenantId, id: id, options: DefaultAPI.FlagCommentOptions(userId: userId, anonUserId: anonUserId)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getComment Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

回應

回傳: APIGetCommentResponse

範例

getComment 範例
Copy Copy
1
2// 以下程式範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getComment(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getComments Internal Link

參數

名稱類型位置必填說明
tenantIdstringqueryYes
pageintegerqueryNo
limitintegerqueryNo
skipintegerqueryNo
asTreebooleanqueryNo
skipChildrenintegerqueryNo
limitChildrenintegerqueryNo
maxTreeDepthintegerqueryNo
urlIdstringqueryNo
userIdstringqueryNo
anonUserIdstringqueryNo
contextUserIdstringqueryNo
hashTagstringqueryNo
parentIdstringqueryNo
directionstringqueryNo
fromDateintegerqueryNo
toDateintegerqueryNo

回應

返回: APIGetCommentsResponse

範例

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 | (optional)
7let limit = 987 // Int | (optional)
8let skip = 987 // Int | (optional)
9let asTree = true // Bool | (optional)
10let skipChildren = 987 // Int | (optional)
11let limitChildren = 987 // Int | (optional)
12let maxTreeDepth = 987 // Int | (optional)
13let urlId = "urlId_example" // String | (optional)
14let userId = "userId_example" // String | (optional)
15let anonUserId = "anonUserId_example" // String | (optional)
16let contextUserId = "contextUserId_example" // String | (optional)
17let hashTag = "hashTag_example" // String | (optional)
18let parentId = "parentId_example" // String | (optional)
19let direction = SortDirections() // SortDirections | (optional)
20let fromDate = 987 // Int64 | (optional)
21let toDate = 987 // Int64 | (optional)
22
23DefaultAPI.getComments(tenantId: tenantId, options: DefaultAPI.GetCommentsOptions(page: page, limit: limit, skip: skip, asTree: asTree, skipChildren: skipChildren, limitChildren: limitChildren, maxTreeDepth: maxTreeDepth, urlId: urlId, userId: userId, anonUserId: anonUserId, contextUserId: contextUserId, hashTag: hashTag, parentId: parentId, direction: direction, fromDate: fromDate, toDate: toDate)) { (response, error) in
24 guard error == nil else {
25 print(error)
26 return
27 }
28
29 if (response) {
30 dump(response)
31 }
32}
33

getCommentsPublic Internal Link

req tenantId urlId

參數

名稱類型位置必填說明
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否
questionIdstringquery否
questionValueintegerquery否

回應

返回:GetCommentsResponseWithPresencePublicComment

範例

getCommentsPublic 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let page = 987 // Int | (可選)
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 | (可選)
33let questionId = "questionId_example" // String | (可選)
34let questionValue = 987 // Int | (可選)
35
36PublicAPI.getCommentsPublic(tenantId: tenantId, urlId: urlId, options: PublicAPI.GetCommentsPublicOptions(page: page, direction: direction, sso: sso, skip: skip, skipChildren: skipChildren, limit: limit, limitChildren: limitChildren, countChildren: countChildren, fetchPageForCommentId: fetchPageForCommentId, includeConfig: includeConfig, countAll: countAll, includei10n: includei10n, locale: locale, modules: modules, isCrawler: isCrawler, includeNotificationCount: includeNotificationCount, asTree: asTree, maxTreeDepth: maxTreeDepth, useFullTranslationIds: useFullTranslationIds, parentId: parentId, searchText: searchText, hashTags: hashTags, userId: userId, customConfigStr: customConfigStr, afterCommentId: afterCommentId, beforeCommentId: beforeCommentId, questionId: questionId, questionValue: questionValue)) { (response, error) in
37 guard error == nil else {
38 print(error)
39 return
40 }
41
42 if (response) {
43 dump(response)
44 }
45}
46

getCommentText Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringpathYes
commentIdstringpathYes
editKeystringqueryNo
ssostringqueryNo

回應

返回:PublicAPIGetCommentTextResponse

範例

getCommentText 範例
Copy Copy
1
2// 以下程式碼範例仍處於 Beta 階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let editKey = "editKey_example" // String | (可選)
8let sso = "sso_example" // String | (可選)
9
10PublicAPI.getCommentText(tenantId: tenantId, commentId: commentId, options: PublicAPI.GetCommentTextOptions(editKey: editKey, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getCommentVoteUserNames Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringpathYes
commentIdstringpathYes
dirintegerqueryYes
ssostringqueryNo

回應

回傳: GetCommentVoteUserNamesSuccessResponse

範例

getCommentVoteUserNames 範例
Copy Copy
1
2// 下列程式碼範例仍為測試版。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let dir = 987 // Int |
8let sso = "sso_example" // String | (可選)
9
10PublicAPI.getCommentVoteUserNames(tenantId: tenantId, commentId: commentId, dir: dir, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

lockComment Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringpath是
commentIdstringpath是
broadcastIdstringquery是
ssostringquery否

回應

回傳: APIEmptyResponse

範例

lockComment 範例
Copy Copy
1
2// 下列程式範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String |
8let sso = "sso_example" // String | (可選)
9
10PublicAPI.lockComment(tenantId: tenantId, commentId: commentId, broadcastId: broadcastId, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

pinComment Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringpath是
commentIdstringpath是
broadcastIdstringquery是
ssostringquery否

回應

回傳: ChangeCommentPinStatusResponse

範例

pinComment 範例
Copy Copy
1
2// 以下程式碼範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String |
8let sso = "sso_example" // String | (選填)
9
10PublicAPI.pinComment(tenantId: tenantId, commentId: commentId, broadcastId: broadcastId, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

saveComment Internal Link

參數

名稱類型位置必填說明
tenantIdstringqueryYes
isLivebooleanqueryNo
doSpamCheckbooleanqueryNo
sendEmailsbooleanqueryNo
populateNotificationsbooleanqueryNo

回應

返回:APISaveCommentResponse

範例

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", poll: CommentPollInput(question: "question_example", options: ["options_example"], closesAt: "closesAt_example", privacy: 123, requireVoteToSeeResults: false), tos: false, botId: "botId_example", approved: false, domain: "domain_example", ip: "ip_example", isPinned: false, locale: "locale_example", reviewed: false, verified: false, votes: 123, votesDown: 123, votesUp: 123) // CreateCommentParams |
7let isLive = true // Bool | (可選)
8let doSpamCheck = true // Bool | (可選)
9let sendEmails = true // Bool | (可選)
10let populateNotifications = true // Bool | (可選)
11
12DefaultAPI.saveComment(tenantId: tenantId, createCommentParams: createCommentParams, options: DefaultAPI.SaveCommentOptions(isLive: isLive, doSpamCheck: doSpamCheck, sendEmails: sendEmails, populateNotifications: populateNotifications)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

saveCommentsBulk Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery是
isLivebooleanquery否
doSpamCheckbooleanquery否
sendEmailsbooleanquery否
populateNotificationsbooleanquery否

回應

返回: [SaveCommentsBulkResponse]

範例

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", poll: CommentPollInput(question: "question_example", options: ["options_example"], closesAt: "closesAt_example", privacy: 123, requireVoteToSeeResults: false), tos: false, botId: "botId_example", approved: false, domain: "domain_example", ip: "ip_example", isPinned: false, locale: "locale_example", reviewed: false, verified: false, votes: 123, votesDown: 123, votesUp: 123)] // [CreateCommentParams] |
7let isLive = true // Bool | (可選)
8let doSpamCheck = true // Bool | (可選)
9let sendEmails = true // Bool | (可選)
10let populateNotifications = true // Bool | (可選)
11
12DefaultAPI.saveCommentsBulk(tenantId: tenantId, createCommentParams: createCommentParams, options: DefaultAPI.SaveCommentsBulkOptions(isLive: isLive, doSpamCheck: doSpamCheck, sendEmails: sendEmails, populateNotifications: populateNotifications)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

setCommentText Internal Link

參數

名稱類型位置必填說明
tenantIdstringpathYes
commentIdstringpathYes
broadcastIdstringqueryYes
editKeystringqueryNo
ssostringqueryNo

回應

返回: PublicAPISetCommentTextResponse

範例

setCommentText 範例
Copy Copy
1
2// 以下程式碼範例仍處於測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String |
8let commentTextUpdateRequest = CommentTextUpdateRequest(comment: "comment_example", mentions: [CommentUserMentionInfo(id: "id_example", tag: "tag_example", rawTag: "rawTag_example", type: "type_example", sent: false)], hashTags: [CommentUserHashTagInfo(id: "id_example", tag: "tag_example", url: "url_example", retain: false)]) // CommentTextUpdateRequest |
9let editKey = "editKey_example" // String | (可選)
10let sso = "sso_example" // String | (可選)
11
12PublicAPI.setCommentText(tenantId: tenantId, commentId: commentId, broadcastId: broadcastId, commentTextUpdateRequest: commentTextUpdateRequest, options: PublicAPI.SetCommentTextOptions(editKey: editKey, sso: sso)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

translateComments Internal Link

將給定的評論翻譯成小工具的語系。僅在相應的小工具自訂規則將「評論翻譯」設定為自動或手動時可用。

參數

名稱類型位置必填說明
tenantIdstringpathYes
urlIdstringqueryYes
ssostringqueryNo
localestringqueryNo

回應

返回:CommentTranslationsResponse

範例

translateComments 範例
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 commentTranslationsRequest = CommentTranslationsRequest(commentIds: ["commentIds_example"]) // CommentTranslationsRequest |
8let sso = "sso_example" // String | (optional)
9let locale = "locale_example" // String | (optional)
10
11PublicAPI.translateComments(tenantId: tenantId, urlId: urlId, commentTranslationsRequest: commentTranslationsRequest, options: PublicAPI.TranslateCommentsOptions(sso: sso, locale: locale)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

unBlockUserFromComment Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery是
idstringpath是
userIdstringquery否
anonUserIdstringquery否

回應

返回: UnblockSuccess

範例

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 | (optional)
9let anonUserId = "anonUserId_example" // String | (optional)
10
11DefaultAPI.unBlockUserFromComment(tenantId: tenantId, id: id, unBlockFromCommentParams: unBlockFromCommentParams, options: DefaultAPI.UnBlockUserFromCommentOptions(userId: userId, anonUserId: anonUserId)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

unFlagComment Internal Link

參數

名稱類型位置必須描述
tenantIdstringquery是
idstringpath是
userIdstringquery否
anonUserIdstringquery否

回應

返回:FlagCommentResponse

範例

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 | (optional)
8let anonUserId = "anonUserId_example" // String | (optional)
9
10DefaultAPI.unFlagComment(tenantId: tenantId, id: id, options: DefaultAPI.UnFlagCommentOptions(userId: userId, anonUserId: anonUserId)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

unLockComment Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringpath是
commentIdstringpath是
broadcastIdstringquery是
ssostringquery否

回應

回傳: APIEmptyResponse

範例

unLockComment 範例
Copy Copy
1
2// 以下範例程式碼仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String |
8let sso = "sso_example" // String | (可選)
9
10PublicAPI.unLockComment(tenantId: tenantId, commentId: commentId, broadcastId: broadcastId, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

unPinComment Internal Link

參數

名稱類型位置必填說明
tenantIdstring路徑是
commentIdstring路徑是
broadcastIdstring查詢是
ssostring查詢否

回應

回傳:ChangeCommentPinStatusResponse

範例

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

updateComment Internal Link

參數

名稱類型位置必填描述
tenantIdstringqueryYes
idstringpathYes
contextUserIdstringqueryNo
doSpamCheckbooleanqueryNo
isLivebooleanqueryNo

回應

返回:APIEmptyResponse

範例

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 | (optional)
9let doSpamCheck = true // Bool | (optional)
10let isLive = true // Bool | (optional)
11
12DefaultAPI.updateComment(tenantId: tenantId, id: id, updatableCommentParams: updatableCommentParams, options: DefaultAPI.UpdateCommentOptions(contextUserId: contextUserId, doSpamCheck: doSpamCheck, isLive: isLive)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

voteComment Internal Link

參數

名稱類型位置必填說明
tenantIdstringpathYes
commentIdstringpathYes
urlIdstringqueryYes
broadcastIdstringqueryYes
sessionIdstringqueryNo
ssostringqueryNo

回應

返回:VoteResponse

範例

voteComment 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let urlId = "urlId_example" // String |
8let broadcastId = "broadcastId_example" // String |
9let voteBodyParams = VoteBodyParams(commenterEmail: "commenterEmail_example", commenterName: "commenterName_example", voteDir: "voteDir_example", url: "url_example") // VoteBodyParams |
10let sessionId = "sessionId_example" // String | (可選)
11let sso = "sso_example" // String | (可選)
12
13PublicAPI.voteComment(tenantId: tenantId, commentId: commentId, urlId: urlId, broadcastId: broadcastId, voteBodyParams: voteBodyParams, options: PublicAPI.VoteCommentOptions(sessionId: sessionId, sso: sso)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

getCommentsForUser Internal Link

參數

名稱類型位置必填描述
userIdstringqueryNo
directionstringqueryNo
repliesToUserIdstringqueryNo
pagenumberqueryNo
includei10nbooleanqueryNo
localestringqueryNo
isCrawlerbooleanqueryNo

回應

Returns: GetCommentsForUserResponse

範例

getCommentsForUser 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let userId = "userId_example" // String | (optional)
6let direction = SortDirections() // SortDirections | (optional)
7let repliesToUserId = "repliesToUserId_example" // String | (optional)
8let page = 987 // Double | (optional)
9let includei10n = true // Bool | (optional)
10let locale = "locale_example" // String | (optional)
11let isCrawler = true // Bool | (optional)
12
13PublicAPI.getCommentsForUser(options: PublicAPI.GetCommentsForUserOptions(userId: userId, direction: direction, repliesToUserId: repliesToUserId, page: page, includei10n: includei10n, locale: locale, isCrawler: isCrawler)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

addDomainConfig Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是

回應

回傳:AddDomainConfigResponse

範例

addDomainConfig 範例
Copy Copy
1
2// 下列程式碼範例仍為測試版。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let addDomainConfigParams = AddDomainConfigParams(domain: "domain_example", emailFromName: "emailFromName_example", emailFromEmail: "emailFromEmail_example", logoSrc: "logoSrc_example", logoSrc100px: "logoSrc100px_example", footerUnsubscribeURL: "footerUnsubscribeURL_example", emailHeaders: "TODO") // AddDomainConfigParams |
7
8DefaultAPI.addDomainConfig(tenantId: tenantId, addDomainConfigParams: addDomainConfigParams) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

deleteDomainConfig Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
domainstringpath是

回應

Returns: DeleteDomainConfigResponse

範例

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

getDomainConfig Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是
domainstringpath是

回應

回傳: GetDomainConfigResponse

範例

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

getDomainConfigs Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是

回應

回傳: GetDomainConfigsResponse

範例

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

patchDomainConfig Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
domainToUpdatestringpath是

回應

回傳: PatchDomainConfigResponse

範例

patchDomainConfig 範例
Copy Copy
1
2// 下列程式範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let domainToUpdate = "domainToUpdate_example" // String |
7let patchDomainConfigParams = PatchDomainConfigParams(domain: "domain_example", emailFromName: "emailFromName_example", emailFromEmail: "emailFromEmail_example", logoSrc: "logoSrc_example", logoSrc100px: "logoSrc100px_example", footerUnsubscribeURL: "footerUnsubscribeURL_example", emailHeaders: "TODO") // PatchDomainConfigParams |
8
9DefaultAPI.patchDomainConfig(tenantId: tenantId, domainToUpdate: domainToUpdate, patchDomainConfigParams: patchDomainConfigParams) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

putDomainConfig Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
domainToUpdatestringpath是

回應

回傳: PutDomainConfigResponse

範例

putDomainConfig 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let domainToUpdate = "domainToUpdate_example" // String |
7let updateDomainConfigParams = UpdateDomainConfigParams(domain: "domain_example", emailFromName: "emailFromName_example", emailFromEmail: "emailFromEmail_example", logoSrc: "logoSrc_example", logoSrc100px: "logoSrc100px_example", footerUnsubscribeURL: "footerUnsubscribeURL_example", emailHeaders: "TODO") // UpdateDomainConfigParams |
8
9DefaultAPI.putDomainConfig(tenantId: tenantId, domainToUpdate: domainToUpdate, updateDomainConfigParams: updateDomainConfigParams) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

createEmailTemplate Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是

回應

回傳:CreateEmailTemplateResponse

範例

createEmailTemplate 範例
Copy Copy
1
2// 下列程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // 字串 |
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

deleteEmailTemplate Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是

回應

回傳: APIEmptyResponse

範例

deleteEmailTemplate 範例
Copy Copy
1
2// 以下程式範例仍屬測試版。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.deleteEmailTemplate(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

deleteEmailTemplateRenderError Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是
errorIdstringpath是

回應

回傳: APIEmptyResponse

範例

deleteEmailTemplateRenderError 範例
Copy Copy
1
2// 下列程式範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let errorId = "errorId_example" // String |
8
9DefaultAPI.deleteEmailTemplateRenderError(tenantId: tenantId, id: id, errorId: errorId) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getEmailTemplate Internal Link

參數

名稱類型位置必要說明
tenantIdstringquery是
idstringpath是

回應

回傳: GetEmailTemplateResponse

範例

getEmailTemplate 範例
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.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

getEmailTemplateDefinitions Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery是

回傳

回傳: GetEmailTemplateDefinitionsResponse

範例

getEmailTemplateDefinitions 範例
Copy Copy
1
2// 下列程式碼範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6
7DefaultAPI.getEmailTemplateDefinitions(tenantId: tenantId) { (response, error) in
8 guard error == nil else {
9 print(error)
10 return
11 }
12
13 if (response) {
14 dump(response)
15 }
16}
17

getEmailTemplateRenderErrors Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstring查詢是
idstring路徑是
skipnumber查詢否

回應

回傳: GetEmailTemplateRenderErrorsResponse

範例

getEmailTemplateRenderErrors 範例
Copy Copy
1
2// 下列程式碼範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let skip = 987 // Double | (可選)
8
9DefaultAPI.getEmailTemplateRenderErrors(tenantId: tenantId, id: id, skip: skip) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getEmailTemplates Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
skipnumberquery否

回應

回傳: GetEmailTemplatesResponse

範例

getEmailTemplates 範例
Copy Copy
1
2// 下列程式範例仍屬測試版。如遇任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let skip = 987 // Double | (可選)
7
8DefaultAPI.getEmailTemplates(tenantId: tenantId, skip: skip) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

renderEmailTemplate Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstring查詢是
localestring查詢否

回應

回傳: RenderEmailTemplateResponse

範例

renderEmailTemplate 範例
Copy Copy
1
2// 以下程式範例仍處於測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let renderEmailTemplateBody = RenderEmailTemplateBody(emailTemplateId: "emailTemplateId_example", ejs: "ejs_example", testData: "TODO", translationOverridesByLocale: "TODO") // RenderEmailTemplateBody |
7let locale = "locale_example" // String | (選用)
8
9DefaultAPI.renderEmailTemplate(tenantId: tenantId, renderEmailTemplateBody: renderEmailTemplateBody, locale: locale) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

updateEmailTemplate Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是
idstringpath是

回應

回傳: APIEmptyResponse

範例

updateEmailTemplate 範例
Copy Copy
1
2// 下列程式碼範例仍為測試版。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateEmailTemplateBody = UpdateEmailTemplateBody(emailTemplateId: "emailTemplateId_example", displayName: "displayName_example", ejs: "ejs_example", domain: "domain_example", translationOverridesByLocale: "TODO", testData: "TODO") // UpdateEmailTemplateBody |
8
9DefaultAPI.updateEmailTemplate(tenantId: tenantId, id: id, updateEmailTemplateBody: updateEmailTemplateBody) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getEventLog Internal Link

req tenantId urlId userIdWS

參數

NameTypeLocationRequiredDescription
tenantIdstringpath是
urlIdstringquery是
userIdWSstringquery是
startTimeintegerquery是
endTimeintegerquery否

回應

回傳: GetEventLogResponse

範例

getEventLog 範例
Copy Copy
1
2// 下列程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let userIdWS = "userIdWS_example" // String |
8let startTime = 987 // Int64 |
9let endTime = 987 // Int64 | (選填)
10
11PublicAPI.getEventLog(tenantId: tenantId, urlId: urlId, userIdWS: userIdWS, startTime: startTime, endTime: endTime) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

getGlobalEventLog Internal Link

req tenantId urlId userIdWS

參數

NameTypeLocationRequiredDescription
tenantIdstringpath是
urlIdstringquery是
userIdWSstringquery是
startTimeintegerquery是
endTimeintegerquery否

回應

回傳: GetEventLogResponse

範例

getGlobalEventLog 範例
Copy Copy
1
2// 以下程式範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let userIdWS = "userIdWS_example" // String |
8let startTime = 987 // Int64 |
9let endTime = 987 // Int64 | (可選)
10
11PublicAPI.getGlobalEventLog(tenantId: tenantId, urlId: urlId, userIdWS: userIdWS, startTime: startTime, endTime: endTime) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

createFeedPost Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是
broadcastIdstringquery否
isLivebooleanquery否
doSpamCheckbooleanquery否
skipDupCheckbooleanquery否

回應

返回:CreateFeedPostsResponse

範例

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, options: DefaultAPI.CreateFeedPostOptions(broadcastId: broadcastId, isLive: isLive, doSpamCheck: doSpamCheck, skipDupCheck: skipDupCheck)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

createFeedPostPublic Internal Link

參數

名稱類型位置必填描述
tenantIdstringpath是
broadcastIdstringquery否
ssostringquery否

回應

返回:CreateFeedPostResponse

範例

createFeedPostPublic 範例
Copy Copy
1
2// 以下程式碼範例仍屬 beta 版。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createFeedPostParams = CreateFeedPostParams(title: "title_example", contentHTML: "contentHTML_example", media: [FeedPostMediaItem(title: "title_example", linkUrl: "linkUrl_example", sizes: [FeedPostMediaItemAsset(w: 123, h: 123, src: "src_example")])], links: [FeedPostLink(text: "text_example", title: "title_example", description: "description_example", url: "url_example")], fromUserId: "fromUserId_example", fromUserDisplayName: "fromUserDisplayName_example", tags: ["tags_example"], meta: "TODO") // CreateFeedPostParams |
7let broadcastId = "broadcastId_example" // String | (可選)
8let sso = "sso_example" // String | (可選)
9
10PublicAPI.createFeedPostPublic(tenantId: tenantId, createFeedPostParams: createFeedPostParams, options: PublicAPI.CreateFeedPostPublicOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

deleteFeedPostPublic Internal Link

參數

名稱型別位置必填說明
tenantIdstringpathYes
postIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

回應

返回: DeleteFeedPostPublicResponse

範例

deleteFeedPostPublic 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let postId = "postId_example" // String |
7let broadcastId = "broadcastId_example" // String | (可選)
8let sso = "sso_example" // String | (可選)
9
10PublicAPI.deleteFeedPostPublic(tenantId: tenantId, postId: postId, options: PublicAPI.DeleteFeedPostPublicOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getFeedPosts Internal Link

req tenantId afterId

參數

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
afterIdstringqueryNo
limitintegerqueryNo
tagsarrayqueryNo

回應

返回: GetFeedPostsResponse

範例

getFeedPosts 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let afterId = "afterId_example" // String | (可選)
7let limit = 987 // Int | (可選)
8let tags = ["inner_example"] // [String] | (可選)
9
10DefaultAPI.getFeedPosts(tenantId: tenantId, options: DefaultAPI.GetFeedPostsOptions(afterId: afterId, limit: limit, tags: tags)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getFeedPostsPublic Internal Link

req tenantId afterId

參數

名稱類型位置必填描述
tenantIdstringpathYes
afterIdstringqueryNo
limitintegerqueryNo
tagsarrayqueryNo
ssostringqueryNo
isCrawlerbooleanqueryNo
includeUserInfobooleanqueryNo

回應

返回:PublicFeedPostsResponse

範例

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, options: PublicAPI.GetFeedPostsPublicOptions(afterId: afterId, limit: limit, tags: tags, sso: sso, isCrawler: isCrawler, includeUserInfo: includeUserInfo)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

getFeedPostsStats Internal Link

參數

名稱類型位置必需說明
tenantIdstringpathYes
postIdsarrayqueryYes
ssostringqueryNo

回應

回傳: FeedPostsStatsResponse

範例

getFeedPostsStats 範例
Copy Copy
1
2// 以下範例程式碼仍屬測試版。如遇任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let postIds = ["inner_example"] // [String] |
7let sso = "sso_example" // String | (可選)
8
9PublicAPI.getFeedPostsStats(tenantId: tenantId, postIds: postIds, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getUserReactsPublic Internal Link

參數

名稱類型位置必需描述
tenantIdstringpath是
postIdsarrayquery否
ssostringquery否

回應

返回: UserReactsResponse

範例

getUserReactsPublic 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試階段。任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let postIds = ["inner_example"] // [String] | (可選)
7let sso = "sso_example" // String | (可選)
8
9PublicAPI.getUserReactsPublic(tenantId: tenantId, options: PublicAPI.GetUserReactsPublicOptions(postIds: postIds, sso: sso)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

reactFeedPostPublic Internal Link

參數

名稱類型位置必填描述
tenantIdstringpathYes
postIdstringpathYes
isUndobooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

回應

返回: ReactFeedPostResponse

示例

reactFeedPostPublic 範例
Copy Copy
1
2// 以下程式碼樣本仍處於測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let postId = "postId_example" // String |
7let reactBodyParams = ReactBodyParams(reactType: "reactType_example") // ReactBodyParams |
8let isUndo = true // Bool | (optional) -> (可選)
9let broadcastId = "broadcastId_example" // String | (optional) -> (可選)
10let sso = "sso_example" // String | (optional) -> (可選)
11
12PublicAPI.reactFeedPostPublic(tenantId: tenantId, postId: postId, reactBodyParams: reactBodyParams, options: PublicAPI.ReactFeedPostPublicOptions(isUndo: isUndo, broadcastId: broadcastId, sso: sso)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

updateFeedPost Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery是
idstringpath是

回應

回傳: APIEmptyResponse

範例

updateFeedPost 範例
Copy Copy
1
2// 以下程式碼範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let feedPost = FeedPost(id: "id_example", tenantId: "tenantId_example", title: "title_example", fromUserId: "fromUserId_example", fromUserDisplayName: "fromUserDisplayName_example", fromUserAvatar: "fromUserAvatar_example", fromIpHash: "fromIpHash_example", tags: ["tags_example"], weight: 123, meta: "TODO", contentHTML: "contentHTML_example", media: [FeedPostMediaItem(title: "title_example", linkUrl: "linkUrl_example", sizes: [FeedPostMediaItemAsset(w: 123, h: 123, src: "src_example")])], links: [FeedPostLink(text: "text_example", title: "title_example", description: "description_example", url: "url_example")], createdAt: Date(), reacts: "TODO", commentCount: 123) // FeedPost |
8
9DefaultAPI.updateFeedPost(tenantId: tenantId, id: id, feedPost: feedPost) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

updateFeedPostPublic Internal Link

參數

名稱類型位置必填說明
tenantIdstringpath是
postIdstringpath是
broadcastIdstringquery否
ssostringquery否

回應

回傳: CreateFeedPostResponse

範例

updateFeedPostPublic 範例
Copy Copy
1
2// 以下程式碼範例仍處於測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let postId = "postId_example" // String |
7let updateFeedPostParams = UpdateFeedPostParams(title: "title_example", contentHTML: "contentHTML_example", media: [FeedPostMediaItem(title: "title_example", linkUrl: "linkUrl_example", sizes: [FeedPostMediaItemAsset(w: 123, h: 123, src: "src_example")])], links: [FeedPostLink(text: "text_example", title: "title_example", description: "description_example", url: "url_example")], tags: ["tags_example"], meta: "TODO") // UpdateFeedPostParams |
8let broadcastId = "broadcastId_example" // String | (可選)
9let sso = "sso_example" // String | (可選)
10
11PublicAPI.updateFeedPostPublic(tenantId: tenantId, postId: postId, updateFeedPostParams: updateFeedPostParams, options: PublicAPI.UpdateFeedPostPublicOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

flagCommentPublic Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
commentIdstringpath是
isFlaggedbooleanquery是
ssostringquery否

回應

回傳: APIEmptyResponse

範例

flagCommentPublic 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let isFlagged = true // Bool |
8let sso = "sso_example" // String | (可選)
9
10PublicAPI.flagCommentPublic(tenantId: tenantId, commentId: commentId, isFlagged: isFlagged, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getGifLarge Internal Link

參數

名稱類型位置必填描述
tenantIdstring路徑是
largeInternalURLSanitizedstring查詢是

回應

回傳: GifGetLargeResponse

範例

getGifLarge 範例
Copy Copy
1
2// 以下程式範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let largeInternalURLSanitized = "largeInternalURLSanitized_example" // String |
7
8PublicAPI.getGifLarge(tenantId: tenantId, largeInternalURLSanitized: largeInternalURLSanitized) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getGifsSearch Internal Link

參數

名稱類型位置必填說明
tenantIdstringpathYes
searchstringqueryYes
localestringqueryNo
ratingstringqueryNo
pagenumberqueryNo

回應

Returns: GetGifsSearchResponse

範例

getGifsSearch 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let search = "search_example" // String |
7let locale = "locale_example" // String | (可選)
8let rating = "rating_example" // String | (可選)
9let page = 987 // Double | (可選)
10
11PublicAPI.getGifsSearch(tenantId: tenantId, search: search, options: PublicAPI.GetGifsSearchOptions(locale: locale, rating: rating, page: page)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

getGifsTrending Internal Link

參數

名稱類型位置必填說明
tenantIdstringpath是
localestringquery否
ratingstringquery否
pagenumberquery否

回應

返回: GetGifsTrendingResponse

範例

getGifsTrending 範例
Copy Copy
1
2// 以下程式碼範例仍屬於測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let locale = "locale_example" // String | (可選)
7let rating = "rating_example" // String | (可選)
8let page = 987 // Double | (可選)
9
10PublicAPI.getGifsTrending(tenantId: tenantId, options: PublicAPI.GetGifsTrendingOptions(locale: locale, rating: rating, page: page)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

addHashTag Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是

回應

返回: CreateHashTagResponse

範例

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

addHashTagsBulk Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是

回應

返回:BulkCreateHashTagsResponse

範例

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

deleteHashTag Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是
tagstringpath是

回應

返回:APIEmptyResponse

範例

deleteHashTag 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let tag = "tag_example" // String |
7let deleteHashTagRequestBody = DeleteHashTagRequestBody(tenantId: "tenantId_example") // DeleteHashTagRequestBody | (optional)
8
9DefaultAPI.deleteHashTag(tenantId: tenantId, tag: tag, deleteHashTagRequestBody: deleteHashTagRequestBody) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getHashTags Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
pagenumberqueryNo

回應

Returns: GetHashTagsResponse

範例

getHashTags 範例
Copy Copy
1
2// 以下程式範例仍為測試版。如遇任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let page = 987 // Double | (可選)
7
8DefaultAPI.getHashTags(tenantId: tenantId, page: page) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

patchHashTag Internal Link

參數

名稱類型位置必填說明
tenantIdstringqueryYes
tagstringpathYes

回應

Returns: UpdateHashTagResponse

範例

patchHashTag 範例
Copy Copy
1
2// 以下程式碼範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let tag = "tag_example" // String |
7let updateHashTagBody = UpdateHashTagBody(tenantId: "tenantId_example", url: "url_example", tag: "tag_example") // UpdateHashTagBody | (可選)
8
9DefaultAPI.patchHashTag(tenantId: tenantId, tag: tag, updateHashTagBody: updateHashTagBody) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getMe Internal Link

識別正在使用的憑證:它所屬的租戶,以及對於 OAuth 令牌,授權該令牌的使用者。
整合使用此資訊來測試連線並為其加上標籤。

參數

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

回應

返回:GetMeResponse

範例

getMe 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6
7DefaultAPI.getMe(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

deleteModerationVote Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery是
commentIdstringpath是
voteIdstringpath是
broadcastIdstringquery否
ssostringquery否

回應

返回: VoteDeleteResponse

範例

deleteModerationVote 範例
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 broadcastId = "broadcastId_example" // String | (optional)
9let sso = "sso_example" // String | (optional)
10
11ModerationAPI.deleteModerationVote(tenantId: tenantId, commentId: commentId, voteId: voteId, options: ModerationAPI.DeleteModerationVoteOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

getApiComments Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery是
pagenumberquery否
countnumberquery否
text-searchstringquery否
byIPFromCommentstringquery否
filtersstringquery否
searchFiltersstringquery否
sortsstringquery否
demobooleanquery否
ssostringquery否

回應

返回: ModerationAPIGetCommentsResponse

範例

getApiComments 範例
Copy Copy
1
2// 以下程式碼範例仍處於測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let page = 987 // Double | (optional)
7let count = 987 // Double | (optional)
8let textSearch = "textSearch_example" // String | (optional)
9let byIPFromComment = "byIPFromComment_example" // String | (optional)
10let filters = "filters_example" // String | (optional)
11let searchFilters = "searchFilters_example" // String | (optional)
12let sorts = "sorts_example" // String | (optional)
13let demo = true // Bool | (optional)
14let sso = "sso_example" // String | (optional)
15
16ModerationAPI.getApiComments(tenantId: tenantId, options: ModerationAPI.GetApiCommentsOptions(page: page, count: count, textSearch: textSearch, byIPFromComment: byIPFromComment, filters: filters, searchFilters: searchFilters, sorts: sorts, demo: demo, sso: sso)) { (response, error) in
17 guard error == nil else {
18 print(error)
19 return
20 }
21
22 if (response) {
23 dump(response)
24 }
25}
26

getApiExportStatus Internal Link

參數

名稱類型位置必填描述
tenantIdstringqueryYes
batchJobIdstringqueryNo
ssostringqueryNo

回應

回傳:ModerationExportStatusResponse

範例

getApiExportStatus 範例
Copy Copy
1
2// 以下程式碼範例仍屬於測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // 字串 |
6let batchJobId = "batchJobId_example" // 字串 | (可選)
7let sso = "sso_example" // 字串 | (可選)
8
9ModerationAPI.getApiExportStatus(tenantId: tenantId, options: ModerationAPI.GetApiExportStatusOptions(batchJobId: batchJobId, sso: sso)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getApiIds Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
afterIdstringqueryNo
demobooleanqueryNo
ssostringqueryNo

回應

Returns: ModerationAPIGetCommentIdsResponse

範例

getApiIds 範例
Copy Copy
1
2// 以下程式碼範例仍處於測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let textSearch = "textSearch_example" // String | (可選)
7let byIPFromComment = "byIPFromComment_example" // String | (可選)
8let filters = "filters_example" // String | (可選)
9let searchFilters = "searchFilters_example" // String | (可選)
10let afterId = "afterId_example" // String | (可選)
11let demo = true // Bool | (可選)
12let sso = "sso_example" // String | (可選)
13
14ModerationAPI.getApiIds(tenantId: tenantId, options: ModerationAPI.GetApiIdsOptions(textSearch: textSearch, byIPFromComment: byIPFromComment, filters: filters, searchFilters: searchFilters, afterId: afterId, demo: demo, sso: sso)) { (response, error) in
15 guard error == nil else {
16 print(error)
17 return
18 }
19
20 if (response) {
21 dump(response)
22 }
23}
24

getBanUsersFromComment Internal Link

參數

名稱類型位置必填描述
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

回應

返回:GetBannedUsersFromCommentResponse

範例

getBanUsersFromComment 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let sso = "sso_example" // String | (可選)
8
9ModerationAPI.getBanUsersFromComment(tenantId: tenantId, commentId: commentId, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getCommentBanStatus Internal Link

參數

名稱類型位置必要說明
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

回應

返回:GetCommentBanStatusResponse

範例

getCommentBanStatus 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let sso = "sso_example" // String | (可選)
8
9ModerationAPI.getCommentBanStatus(tenantId: tenantId, commentId: commentId, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getCommentChildren Internal Link

參數

名稱類型位置必要說明
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

回應

返回: ModerationAPIChildCommentsResponse

範例

getCommentChildren 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let sso = "sso_example" // String | (optional)
8
9ModerationAPI.getCommentChildren(tenantId: tenantId, commentId: commentId, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getCount Internal Link

參數

名稱類型位置必填描述
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filterstringqueryNo
searchFiltersstringqueryNo
demobooleanqueryNo
ssostringqueryNo

回應

返回:ModerationAPICountCommentsResponse

範例

getCount 示例
Copy Copy
1
2// 以下程式碼範例仍為 beta 版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let textSearch = "textSearch_example" // String | (可選)
7let byIPFromComment = "byIPFromComment_example" // String | (可選)
8let filter = "filter_example" // String | (可選)
9let searchFilters = "searchFilters_example" // String | (可選)
10let demo = true // Bool | (可選)
11let sso = "sso_example" // String | (可選)
12
13ModerationAPI.getCount(tenantId: tenantId, options: ModerationAPI.GetCountOptions(textSearch: textSearch, byIPFromComment: byIPFromComment, filter: filter, searchFilters: searchFilters, demo: demo, sso: sso)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

getCounts Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
ssostringqueryNo

回應

Returns: GetBannedUsersCountResponse

範例

getCounts 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let sso = "sso_example" // String | (可選)
7
8ModerationAPI.getCounts(tenantId: tenantId, sso: sso) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getLogs Internal Link

參數

名稱類型位置必填描述
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

回應

回傳: ModerationAPIGetLogsResponse

範例

getLogs 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let sso = "sso_example" // String | (可選)
8
9ModerationAPI.getLogs(tenantId: tenantId, commentId: commentId, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getManualBadges Internal Link

參數

名稱類型位置必填說明
tenantIdstringqueryYes
ssostringqueryNo

回應

返回:GetTenantManualBadgesResponse

範例

getManualBadges 範例
Copy Copy
1
2// 以下程式碼範例仍屬於測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let sso = "sso_example" // String | (可選)
7
8ModerationAPI.getManualBadges(tenantId: tenantId, sso: sso) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getManualBadgesForUser Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
badgesUserIdstringqueryNo
commentIdstringqueryNo
ssostringqueryNo

回應

返回:GetUserManualBadgesResponse

範例

取得使用者手動徽章範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let badgesUserId = "badgesUserId_example" // String | (可選)
7let commentId = "commentId_example" // String | (可選)
8let sso = "sso_example" // String | (可選)
9
10ModerationAPI.getManualBadgesForUser(tenantId: tenantId, options: ModerationAPI.GetManualBadgesForUserOptions(badgesUserId: badgesUserId, commentId: commentId, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getModerationComment Internal Link

參數

名稱類型位置必填說明
tenantIdstringqueryYes
commentIdstringpathYes
includeEmailbooleanqueryNo
includeIPbooleanqueryNo
ssostringqueryNo

回應

返回:ModerationAPICommentResponse

範例

getModerationComment 範例
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 includeEmail = true // Bool | (可選)
8let includeIP = true // Bool | (可選)
9let sso = "sso_example" // String | (可選)
10
11ModerationAPI.getModerationComment(tenantId: tenantId, commentId: commentId, options: ModerationAPI.GetModerationCommentOptions(includeEmail: includeEmail, includeIP: includeIP, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

getModerationCommentText Internal Link

參數

名稱類型位置必填說明
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

回應

返回:GetCommentTextResponse

範例

getModerationCommentText 範例
Copy Copy
1
2// 以下程式碼範例仍在測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let sso = "sso_example" // String | (optional) // (可選)
8
9ModerationAPI.getModerationCommentText(tenantId: tenantId, commentId: commentId, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getPreBanSummary Internal Link

參數

名稱類型位置必填說明
tenantIdstringqueryYes
commentIdstringpathYes
includeByUserIdAndEmailbooleanqueryNo
includeByIPbooleanqueryNo
includeByEmailDomainbooleanqueryNo
ssostringqueryNo

回應

返回:PreBanSummary

範例

getPreBanSummary 範例
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 includeByUserIdAndEmail = true // Bool | (可選)
8let includeByIP = true // Bool | (可選)
9let includeByEmailDomain = true // Bool | (可選)
10let sso = "sso_example" // String | (可選)
11
12ModerationAPI.getPreBanSummary(tenantId: tenantId, commentId: commentId, options: ModerationAPI.GetPreBanSummaryOptions(includeByUserIdAndEmail: includeByUserIdAndEmail, includeByIP: includeByIP, includeByEmailDomain: includeByEmailDomain, sso: sso)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

getSearchCommentsSummary Internal Link

參數

名稱類型位置必填說明
tenantIdstringqueryYes
valuestringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
ssostringqueryNo

回應

返回: ModerationCommentSearchResponse

範例

getSearchCommentsSummary 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let value = "value_example" // String | (可選)
7let filters = "filters_example" // String | (可選)
8let searchFilters = "searchFilters_example" // String | (可選)
9let sso = "sso_example" // String | (可選)
10
11ModerationAPI.getSearchCommentsSummary(tenantId: tenantId, options: ModerationAPI.GetSearchCommentsSummaryOptions(value: value, filters: filters, searchFilters: searchFilters, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

getSearchPages Internal Link

參數

名稱類型位置必填描述
tenantIdstringqueryYes
valuestringqueryNo
ssostringqueryNo

回應

返回: ModerationPageSearchResponse

範例

getSearchPages 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let value = "value_example" // String | (可選)
7let sso = "sso_example" // String | (可選)
8
9ModerationAPI.getSearchPages(tenantId: tenantId, options: ModerationAPI.GetSearchPagesOptions(value: value, sso: sso)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getSearchSites Internal Link

參數

名稱類型位置必填描述
tenantIdstringqueryYes
valuestringqueryNo
ssostringqueryNo

回應

返回:ModerationSiteSearchResponse

範例

getSearchSites 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試階段。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let value = "value_example" // String | (可選)
7let sso = "sso_example" // String | (可選)
8
9ModerationAPI.getSearchSites(tenantId: tenantId, options: ModerationAPI.GetSearchSitesOptions(value: value, sso: sso)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getSearchSuggest Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery是
text-searchstringquery否
ssostringquery否

回應

返回:ModerationSuggestResponse

範例

getSearchSuggest 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試階段。任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let textSearch = "textSearch_example" // String | (可選)
7let sso = "sso_example" // String | (可選)
8
9ModerationAPI.getSearchSuggest(tenantId: tenantId, options: ModerationAPI.GetSearchSuggestOptions(textSearch: textSearch, sso: sso)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getSearchUsers Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是
valuestringquery否
ssostringquery否

回應

返回:ModerationUserSearchResponse

示例

getSearchUsers 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let value = "value_example" // String | (optional)
7let sso = "sso_example" // String | (optional)
8
9ModerationAPI.getSearchUsers(tenantId: tenantId, options: ModerationAPI.GetSearchUsersOptions(value: value, sso: sso)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getTrustFactor Internal Link

參數

名稱型別位置必填描述
tenantIdstringquery是
userIdstringquery否
ssostringquery否

回應

回傳:GetUserTrustFactorResponse

範例

getTrustFactor 範例
Copy Copy
1
2// 以下程式碼範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String | (可選)
7let sso = "sso_example" // String | (可選)
8
9ModerationAPI.getTrustFactor(tenantId: tenantId, options: ModerationAPI.GetTrustFactorOptions(userId: userId, sso: sso)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getUserBanPreference Internal Link

參數

名稱類型位置必填描述
tenantIdstringqueryYes
ssostringqueryNo

回應

回傳: APIModerateGetUserBanPreferencesResponse

範例

getUserBanPreference 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let sso = "sso_example" // String | (可選)
7
8ModerationAPI.getUserBanPreference(tenantId: tenantId, sso: sso) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getUserInternalProfile Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery是
commentIdstringquery否
ssostringquery否

回應

返回:GetUserInternalProfileResponse

範例

getUserInternalProfile 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String | (可選)
7let sso = "sso_example" // String | (可選)
8
9ModerationAPI.getUserInternalProfile(tenantId: tenantId, options: ModerationAPI.GetUserInternalProfileOptions(commentId: commentId, sso: sso)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

postAdjustCommentVotes Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是
commentIdstringpath是
broadcastIdstringquery否
ssostringquery否

回應

返回:AdjustVotesResponse

範例

postAdjustCommentVotes 範例
Copy Copy
1
2// 以下程式碼示例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let adjustCommentVotesParams = AdjustCommentVotesParams(adjustVoteAmount: 123) // AdjustCommentVotesParams |
8let broadcastId = "broadcastId_example" // String | (可選)
9let sso = "sso_example" // String | (可選)
10
11ModerationAPI.postAdjustCommentVotes(tenantId: tenantId, commentId: commentId, adjustCommentVotesParams: adjustCommentVotesParams, options: ModerationAPI.PostAdjustCommentVotesOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

postApiExport Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是
text-searchstringquery否
byIPFromCommentstringquery否
filtersstringquery否
searchFiltersstringquery否
sortsstringquery否
ssostringquery否

回應

Returns: ModerationExportResponse

範例

postApiExport 範例
Copy Copy
1
2// 以下程式碼範例仍屬beta。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let textSearch = "textSearch_example" // String | (可選)
7let byIPFromComment = "byIPFromComment_example" // String | (可選)
8let filters = "filters_example" // String | (可選)
9let searchFilters = "searchFilters_example" // String | (可選)
10let sorts = "sorts_example" // String | (可選)
11let sso = "sso_example" // String | (可選)
12
13ModerationAPI.postApiExport(tenantId: tenantId, options: ModerationAPI.PostApiExportOptions(textSearch: textSearch, byIPFromComment: byIPFromComment, filters: filters, searchFilters: searchFilters, sorts: sorts, sso: sso)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

postBanUserFromComment Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
banEmailbooleanqueryNo
banEmailDomainbooleanqueryNo
banIPbooleanqueryNo
deleteAllUsersCommentsbooleanqueryNo
bannedUntilstringqueryNo
isShadowBanbooleanqueryNo
updateIdstringqueryNo
banReasonstringqueryNo
ssostringqueryNo

回應

返回:BanUserFromCommentResult

範例

postBanUserFromComment 範例
Copy Copy
1
2// 以下程式碼範例仍屬於 beta 版。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let banEmail = true // Bool | (可選)
8let banEmailDomain = true // Bool | (可選)
9let banIP = true // Bool | (可選)
10let deleteAllUsersComments = true // Bool | (可選)
11let bannedUntil = "bannedUntil_example" // String | (可選)
12let isShadowBan = true // Bool | (可選)
13let updateId = "updateId_example" // String | (可選)
14let banReason = "banReason_example" // String | (可選)
15let sso = "sso_example" // String | (可選)
16
17ModerationAPI.postBanUserFromComment(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostBanUserFromCommentOptions(banEmail: banEmail, banEmailDomain: banEmailDomain, banIP: banIP, deleteAllUsersComments: deleteAllUsersComments, bannedUntil: bannedUntil, isShadowBan: isShadowBan, updateId: updateId, banReason: banReason, sso: sso)) { (response, error) in
18 guard error == nil else {
19 print(error)
20 return
21 }
22
23 if (response) {
24 dump(response)
25 }
26}
27

postBanUserUndo Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是
ssostringquery否

回應

返回:APIEmptyResponse

範例

postBanUserUndo 範例
Copy Copy
1
2// 以下程式碼範例仍屬 beta 版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let banUserUndoParams = BanUserUndoParams(changelog: APIBanUserChangeLog(createdBannedUserId: "createdBannedUserId_example", updatedBannedUserId: "updatedBannedUserId_example", deletedBannedUsers: [APIBannedUser(id: "id_example", tenantId: "tenantId_example", userId: "userId_example", email: "email_example", username: "username_example", ipHash: "ipHash_example", createdAt: Date(), bannedByUserId: "bannedByUserId_example", bannedCommentText: "bannedCommentText_example", banType: "banType_example", bannedUntil: Date(), hasEmailWildcard: false, banReason: "banReason_example")], changedValuesBefore: APIBanUserChangedValues(id: "id_example", tenantId: "tenantId_example", userId: "userId_example", email: "email_example", username: "username_example", ipHash: "ipHash_example", createdAt: Date(), bannedByUserId: "bannedByUserId_example", bannedCommentText: "bannedCommentText_example", banType: "banType_example", bannedUntil: Date(), hasEmailWildcard: false, banReason: "banReason_example"))) // BanUserUndoParams |
7let sso = "sso_example" // String | (可選)
8
9ModerationAPI.postBanUserUndo(tenantId: tenantId, banUserUndoParams: banUserUndoParams, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

postBulkPreBanSummary Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
includeByUserIdAndEmailbooleanqueryNo
includeByIPbooleanqueryNo
includeByEmailDomainbooleanqueryNo
ssostringqueryNo

回應

Returns: BulkPreBanSummary

範例

postBulkPreBanSummary 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let bulkPreBanParams = BulkPreBanParams(commentIds: ["commentIds_example"]) // BulkPreBanParams |
7let includeByUserIdAndEmail = true // Bool | (可選)
8let includeByIP = true // Bool | (可選)
9let includeByEmailDomain = true // Bool | (可選)
10let sso = "sso_example" // String | (可選)
11
12ModerationAPI.postBulkPreBanSummary(tenantId: tenantId, bulkPreBanParams: bulkPreBanParams, options: ModerationAPI.PostBulkPreBanSummaryOptions(includeByUserIdAndEmail: includeByUserIdAndEmail, includeByIP: includeByIP, includeByEmailDomain: includeByEmailDomain, sso: sso)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

postCommentsByIds Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery是
ssostringquery否

回應

回傳: ModerationAPIChildCommentsResponse

範例

postCommentsByIds 範例
Copy Copy
1
2// 以下程式碼範例仍處於 beta 階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentsByIdsParams = CommentsByIdsParams(ids: ["ids_example"]) // CommentsByIdsParams |
7let sso = "sso_example" // String | (可選)
8
9ModerationAPI.postCommentsByIds(tenantId: tenantId, commentsByIdsParams: commentsByIdsParams, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

postFlagComment Internal Link

參數

名稱類型位置必填描述
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

回應

返回: APIEmptyResponse

範例

postFlagComment 範例
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 | (optional)
8let sso = "sso_example" // String | (optional)
9
10ModerationAPI.postFlagComment(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostFlagCommentOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

postRemoveComment Internal Link

參數

名稱類型位置必填說明
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

回應

回傳:PostRemoveCommentApiResponse

範例

postRemoveComment 示例
Copy Copy
1
2// 以下程式碼範例仍處於測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String | (可選)
8let sso = "sso_example" // String | (可選)
9
10ModerationAPI.postRemoveComment(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostRemoveCommentOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

postRestoreDeletedComment Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery是
commentIdstringpath是
broadcastIdstringquery否
ssostringquery否

回應

回傳: APIEmptyResponse

範例

postRestoreDeletedComment 範例
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 | (optional)
8let sso = "sso_example" // String | (optional)
9
10ModerationAPI.postRestoreDeletedComment(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostRestoreDeletedCommentOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

postSetCommentApprovalStatus Internal Link

Parameters

名稱類型位置必填說明
tenantIdstringquery是
commentIdstringpath是
approvedbooleanquery否
broadcastIdstringquery否
ssostringquery否

回應

返回:SetCommentApprovedResponse

範例

postSetCommentApprovalStatus 範例
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 approved = true // Bool | (可選)
8let broadcastId = "broadcastId_example" // String | (可選)
9let sso = "sso_example" // String | (可選)
10
11ModerationAPI.postSetCommentApprovalStatus(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostSetCommentApprovalStatusOptions(approved: approved, broadcastId: broadcastId, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

postSetCommentReviewStatus Internal Link

參數

名稱型別位置必填說明
tenantIdstringqueryYes
commentIdstringpathYes
reviewedbooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

回應

返回: APIEmptyResponse

範例

postSetCommentReviewStatus 範例
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 reviewed = true // Bool | (可選)
8let broadcastId = "broadcastId_example" // String | (可選)
9let sso = "sso_example" // String | (可選)
10
11ModerationAPI.postSetCommentReviewStatus(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostSetCommentReviewStatusOptions(reviewed: reviewed, broadcastId: broadcastId, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

postSetCommentSpamStatus Internal Link

參數

名稱類型位置必填說明
tenantIdstring查詢是
commentIdstring路徑是
spamboolean查詢否
permNotSpamboolean查詢否
broadcastIdstring查詢否
ssostring查詢否

回應

返回:APIEmptyResponse

範例

postSetCommentSpamStatus 範例
Copy Copy
1
2// 以下程式碼範例仍屬 beta。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let spam = true // Bool | (可選)
8let permNotSpam = true // Bool | (可選)
9let broadcastId = "broadcastId_example" // String | (可選)
10let sso = "sso_example" // String | (可選)
11
12ModerationAPI.postSetCommentSpamStatus(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostSetCommentSpamStatusOptions(spam: spam, permNotSpam: permNotSpam, broadcastId: broadcastId, sso: sso)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

postSetCommentText Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery是
commentIdstringpath是
broadcastIdstringquery否
ssostringquery否

回應

返回:SetCommentTextResponse

範例

postSetCommentText 範例
Copy Copy
1
2// 以下程式碼範例仍處於測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let setCommentTextParams = SetCommentTextParams(comment: "comment_example") // SetCommentTextParams |
8let broadcastId = "broadcastId_example" // String | (可選)
9let sso = "sso_example" // String | (可選)
10
11ModerationAPI.postSetCommentText(tenantId: tenantId, commentId: commentId, setCommentTextParams: setCommentTextParams, options: ModerationAPI.PostSetCommentTextOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

postUnFlagComment Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
commentIdstringpath是
broadcastIdstringquery否
ssostringquery否

回應

Returns: APIEmptyResponse

範例

postUnFlagComment 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String | (可選)
8let sso = "sso_example" // String | (可選)
9
10ModerationAPI.postUnFlagComment(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostUnFlagCommentOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

postVote Internal Link

Parameters

名稱類型位置必填說明
tenantIdstringquery是
commentIdstringpath是
directionstringquery否
broadcastIdstringquery否
ssostringquery否

Response

返回: VoteResponse

Example

postVote 範例
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 broadcastId = "broadcastId_example" // String | (可選)
9let sso = "sso_example" // String | (可選)
10
11ModerationAPI.postVote(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostVoteOptions(direction: direction, broadcastId: broadcastId, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

putAwardBadge Internal Link

參數

名稱類型位置必填說明
tenantIdstringqueryYes
badgeIdstringqueryYes
userIdstringqueryNo
commentIdstringqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

回應

返回:AwardUserBadgeResponse

範例

putAwardBadge 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let badgeId = "badgeId_example" // String |
7let userId = "userId_example" // String | (可選)
8let commentId = "commentId_example" // String | (可選)
9let broadcastId = "broadcastId_example" // String | (可選)
10let sso = "sso_example" // String | (可選)
11
12ModerationAPI.putAwardBadge(tenantId: tenantId, badgeId: badgeId, options: ModerationAPI.PutAwardBadgeOptions(userId: userId, commentId: commentId, broadcastId: broadcastId, sso: sso)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

putCloseThread Internal Link

參數

名稱類型位置必填說明
tenantIdstringqueryYes
urlIdstringqueryYes
ssostringqueryNo

回應

回傳: APIEmptyResponse

範例

putCloseThread 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let sso = "sso_example" // String | (可選)
8
9ModerationAPI.putCloseThread(tenantId: tenantId, urlId: urlId, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

putRemoveBadge Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery是
badgeIdstringquery是
userIdstringquery否
commentIdstringquery否
broadcastIdstringquery否
ssostringquery否

回應

返回:RemoveUserBadgeResponse

範例

putRemoveBadge 範例
Copy Copy
1
2// 以下程式碼範例仍屬於測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let badgeId = "badgeId_example" // String |
7let userId = "userId_example" // String | (可選)
8let commentId = "commentId_example" // String | (可選)
9let broadcastId = "broadcastId_example" // String | (可選)
10let sso = "sso_example" // String | (可選)
11
12ModerationAPI.putRemoveBadge(tenantId: tenantId, badgeId: badgeId, options: ModerationAPI.PutRemoveBadgeOptions(userId: userId, commentId: commentId, broadcastId: broadcastId, sso: sso)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

putReopenThread Internal Link

參數

名稱類型位置必填說明
tenantIdstringqueryYes
urlIdstringqueryYes
ssostringqueryNo

回應

回傳: APIEmptyResponse

範例

putReopenThread 範例
Copy Copy
1
2// 以下程式碼範例仍在測試階段。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let sso = "sso_example" // String | (可選)
8
9ModerationAPI.putReopenThread(tenantId: tenantId, urlId: urlId, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

setTrustFactor Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是
userIdstringquery否
trustFactorstringquery否
ssostringquery否

回應

返回:SetUserTrustFactorResponse

範例

setTrustFactor 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // 字串 |
6let userId = "userId_example" // 字串 | (可選)
7let trustFactor = "trustFactor_example" // 字串 | (可選)
8let sso = "sso_example" // 字串 | (可選)
9
10ModerationAPI.setTrustFactor(tenantId: tenantId, options: ModerationAPI.SetTrustFactorOptions(userId: userId, trustFactor: trustFactor, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

createModerator Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是

回應

回傳: CreateModeratorResponse

範例

createModerator 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如遇任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createModeratorBody = CreateModeratorBody(name: "name_example", email: "email_example", userId: "userId_example", moderationGroupIds: ["moderationGroupIds_example"]) // CreateModeratorBody |
7
8DefaultAPI.createModerator(tenantId: tenantId, createModeratorBody: createModeratorBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

deleteModerator Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery是
idstringpath是
sendEmailstringquery否

回應

回傳: APIEmptyResponse

範例

deleteModerator 範例
Copy Copy
1
2// 下列程式範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let sendEmail = "sendEmail_example" // String | (可選)
8
9DefaultAPI.deleteModerator(tenantId: tenantId, id: id, sendEmail: sendEmail) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getModerator Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是

回應

回傳: GetModeratorResponse

範例

getModerator 範例
Copy Copy
1
2// 下列程式範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getModerator(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getModerators Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery是
skipnumberquery否

回應

回傳: GetModeratorsResponse

範例

getModerators 範例
Copy Copy
1
2// 下列程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let skip = 987 // Double | (可選)
7
8DefaultAPI.getModerators(tenantId: tenantId, skip: skip) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

sendInvite Internal Link

參數

名稱型別位置必填說明
tenantIdstringquery是
idstringpath是
fromNamestringquery是

回應

回傳: APIEmptyResponse

範例

sendInvite 範例
Copy Copy
1
2// 以下程式碼範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let fromName = "fromName_example" // String |
8
9DefaultAPI.sendInvite(tenantId: tenantId, id: id, fromName: fromName) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

updateModerator Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是
idstringpath是

回應

回傳:APIEmptyResponse

範例

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

deleteNotificationCount Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是
idstringpath是

回應

回傳: APIEmptyResponse

範例

deleteNotificationCount 範例
Copy Copy
1
2// 下列程式碼範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // 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

getCachedNotificationCount Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是

回應

回傳: GetCachedNotificationCountResponse

範例

getCachedNotificationCount 範例
Copy Copy
1
2// 下列程式範例仍屬測試版。如遇任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getCachedNotificationCount(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getNotificationCount Internal Link

參數

名稱類型位置必填描述
tenantIdstringqueryYes
userIdstringqueryNo
urlIdstringqueryNo
fromCommentIdstringqueryNo
viewedbooleanqueryNo
typestringqueryNo

回應

返回:GetNotificationCountResponse

範例

getNotificationCount 範例
Copy Copy
1
2// 以下程式碼範例仍處於測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String | (可選)
7let urlId = "urlId_example" // String | (可選)
8let fromCommentId = "fromCommentId_example" // String | (可選)
9let viewed = true // Bool | (可選)
10let type = "type_example" // String | (可選)
11
12DefaultAPI.getNotificationCount(tenantId: tenantId, options: DefaultAPI.GetNotificationCountOptions(userId: userId, urlId: urlId, fromCommentId: fromCommentId, viewed: viewed, type: type)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

getNotifications Internal Link

參數

名稱類型位置必填說明
tenantIdstringqueryYes
userIdstringqueryNo
urlIdstringqueryNo
fromCommentIdstringqueryNo
viewedbooleanqueryNo
typestringqueryNo
skipnumberqueryNo

回應

返回:GetNotificationsResponse

範例

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, options: DefaultAPI.GetNotificationsOptions(userId: userId, urlId: urlId, fromCommentId: fromCommentId, viewed: viewed, type: type, skip: skip)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

updateNotification Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是
userIdstringquery否

回應

回傳: APIEmptyResponse

範例

updateNotification 範例
Copy Copy
1
2// 下列程式範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateNotificationBody = UpdateNotificationBody(viewed: false, optedOut: false) // UpdateNotificationBody |
8let userId = "userId_example" // String | (可選)
9
10DefaultAPI.updateNotification(tenantId: tenantId, id: id, updateNotificationBody: updateNotificationBody, userId: userId) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

createV1PageReact Internal Link

參數

名稱類型位置必填描述
tenantIdstringpathYes
urlIdstringqueryYes
titlestringqueryNo
ssostringqueryNo

回應

Returns: CreateV1PageReact

範例

createV1PageReact 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let title = "title_example" // String | (optional)
8let sso = "sso_example" // String | (optional)
9
10PublicAPI.createV1PageReact(tenantId: tenantId, urlId: urlId, options: PublicAPI.CreateV1PageReactOptions(title: title, 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

createV2PageReact Internal Link

參數

名稱類型位置必填說明
tenantIdstringpath是
urlIdstringquery是
idstringquery是
titlestringquery否
ssostringquery否

回應

返回: CreateV1PageReact

範例

createV2PageReact 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let id = "id_example" // String |
8let title = "title_example" // String | (可選)
9let sso = "sso_example" // String | (可選)
10
11PublicAPI.createV2PageReact(tenantId: tenantId, urlId: urlId, id: id, options: PublicAPI.CreateV2PageReactOptions(title: title, 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

deleteV1PageReact Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYes
ssostringqueryNo

回應

Returns: CreateV1PageReact

範例

deleteV1PageReact 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let sso = "sso_example" // String | (可選)
8
9PublicAPI.deleteV1PageReact(tenantId: tenantId, urlId: urlId, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

deleteV2PageReact Internal Link

參數

名稱類型位置必填描述
tenantIdstringpath是
urlIdstringquery是
idstringquery是
ssostringquery否

回應

返回:CreateV1PageReact

範例

deleteV2PageReact 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let id = "id_example" // String |
8let sso = "sso_example" // String | (可選)
9
10PublicAPI.deleteV2PageReact(tenantId: tenantId, urlId: urlId, id: id, 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

getV1PageLikes Internal Link

參數

名稱類型位置必填說明
tenantIdstringpathYes
urlIdstringqueryYes
ssostringqueryNo
includeUserInfostringqueryNo設定後,返回點讚此頁面的使用者(頭像與使用者名稱)。僅接受 "public",會省略私人個人檔案。

回應

返回:GetV1PageLikes

範例

getV1PageLikes 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let sso = "sso_example" // String | (optional)
8let includeUserInfo = PageReactIncludeUserInfo() // PageReactIncludeUserInfo | 設定後,返回點讚此頁面的使用者(頭像與使用者名稱)。僅接受 \"public\",會省略私人個人檔案。(optional)
9
10PublicAPI.getV1PageLikes(tenantId: tenantId, urlId: urlId, options: PublicAPI.GetV1PageLikesOptions(sso: sso, includeUserInfo: includeUserInfo)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getV2PageReacts Internal Link

參數

名稱類型位置必填說明
tenantIdstringpathYes
urlIdstringqueryYes
ssostringqueryNo
includeUserInfostringqueryNo設定後,返回每個 react id 的使用者(頭像和使用者名稱)。僅接受 "public",會省略私人個人檔案。

回應

返回:GetV2PageReacts

範例

getV2PageReacts 範例
Copy Copy
1
2// 以下程式碼範例仍屬於測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let sso = "sso_example" // String | (optional)
8let includeUserInfo = PageReactIncludeUserInfo() // PageReactIncludeUserInfo | 設定後,返回每個 react id 的使用者(頭像和使用者名稱)。僅接受 \"public\",會省略私人個人檔案。 (optional)
9
10PublicAPI.getV2PageReacts(tenantId: tenantId, urlId: urlId, options: PublicAPI.GetV2PageReactsOptions(sso: sso, includeUserInfo: includeUserInfo)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getV2PageReactUsers Internal Link

參數

名稱類型位置必填說明
tenantIdstringpathYes
urlIdstringqueryYes
idstringqueryYes
ssostringqueryNo

回應

返回:GetV2PageReactUsersResponse

範例

getV2PageReactUsers 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let id = "id_example" // String |
8let sso = "sso_example" // String | (可選)
9
10PublicAPI.getV2PageReactUsers(tenantId: tenantId, urlId: urlId, id: id, 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

addPage Internal Link

參數

名稱類型位置必填說明
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

deletePage Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是

回傳

Returns: 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

getOfflineUsers Internal Link

過去曾在頁面上留言但目前不在線上的留言者。按 displayName 排序。 在用完 /users/online 之後,使用此端點來渲染「成員」區塊。 以 commenterName 進行游標分頁:伺服器透過 $gt 從 afterName 開始,沿著部分索引 {tenantId, urlId, commenterName} 向後走,沒有 $skip 的成本。

參數

名稱類型位置必填說明
tenantIdstringpath是
urlIdstringquery是頁面 URL 識別碼(由伺服器端清理)。
afterNamestringquery否游標:傳入上一個回應中的 nextAfterName。
afterUserIdstringquery否游標決勝依據:傳入上一個回應中的 nextAfterUserId。當設定 afterName 時為必填,以避免同名時遺漏項目。

回應

回傳:PageUsersOfflineResponse

範例

getOfflineUsers 範例
Copy Copy
1
2// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String | 頁面 URL 識別碼(由伺服器端清理)。
7let afterName = "afterName_example" // String | 游標:傳入上一個回應中的 nextAfterName。(optional)
8let afterUserId = "afterUserId_example" // String | 游標決勝依據:傳入上一個回應中的 nextAfterUserId。當設定 afterName 時為必填,以避免同名時遺漏項目。(optional)
9
10PublicAPI.getOfflineUsers(tenantId: tenantId, urlId: urlId, options: PublicAPI.GetOfflineUsersOptions(afterName: afterName, afterUserId: afterUserId)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getOnlineUsers Internal Link

目前在線的頁面檢視者:指目前已訂閱該頁面的 websocket 會話使用者。
返回 anonCount + totalCount(全房間訂閱者,包括我們未列舉的匿名檢視者)。

參數

名稱類型位置必填描述
tenantIdstringpathYes
urlIdstringqueryYes頁面 URL 識別碼(在伺服器端清理)。
afterNamestringqueryNo游標:傳入先前回應中的 nextAfterName。
afterUserIdstringqueryNo游標平手時的分割條件:傳入先前回應中的 nextAfterUserId。當設定 afterName 時必填,以避免因名稱相同而遺漏項目。

回應

返回: PageUsersOnlineResponse

範例

取得線上使用者 範例
Copy Copy
1
2// 以下程式碼範例仍處於測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String | 頁面 URL 識別碼(在伺服器端清理)。
7let afterName = "afterName_example" // String | 游標:傳入先前回應中的 nextAfterName。(可選)
8let afterUserId = "afterUserId_example" // String | 游標平手時的分割條件:傳入先前回應中的 nextAfterUserId。當設定 afterName 時必填,以避免因名稱相同而遺漏項目。(可選)
9
10PublicAPI.getOnlineUsers(tenantId: tenantId, urlId: urlId, options: PublicAPI.GetOnlineUsersOptions(afterName: afterName, afterUserId: afterUserId)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getPageByURLId Internal Link

參數

名稱Type位置必填描述
tenantIdstring查詢是
urlIdstring查詢是

回應

返回: GetPageByURLIdAPIResponse

範例

getPageByURLId 範例
Copy Copy
1
2// 以下程式碼範例仍為 beta。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
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

getPageLikes Internal Link

頁面的讚數,可選擇包含按讚的使用者。

參數

名稱類型位置必填描述
tenantIdstringqueryYes
urlIdstringqueryYes
includeUserInfostringqueryNo"public" 省略具有私人資料的使用者,"include-private" 包含他們。

回應

返回:GetPageLikesAPIResponse

範例

getPageLikes 範例
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 includeUserInfo = PageReactIncludeUserInfo() // PageReactIncludeUserInfo | \"public\" 省略具有私人資料的使用者,\"include-private\" 包含他們。 (可選)
8
9DefaultAPI.getPageLikes(tenantId: tenantId, urlId: urlId, includeUserInfo: includeUserInfo) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getPageReacts Internal Link

自訂頁面的反應計數,可選擇包含做出反應的使用者。

參數

名稱類型位置必填說明
tenantIdstringquery是
urlIdstringquery是
includeUserInfostringquery否"public" 會省略私人個人資料的使用者,"include-private" 則會包含他們。

回應

回傳:GetPageReactsAPIResponse

範例

getPageReacts 範例
Copy Copy
1
2// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let includeUserInfo = PageReactIncludeUserInfo() // PageReactIncludeUserInfo | \"public\" 會省略私人個人資料的使用者,\"include-private\" 則會包含他們。(optional)
8
9DefaultAPI.getPageReacts(tenantId: tenantId, urlId: urlId, includeUserInfo: includeUserInfo) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getPages Internal Link

參數

名稱型別位置必填描述
tenantIdstringquery是

回應

回傳: GetPagesAPIResponse

範例

getPages 範例
Copy Copy
1
2// 下列程式碼範例仍為測試版。若發現任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
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

getPagesPublic Internal Link

列出租戶的頁面。由 FChat 桌面用戶端用來填入其房間清單。 每個頁面的已解析自訂設定中必須將 enableFChat 設為 true。 需要 SSO 的頁面會根據請求使用者的群組存取權限進行篩選。

參數

名稱類型位置必填說明
tenantIdstringpath是
cursorstringquery否由先前請求以 nextCursor 回傳的不透明分頁游標。與相同的 sortBy 綁定。
limitintegerquery否1..200,預設 50
qstringquery否選用的不區分大小寫標題前綴篩選器。
sortBystringquery否排序方式。updatedAt(預設,最新在前)、commentCount(留言數最多在前)或 title(依字母順序)。
hasCommentsbooleanquery否若為 true,僅回傳至少有一則留言的頁面。

回應

回傳:GetPublicPagesResponse

範例

getPagesPublic 範例
Copy Copy
1
2// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let cursor = "cursor_example" // String | 由先前請求以 `nextCursor` 回傳的不透明分頁游標。與相同的 `sortBy` 綁定。 (optional)
7let limit = 987 // Int | 1..200,預設 50 (optional)
8let q = "q_example" // String | 選用的不區分大小寫標題前綴篩選器。 (optional)
9let sortBy = PagesSortBy() // PagesSortBy | 排序方式。`updatedAt`(預設,最新在前)、`commentCount`(留言數最多在前)或 `title`(依字母順序)。 (optional)
10let hasComments = true // Bool | 若為 true,僅回傳至少有一則留言的頁面。 (optional)
11
12PublicAPI.getPagesPublic(tenantId: tenantId, options: PublicAPI.GetPagesPublicOptions(cursor: cursor, limit: limit, q: q, sortBy: sortBy, hasComments: hasComments)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

getUsersInfo Internal Link

批次取得租戶的使用者資訊。給定 userIds,回傳來自 User / SSOUser 的顯示資訊。 由評論小工具使用,以補充剛透過 presence 事件出現的使用者資訊。 無頁面上下文:隱私會統一強制執行(私人檔案會被遮蔽)。

參數

名稱類型位置必填說明
tenantIdstringpath是
idsstringquery是逗號分隔的 userIds。

回應

回傳:PageUsersInfoResponse

範例

getUsersInfo 範例
Copy Copy
1
2// 下列程式碼範例仍為測試版。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let ids = "ids_example" // String | 以逗號分隔的 userIds。
7
8PublicAPI.getUsersInfo(tenantId: tenantId, ids: ids) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

migratePages Internal Link

將批次工作排入佇列,將留言、頁面及相關記錄從一個 urlId 或網域遷移到另一個。 「urlId」遷移僅比對完全相同的 urlId。「domain」遷移會在每個 urlId 與 url 中進行尋找/取代。 輪詢 GET /api/v1/batch-jobs/{batchJobId}:完成後會包含每次遷移的結果與 undoId。

參數

名稱類型位置必填說明
tenantIdstringquery是

回應

回傳:QueuePageMigrationJobAPIResponse

範例

migratePages 範例
Copy Copy
1
2// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let migrateAPIPagesData = MigrateAPIPagesData(migrations: [PageMigration(from: "from_example", to: "to_example", type: PageMigrationType())]) // MigrateAPIPagesData |
7
8DefaultAPI.migratePages(tenantId: tenantId, migrateAPIPagesData: migrateAPIPagesData) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

patchPage 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

undoPageMigrations Internal Link

排程一個批次工作,以最新的為先,逆向還原單一 migrate-pages 工作的所有遷移。可保留 90 天。
遷移後變更的記錄將保持不變,因而不會被後續編輯覆寫。
輪詢 GET /api/v1/batch-jobs/{batchJobId} 以取得已還原/已跳過的計數。

參數

名稱類型位置必填說明
tenantIdstringqueryYes
undoIdstringpathYes

回應

返回:QueuePageMigrationJobAPIResponse

範例

undoPageMigrations 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let undoId = "undoId_example" // String |
7
8DefaultAPI.undoPageMigrations(tenantId: tenantId, undoId: undoId) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

deletePendingWebhookEvent Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery是
idstringpath是

回應

回傳: APIEmptyResponse

範例

deletePendingWebhookEvent 範例
Copy Copy
1
2// 以下範例程式碼仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // 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

getPendingWebhookEventCount Internal Link

參數

名稱類型位置必填說明
tenantIdstringqueryYes
commentIdstringqueryNo
externalIdstringqueryNo
eventTypestringqueryNo
typestringqueryNo
domainstringqueryNo
attemptCountGTnumberqueryNo

回應

回傳:GetPendingWebhookEventCountResponse

範例

getPendingWebhookEventCount 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String | (optional) -> // String | (可選)
7let externalId = "externalId_example" // String | (optional) -> // String | (可選)
8let eventType = "eventType_example" // String | (optional) -> // String | (可選)
9let type = "type_example" // String | (optional) -> // String | (可選)
10let domain = "domain_example" // String | (optional) -> // String | (可選)
11let attemptCountGT = 987 // Double | (optional) -> // Double | (可選)
12
13DefaultAPI.getPendingWebhookEventCount(tenantId: tenantId, options: DefaultAPI.GetPendingWebhookEventCountOptions(commentId: commentId, externalId: externalId, eventType: eventType, type: type, domain: domain, attemptCountGT: attemptCountGT)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

getPendingWebhookEvents Internal Link

參數

名稱類型位置必要描述
tenantIdstringqueryYes
commentIdstringqueryNo
externalIdstringqueryNo
eventTypestringqueryNo
typestringqueryNo
domainstringqueryNo
attemptCountGTnumberqueryNo
skipnumberqueryNo

回應

返回:GetPendingWebhookEventsResponse

範例

getPendingWebhookEvents 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String | (可選)
7let externalId = "externalId_example" // String | (可選)
8let eventType = "eventType_example" // String | (可選)
9let type = "type_example" // String | (可選)
10let domain = "domain_example" // String | (可選)
11let attemptCountGT = 987 // Double | (可選)
12let skip = 987 // Double | (可選)
13
14DefaultAPI.getPendingWebhookEvents(tenantId: tenantId, options: DefaultAPI.GetPendingWebhookEventsOptions(commentId: commentId, externalId: externalId, eventType: eventType, type: type, domain: domain, attemptCountGT: attemptCountGT, skip: skip)) { (response, error) in
15 guard error == nil else {
16 print(error)
17 return
18 }
19
20 if (response) {
21 dump(response)
22 }
23}
24

createPollVote Internal Link

在投票中記錄一票,或將已存在的投票移動到其他選項。每位投票者在每個投票中最多只能投一票,因此再次呼叫此 API 時,會將該投票者的投票移動,而不是新增一票。

這會遵守網站的投票設定:如果投票僅限已登入使用者,僅提供 anonUserId 的投票將被拒絕,且匿名投票會依每個 IP 每個投票進行速率限制。

Parameters

名稱類型位置必填說明
tenantIdstringquery是

Response

回傳:CreatePollVoteResponse

Example

createPollVote 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createPollVoteBody = CreatePollVoteBody(commentId: "commentId_example", optionId: "optionId_example", userId: "userId_example", anonUserId: "anonUserId_example", ip: "ip_example") // CreatePollVoteBody |
7
8DefaultAPI.createPollVote(tenantId: tenantId, createPollVoteBody: createPollVoteBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

deletePollVote Internal Link

Retract a vote. The option it was cast on gives its tally back.

參數

名稱類型位置必填說明
tenantIdstringquery是
idstringpath是

回應

Returns: DeletePollVoteResponse

範例

deletePollVote 範例
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.deletePollVote(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

getPollVote Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是
idstringpath是

回應

返回:GetPollVoteResponse

範例

getPollVote 範例
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.getPollVote(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

getPollVotes Internal Link

單一投票統計背後的個別投票紀錄,由舊到新排列。

投票屬於某則留言,因此投票紀錄一次只能讀取一個投票 - commentId 為必填。這樣可確保每個查詢都使用集合既有的索引。

遵循投票的隱私設定:匿名投票的投票紀錄無法讀取(poll-anonymous),無論是透過此端點或依 id 查詢皆然。

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringqueryYes
voterIdstringqueryNo
optionIdstringqueryNo
skipintegerqueryNo

Response

回傳:GetPollVotesResponse

Example

getPollVotes 範例
Copy Copy
1
2// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let voterId = "voterId_example" // String | (optional)
8let optionId = "optionId_example" // String | (optional)
9let skip = 987 // Int | (optional)
10
11DefaultAPI.getPollVotes(tenantId: tenantId, commentId: commentId, options: DefaultAPI.GetPollVotesOptions(voterId: voterId, optionId: optionId, 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

deletePoll Internal Link

從其評論中移除投票,並刪除所有已投的票。評論本身保持不變。

Parameters

名稱類型位置必填描述
tenantIdstringquery是
commentIdstringpath是

Response

Returns: APIEmptyResponse

Example

deletePoll 範例
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 |
7
8DefaultAPI.deletePoll(tenantId: tenantId, commentId: commentId) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getPoll Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是
commentIdstringpath是

回應

返回: GetPollResponse

範例

getPoll 範例
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 |
7
8DefaultAPI.getPoll(tenantId: tenantId, commentId: commentId) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getPollVoters Internal Link

Who voted for which option. Anonymous polls never answer, admins-only polls answer only for an admin or moderator.

參數

名稱類型位置必填說明
tenantIdstringpathYes
commentIdstringpathYes
urlIdstringqueryNo
pageintegerqueryNo
searchstringqueryNo
ssostringqueryNo

回應

Returns: GetPollVoterNamesSuccessResponse

範例

getPollVoters 範例
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 page = 987 // Int | (可選)
9let search = "search_example" // String | (可選)
10let sso = "sso_example" // String | (可選)
11
12PublicAPI.getPollVoters(tenantId: tenantId, commentId: commentId, options: PublicAPI.GetPollVotersOptions(urlId: urlId, page: page, search: search, 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

patchPoll Internal Link

原地編輯投票並保留其票數統計:變更問題、重新標記選項、關閉或重新開啟投票,或變更誰可以查看投票者。選項以 id 定位 - 若要新增、移除或重新排序選項,請 PUT 完整清單。

參數

名稱類型位置必填說明
tenantIdstringquery是
commentIdstringpath是

回應

回傳:SavePollResponse

範例

patchPoll 範例
Copy Copy
1
2// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let commentPollPatch = CommentPollPatch(question: "question_example", options: [CommentPollPatch_options_inner(label: "label_example", id: "id_example")], closesAt: "closesAt_example", privacy: 123, requireVoteToSeeResults: false) // CommentPollPatch |
8
9DefaultAPI.patchPoll(tenantId: tenantId, commentId: commentId, commentPollPatch: commentPollPatch) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

putPoll Internal Link

將投票附加到評論,或設定其已存在投票的完整狀態。

選項會依據 id 進行匹配:若傳送的選項帶有既有選項的 id,則保留其投票(並採用新的標籤與位置);若傳送的選項未帶 id,則會新增;而在列表中省略的既有選項則會被移除,連同其已投的票一起刪除。

在已有投票的投票中若不保留任何既有選項的 id,會刪除所有選項,因此需要將 replaceVotes 設為 true。

參數

名稱類型位置必填說明
tenantIdstringqueryYes
commentIdstringpathYes
replaceVotesbooleanqueryNo

回應

返回:SavePollResponse

範例

putPoll 範例
Copy Copy
1
2// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let commentPollPutInput = CommentPollPutInput(question: "question_example", options: [CommentPollOptionInput(id: "id_example", label: "label_example")], closesAt: "closesAt_example", privacy: 123, requireVoteToSeeResults: false) // CommentPollPutInput |
8let replaceVotes = true // Bool | (optional)
9
10DefaultAPI.putPoll(tenantId: tenantId, commentId: commentId, commentPollPutInput: commentPollPutInput, replaceVotes: replaceVotes) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

votePoll Internal Link

參數

名稱類型位置必填說明
tenantIdstringpath是
commentIdstringpath是
urlIdstringquery否
broadcastIdstringquery否
ssostringquery否

回應

返回:VotePollResponse

範例

votePoll 範例
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 votePollBody = VotePollBody(optionId: "optionId_example") // VotePollBody |
8let urlId = "urlId_example" // String | (可選)
9let broadcastId = "broadcastId_example" // String | (可選)
10let sso = "sso_example" // String | (可選)
11
12PublicAPI.votePoll(tenantId: tenantId, commentId: commentId, votePollBody: votePollBody, options: PublicAPI.VotePollOptions(urlId: urlId, 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

createQuestionConfig Internal Link

參數

名稱類型位置必填說明
tenantIdstringqueryYes

回應

返回: CreateQuestionConfigResponse

範例

createQuestionConfig 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createQuestionConfigBody = CreateQuestionConfigBody(name: "name_example", question: "question_example", helpText: "helpText_example", type: "type_example", numStars: 123, min: 123, max: 123, defaultValue: 123, labelNegative: "labelNegative_example", labelPositive: "labelPositive_example", customOptions: [QuestionConfig_customOptions_inner(imageSrc: "imageSrc_example", name: "name_example")], subQuestionIds: ["subQuestionIds_example"], alwaysShowSubQuestions: false, subQuestionConditions: [SubQuestionCondition(_operator: QuestionConditionOperator(), value: 123, subQuestionId: "subQuestionId_example")], commentBoxCondition: QuestionCondition(_operator: nil, value: 123), commentBoxPrompt: "commentBoxPrompt_example", 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

deleteQuestionConfig Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是

回應

回傳: APIEmptyResponse

範例

deleteQuestionConfig 範例
Copy Copy
1
2// 下列程式範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.deleteQuestionConfig(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getQuestionConfig Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是

回應

回傳: GetQuestionConfigResponse

範例

getQuestionConfig 範例
Copy Copy
1
2// 下列程式範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getQuestionConfig(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getQuestionConfigs Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是
skipnumberquery否

回應

回傳: GetQuestionConfigsResponse

範例

getQuestionConfigs 範例
Copy Copy
1
2// 下列程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let skip = 987 // Double | (可選)
7
8DefaultAPI.getQuestionConfigs(tenantId: tenantId, skip: skip) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

updateQuestionConfig Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery是
idstringpath是

回應

返回:APIEmptyResponse

範例

updateQuestionConfig 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateQuestionConfigBody = UpdateQuestionConfigBody(name: "name_example", question: "question_example", helpText: "helpText_example", type: "type_example", numStars: 123, min: 123, max: 123, defaultValue: 123, labelNegative: "labelNegative_example", labelPositive: "labelPositive_example", customOptions: [QuestionConfig_customOptions_inner(imageSrc: "imageSrc_example", name: "name_example")], subQuestionIds: ["subQuestionIds_example"], alwaysShowSubQuestions: false, subQuestionConditions: [SubQuestionCondition(_operator: QuestionConditionOperator(), value: 123, subQuestionId: "subQuestionId_example")], commentBoxCondition: QuestionCondition(_operator: nil, value: 123), commentBoxPrompt: "commentBoxPrompt_example", 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

createQuestionResult Internal Link

參數

名稱類型位置必填說明
tenantIdstringqueryYes

回應

回傳:CreateQuestionResultResponse

範例

createQuestionResult 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createQuestionResultBody = CreateQuestionResultBody(urlId: "urlId_example", value: 123, values: [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

deleteQuestionResult Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

回應

回傳: APIEmptyResponse

範例

deleteQuestionResult 範例
Copy Copy
1
2// 下列程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.deleteQuestionResult(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getQuestionResult Internal Link

參數

名稱類型位置必需描述
tenantIdstringquery是
idstringpath是

回應

回傳: GetQuestionResultResponse

範例

getQuestionResult 範例
Copy Copy
1
2// 下列程式範例仍為測試版本。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getQuestionResult(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getQuestionResults Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是
urlIdstringquery否
userIdstringquery否
startDatestringquery否
questionIdstringquery否
questionIdsstringquery否
skipnumberquery否

回應

返回:GetQuestionResultsResponse

範例

getQuestionResults 範例
Copy Copy
1
2// 以下程式碼範例仍處於測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String | (可選)
7let userId = "userId_example" // String | (可選)
8let startDate = "startDate_example" // String | (可選)
9let questionId = "questionId_example" // String | (可選)
10let questionIds = "questionIds_example" // String | (可選)
11let skip = 987 // Double | (可選)
12
13DefaultAPI.getQuestionResults(tenantId: tenantId, options: DefaultAPI.GetQuestionResultsOptions(urlId: urlId, userId: userId, startDate: startDate, questionId: questionId, questionIds: questionIds, skip: skip)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

updateQuestionResult Internal Link

參數

名稱類型位置必填說明
tenantIdstringqueryYes
idstringpathYes

回應

返回:APIEmptyResponse

範例

updateQuestionResult 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateQuestionResultBody = UpdateQuestionResultBody(urlId: "urlId_example", anonUserId: "anonUserId_example", userId: "userId_example", value: 123, values: [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

aggregateQuestionResults Internal Link

參數

名稱類型位置必填描述
tenantIdstringqueryYes
questionIdstringqueryNo
questionIdsarrayqueryNo
urlIdstringqueryNo
timeBucketstringqueryNo
startDatestringqueryNo
forceRecalculatebooleanqueryNo

回應

返回:AggregateQuestionResultsResponse

範例

aggregateQuestionResults 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let questionId = "questionId_example" // String | (可選)
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, options: DefaultAPI.AggregateQuestionResultsOptions(questionId: questionId, questionIds: questionIds, urlId: urlId, timeBucket: timeBucket, startDate: startDate, forceRecalculate: forceRecalculate)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

bulkAggregateQuestionResults Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是
forceRecalculatebooleanquery否

回應

回傳: BulkAggregateQuestionResultsResponse

範例

bulkAggregateQuestionResults 範例
Copy Copy
1
2// 下列程式範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let bulkAggregateQuestionResultsRequest = BulkAggregateQuestionResultsRequest(aggregations: [BulkAggregateQuestionItem(aggId: "aggId_example", questionId: "questionId_example", questionIds: ["questionIds_example"], urlId: "urlId_example", timeBucket: AggregateTimeBucket(), startDate: Date())]) // BulkAggregateQuestionResultsRequest |
7let forceRecalculate = true // Bool | (可選)
8
9DefaultAPI.bulkAggregateQuestionResults(tenantId: tenantId, bulkAggregateQuestionResultsRequest: bulkAggregateQuestionResultsRequest, forceRecalculate: forceRecalculate) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

combineCommentsWithQuestionResults Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery是
questionIdstringquery否
questionIdsarrayquery否
urlIdstringquery否
startDatestringquery否
forceRecalculatebooleanquery否
minValuenumberquery否
maxValuenumberquery否
limitnumberquery否

回應

返回: CombineQuestionResultsWithCommentsResponse

範例

combineCommentsWithQuestionResults 範例
Copy Copy
1
2// 以下程式碼範例仍處於測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let questionId = "questionId_example" // String | (可選)
7let questionIds = ["inner_example"] // [String] | (可選)
8let urlId = "urlId_example" // String | (可選)
9let startDate = Date() // Date | (可選)
10let forceRecalculate = true // Bool | (可選)
11let minValue = 987 // Double | (可選)
12let maxValue = 987 // Double | (可選)
13let limit = 987 // Double | (可選)
14
15DefaultAPI.combineCommentsWithQuestionResults(tenantId: tenantId, options: DefaultAPI.CombineCommentsWithQuestionResultsOptions(questionId: questionId, questionIds: questionIds, urlId: urlId, startDate: startDate, forceRecalculate: forceRecalculate, minValue: minValue, maxValue: maxValue, limit: limit)) { (response, error) in
16 guard error == nil else {
17 print(error)
18 return
19 }
20
21 if (response) {
22 dump(response)
23 }
24}
25

addSSOUser Internal Link

參數

名稱類型位置必填說明
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

deleteSSOUser Internal Link

參數

名稱類型位置必填說明
tenantIdstringqueryYes
idstringpathYes
deleteCommentsbooleanqueryNo
commentDeleteModestringqueryNo

回應

返回: 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, options: DefaultAPI.DeleteSSOUserOptions(deleteComments: deleteComments, commentDeleteMode: commentDeleteMode)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getSSOUserByEmail Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
emailstringpathYes

回應

回傳: 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

getSSOUserById 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

getSSOUsers Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
skipintegerquery否

回傳

傳回: GetSSOUsersResponse

範例

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

patchSSOUser Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
updateCommentsbooleanqueryNo

回應

回傳: 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 | (選用)
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

putSSOUser Internal Link

參數

名稱類型位置必填描述
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

createSubscription Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是

回應

回傳:CreateSubscriptionAPIResponse

範例

createSubscription 範例
Copy Copy
1
2// 以下程式範例仍為 Beta 版本。若有任何問題,請透過 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

deleteSubscription 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

getSubscriptions Internal Link

參數

名稱類型位置必填描述
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

updateSubscription Internal Link

參數

名稱類型位置必要描述
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

getTenantDailyUsages Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是
yearNumbernumberquery否
monthNumbernumberquery否
dayNumbernumberquery否
skipnumberquery否

回應

回傳:GetTenantDailyUsagesResponse

範例

getTenantDailyUsages 範例
Copy Copy
1
2// 以下程式碼範例仍處於測試階段。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let yearNumber = 987 // Double | (可選)
7let monthNumber = 987 // Double | (可選)
8let dayNumber = 987 // Double | (可選)
9let skip = 987 // Double | (可選)
10
11DefaultAPI.getTenantDailyUsages(tenantId: tenantId, options: DefaultAPI.GetTenantDailyUsagesOptions(yearNumber: yearNumber, monthNumber: monthNumber, dayNumber: dayNumber, skip: skip)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

createTenantPackage Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery是

回應

回傳: CreateTenantPackageResponse

範例

createTenantPackage 範例
Copy Copy
1
2// 以下程式範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createTenantPackageBody = CreateTenantPackageBody(name: "name_example", monthlyCostUSD: 123, yearlyCostUSD: 123, monthlyStripePlanId: "monthlyStripePlanId_example", yearlyStripePlanId: "yearlyStripePlanId_example", maxMonthlyPageLoads: 123, maxMonthlyAPICredits: 123, maxMonthlySmallWidgetsCredits: 123, maxMonthlyComments: 123, maxConcurrentUsers: 123, maxTenantUsers: 123, maxSSOUsers: 123, maxModerators: 123, maxDomains: 123, maxWhiteLabeledTenants: 123, maxMonthlyEventLogRequests: 123, maxCustomCollectionSize: 123, hasWhiteLabeling: false, hasDebranding: false, hasLLMSpamDetection: false, forWhoText: "forWhoText_example", featureTaglines: ["featureTaglines_example"], hasAuditing: false, hasFlexPricing: false, enableSAML: false, flexPageLoadCostCents: 123, flexPageLoadUnit: 123, flexCommentCostCents: 123, flexCommentUnit: 123, flexSSOUserCostCents: 123, flexSSOUserUnit: 123, flexAPICreditCostCents: 123, flexAPICreditUnit: 123, flexSmallWidgetsCreditCostCents: 123, flexSmallWidgetsCreditUnit: 123, flexModeratorCostCents: 123, flexModeratorUnit: 123, flexAdminCostCents: 123, flexAdminUnit: 123, flexDomainCostCents: 123, flexDomainUnit: 123, flexLLMCostCents: 123, flexLLMUnit: 123, flexMinimumCostCents: 123, flexManagedTenantCostCents: 123, flexSSOAdminCostCents: 123, flexSSOAdminUnit: 123, flexSSOModeratorCostCents: 123, flexSSOModeratorUnit: 123) // CreateTenantPackageBody |
7
8DefaultAPI.createTenantPackage(tenantId: tenantId, createTenantPackageBody: createTenantPackageBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

deleteTenantPackage Internal Link

參數

名稱類型位置必要說明
tenantIdstringquery是
idstringpath是

回應

回傳: APIEmptyResponse

範例

deleteTenantPackage 範例
Copy Copy
1
2// 下列程式碼範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.deleteTenantPackage(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getTenantPackage Internal Link

參數

名稱類型位置必填說明
tenantIdstringqueryYes
idstringpathYes

回應

回傳: GetTenantPackageResponse

範例

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

getTenantPackages Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是
skipnumberquery否

回應

回傳: GetTenantPackagesResponse

範例

getTenantPackages 範例
Copy Copy
1
2// 下列程式碼範例仍處於測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let skip = 987 // Double | (可選)
7
8DefaultAPI.getTenantPackages(tenantId: tenantId, skip: skip) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

replaceTenantPackage Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是

回應

回傳:APIEmptyResponse

範例

replaceTenantPackage 範例
Copy Copy
1
2// 以下程式範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let replaceTenantPackageBody = ReplaceTenantPackageBody(name: "name_example", monthlyCostUSD: 123, yearlyCostUSD: 123, maxMonthlyPageLoads: 123, maxMonthlyAPICredits: 123, maxMonthlyComments: 123, maxConcurrentUsers: 123, maxTenantUsers: 123, maxSSOUsers: 123, maxModerators: 123, maxDomains: 123, maxCustomCollectionSize: 123, hasDebranding: false, forWhoText: "forWhoText_example", featureTaglines: ["featureTaglines_example"], hasFlexPricing: false, flexPageLoadCostCents: 123, flexPageLoadUnit: 123, flexCommentCostCents: 123, flexCommentUnit: 123, flexSSOUserCostCents: 123, flexSSOUserUnit: 123, flexAPICreditCostCents: 123, flexAPICreditUnit: 123, flexModeratorCostCents: 123, flexModeratorUnit: 123, flexAdminCostCents: 123, flexAdminUnit: 123, flexDomainCostCents: 123, flexDomainUnit: 123, flexMinimumCostCents: 123) // ReplaceTenantPackageBody |
8
9DefaultAPI.replaceTenantPackage(tenantId: tenantId, id: id, replaceTenantPackageBody: replaceTenantPackageBody) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

updateTenantPackage Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是

回應

回傳: APIEmptyResponse

範例

updateTenantPackage 範例
Copy Copy
1
2// 下列程式範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateTenantPackageBody = UpdateTenantPackageBody(name: "name_example", monthlyCostUSD: 123, yearlyCostUSD: 123, maxMonthlyPageLoads: 123, maxMonthlyAPICredits: 123, maxMonthlyComments: 123, maxConcurrentUsers: 123, maxTenantUsers: 123, maxSSOUsers: 123, maxModerators: 123, maxDomains: 123, maxCustomCollectionSize: 123, hasDebranding: false, hasWhiteLabeling: false, forWhoText: "forWhoText_example", featureTaglines: ["featureTaglines_example"], hasFlexPricing: false, flexPageLoadCostCents: 123, flexPageLoadUnit: 123, flexCommentCostCents: 123, flexCommentUnit: 123, flexSSOUserCostCents: 123, flexSSOUserUnit: 123, flexAPICreditCostCents: 123, flexAPICreditUnit: 123, flexModeratorCostCents: 123, flexModeratorUnit: 123, flexAdminCostCents: 123, flexAdminUnit: 123, flexDomainCostCents: 123, flexDomainUnit: 123, flexMinimumCostCents: 123) // UpdateTenantPackageBody |
8
9DefaultAPI.updateTenantPackage(tenantId: tenantId, id: id, updateTenantPackageBody: updateTenantPackageBody) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

createTenantUser Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是

回應

回傳: CreateTenantUserResponse

範例

createTenantUser 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createTenantUserBody = CreateTenantUserBody(username: "username_example", email: "email_example", displayName: "displayName_example", websiteUrl: "websiteUrl_example", signUpDate: 123, locale: "locale_example", verified: false, loginCount: 123, optedInNotifications: false, optedInTenantNotifications: false, hideAccountCode: false, avatarSrc: "avatarSrc_example", isHelpRequestAdmin: false, isAccountOwner: false, isAdminAdmin: false, isBillingAdmin: false, isAnalyticsAdmin: false, isCustomizationAdmin: false, isManageDataAdmin: false, isCommentModeratorAdmin: false, isAPIAdmin: false, moderatorIds: ["moderatorIds_example"], digestEmailFrequency: 123, displayLabel: "displayLabel_example") // CreateTenantUserBody |
7
8DefaultAPI.createTenantUser(tenantId: tenantId, createTenantUserBody: createTenantUserBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

deleteTenantUser Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery是
idstringpath是
deleteCommentsstringquery否
commentDeleteModestringquery否

回應

返回:APIEmptyResponse

範例

deleteTenantUser 範例
Copy Copy
1
2// 以下程式碼範例仍屬 beta 版。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let deleteComments = "deleteComments_example" // String | (optional)
8let commentDeleteMode = "commentDeleteMode_example" // String | (optional)
9
10DefaultAPI.deleteTenantUser(tenantId: tenantId, id: id, options: DefaultAPI.DeleteTenantUserOptions(deleteComments: deleteComments, commentDeleteMode: commentDeleteMode)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getTenantUser Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是
idstringpath是

回應

回傳:GetTenantUserResponse

範例

getTenantUser 範例
Copy Copy
1
2// 以下程式碼範例仍為測試版本。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getTenantUser(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getTenantUsers Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是
skipnumberquery否

回應

回傳: GetTenantUsersResponse

範例

getTenantUsers 範例
Copy Copy
1
2// 下列程式碼範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let skip = 987 // Double | (可選)
7
8DefaultAPI.getTenantUsers(tenantId: tenantId, skip: skip) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

replaceTenantUser Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是
updateCommentsstringquery否

回應

回傳: APIEmptyResponse

範例

replaceTenantUser 範例
Copy Copy
1
2// 以下程式碼範例仍為 Beta。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let 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否

回應

回傳:APIEmptyResponse

範例

sendLoginLink 範例
Copy Copy
1
2// 下列程式碼範例仍為測試版。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let redirectURL = "redirectURL_example" // String | (選用)
8
9DefaultAPI.sendLoginLink(tenantId: tenantId, id: id, redirectURL: redirectURL) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

updateTenantUser Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是
updateCommentsstringquery否

回應

回傳: APIEmptyResponse

範例

updateTenantUser 範例
Copy Copy
1
2// 下列程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateTenantUserBody = UpdateTenantUserBody(username: "username_example", displayName: "displayName_example", websiteUrl: "websiteUrl_example", email: "email_example", signUpDate: 123, verified: false, loginCount: 123, optedInNotifications: false, optedInTenantNotifications: false, hideAccountCode: false, avatarSrc: "avatarSrc_example", isHelpRequestAdmin: false, isAccountOwner: false, isAdminAdmin: false, isBillingAdmin: false, isAnalyticsAdmin: false, isCustomizationAdmin: false, isManageDataAdmin: false, isCommentModeratorAdmin: false, isAPIAdmin: false, moderatorIds: ["moderatorIds_example"], locale: "locale_example", digestEmailFrequency: 123, displayLabel: "displayLabel_example") // UpdateTenantUserBody |
8let updateComments = "updateComments_example" // String | (可選)
9
10DefaultAPI.updateTenantUser(tenantId: tenantId, id: id, updateTenantUserBody: updateTenantUserBody, updateComments: updateComments) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

createTenant Internal Link

參數

名稱類型位置必填說明
tenantIdstringqueryYes

回應

回傳: CreateTenantResponse

範例

createTenant 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createTenantBody = CreateTenantBody(name: "name_example", domainConfiguration: [APIDomainConfiguration(id: "id_example", domain: "domain_example", emailFromName: "emailFromName_example", emailFromEmail: "emailFromEmail_example", emailHeaders: "TODO", wpSyncToken: "wpSyncToken_example", wpSynced: false, wpURL: "wpURL_example", createdAt: Date(), autoAddedDate: Date(), siteType: ImportedSiteType(), logoSrc: "logoSrc_example", logoSrc100px: "logoSrc100px_example", footerUnsubscribeURL: "footerUnsubscribeURL_example", disableUnsubscribeLinks: false)], email: "email_example", signUpDate: 123, packageId: "packageId_example", paymentFrequency: 123, billingInfoValid: false, billingHandledExternally: false, isSetup: false, billingInfo: BillingInfo(name: "name_example", address: "address_example", city: "city_example", state: "state_example", zip: "zip_example", country: "country_example", currency: "currency_example", email: "email_example", vatId: "vatId_example"), stripeCustomerId: "stripeCustomerId_example", stripeSubscriptionId: "stripeSubscriptionId_example", stripePlanId: "stripePlanId_example", enableProfanityFilter: false, enableSpamFilter: false, removeUnverifiedComments: false, unverifiedCommentsTTLms: 123, commentsRequireApproval: false, autoApproveCommentOnVerification: false, sendProfaneToSpam: false, deAnonIpAddr: 123, meta: "TODO") // CreateTenantBody |
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

deleteTenant Internal Link

參數

名稱類型位置必填描述
tenantIdstring查詢是
idstring路徑是
surestring查詢否

回應

回傳: APIEmptyResponse

範例

deleteTenant 範例
Copy Copy
1
2// 以下程式碼範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let sure = "sure_example" // String | (可選)
8
9DefaultAPI.deleteTenant(tenantId: tenantId, id: id, sure: sure) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getTenant Internal Link

參數

名稱TypeLocation必要說明
tenantIdstringquery是
idstringpath是

回應

回傳: GetTenantResponse

範例

getTenant 範例
Copy Copy
1
2// 下列程式碼範例仍為測試版。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getTenant(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getTenants Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
metastringquery否
skipnumberquery否

回應

返回:GetTenantsResponse

範例

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, options: DefaultAPI.GetTenantsOptions(meta: meta, skip: skip)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

updateTenant Internal Link

參數

名稱類型位置必填說明
tenantIdstringqueryYes
idstringpathYes

回應

返回:APIEmptyResponse

範例

updateTenant 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateTenantBody = UpdateTenantBody(name: "name_example", email: "email_example", signUpDate: 123, packageId: "packageId_example", paymentFrequency: 123, billingInfoValid: false, billingHandledExternally: false, isSetup: false, domainConfiguration: [APIDomainConfiguration(id: "id_example", domain: "domain_example", emailFromName: "emailFromName_example", emailFromEmail: "emailFromEmail_example", emailHeaders: "TODO", wpSyncToken: "wpSyncToken_example", wpSynced: false, wpURL: "wpURL_example", createdAt: Date(), autoAddedDate: Date(), siteType: ImportedSiteType(), logoSrc: "logoSrc_example", logoSrc100px: "logoSrc100px_example", footerUnsubscribeURL: "footerUnsubscribeURL_example", disableUnsubscribeLinks: false)], billingInfo: BillingInfo(name: "name_example", address: "address_example", city: "city_example", state: "state_example", zip: "zip_example", country: "country_example", currency: "currency_example", email: "email_example", vatId: "vatId_example"), stripeCustomerId: "stripeCustomerId_example", stripeSubscriptionId: "stripeSubscriptionId_example", stripePlanId: "stripePlanId_example", enableProfanityFilter: false, enableSpamFilter: false, removeUnverifiedComments: false, unverifiedCommentsTTLms: 123, commentsRequireApproval: false, autoApproveCommentOnVerification: false, sendProfaneToSpam: false, deAnonIpAddr: 123, meta: "TODO", managedByTenantId: "managedByTenantId_example") // UpdateTenantBody |
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

changeTicketState Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
userIdstringquery是
idstringpath是

回應

回傳:ChangeTicketStateResponse

範例

changeTicketState 範例
Copy Copy
1
2// 下列程式碼範例仍處於測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String |
7let id = "id_example" // String |
8let changeTicketStateBody = ChangeTicketStateBody(state: 123) // ChangeTicketStateBody |
9
10DefaultAPI.changeTicketState(tenantId: tenantId, userId: userId, id: id, changeTicketStateBody: changeTicketStateBody) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

createTicket Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery是
userIdstringquery是

回應

回傳: CreateTicketResponse

範例

createTicket 範例
Copy Copy
1
2// 下列程式範例仍為 Beta 版本。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 提出回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String |
7let 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

getTicket Internal Link

參數

名稱型別位置必填說明
tenantIdstringquery是
idstringpath是
userIdstringquery否

回應

回傳: GetTicketResponse

範例

getTicket 範例
Copy Copy
1
2// 下列程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let userId = "userId_example" // String | (選填)
8
9DefaultAPI.getTicket(tenantId: tenantId, id: id, userId: userId) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getTickets Internal Link

參數

名稱類型位置必填說明
tenantIdstringqueryYes
userIdstringqueryNo
statenumberqueryNo
skipnumberqueryNo
limitnumberqueryNo

回應

返回: GetTicketsResponse

範例

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 | (optional)
7let state = 987 // Double | (optional)
8let skip = 987 // Double | (optional)
9let limit = 987 // Double | (optional)
10
11DefaultAPI.getTickets(tenantId: tenantId, options: DefaultAPI.GetTicketsOptions(userId: userId, state: state, skip: skip, limit: limit)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

getTranslations Internal Link

參數

名稱類型位置必填說明
namespacestringpath是
componentstringpath是
localestringquery否
useFullTranslationIdsbooleanquery否

回應

返回:GetTranslationsResponse

範例

getTranslations 範例
Copy Copy
1
2// 以下程式碼範例仍處於測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let namespace = "namespace_example" // String |
6let component = "component_example" // String |
7let locale = "locale_example" // String | (可選)
8let useFullTranslationIds = true // Bool | (可選)
9
10PublicAPI.getTranslations(namespace: namespace, component: component, options: PublicAPI.GetTranslationsOptions(locale: locale, useFullTranslationIds: useFullTranslationIds)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

uploadImage Internal Link

上傳並調整圖像大小

參數

名稱類型位置必填描述
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\" (為流行裝置建立多種尺寸) (optional)
8let urlId = "urlId_example" // String | 上傳發生的頁面 ID,用於設定(optional)
9
10PublicAPI.uploadImage(tenantId: tenantId, file: file, options: PublicAPI.UploadImageOptions(sizePreset: sizePreset, urlId: urlId)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getUserBadgeProgressById Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery是
idstringpath是

回應

回傳:APIGetUserBadgeProgressResponse

範例

getUserBadgeProgressById 範例
Copy Copy
1
2// 下列程式範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // 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

getUserBadgeProgressByUserId Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
userIdstringpathYes

回應

Returns: APIGetUserBadgeProgressResponse

範例

getUserBadgeProgressByUserId 範例
Copy Copy
1
2// 以下程式範例仍處於測試版。如遇任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String |
7
8DefaultAPI.getUserBadgeProgressByUserId(tenantId: tenantId, userId: userId) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getUserBadgeProgressList Internal Link

參數

名稱類型位置必要描述
tenantIdstringquery是
userIdstringquery否
limitnumberquery否
skipnumberquery否

回應

返回:APIGetUserBadgeProgressListResponse

範例

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, options: DefaultAPI.GetUserBadgeProgressListOptions(userId: userId, limit: limit, skip: skip)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

createUserBadge Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是

回應

回傳:APICreateUserBadgeResponse

範例

createUserBadge 範例
Copy Copy
1
2// 下列程式範例仍屬測試版。如遇任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createUserBadgeParams = CreateUserBadgeParams(userId: "userId_example", badgeId: "badgeId_example", displayedOnComments: false) // CreateUserBadgeParams |
7
8DefaultAPI.createUserBadge(tenantId: tenantId, createUserBadgeParams: createUserBadgeParams) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

deleteUserBadge Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery是
idstringpath是

回應

回傳: APIEmptySuccessResponse

範例

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

getUserBadge Internal Link

參數

名稱類型位置必要描述
tenantIdstringquery是
idstringpath是

回應

回傳: APIGetUserBadgeResponse

範例

getUserBadge 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如遇任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getUserBadge(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getUserBadges Internal Link

參數

名稱類型位置必填說明
tenantIdstringqueryYes
userIdstringqueryNo
badgeIdstringqueryNo
typenumberqueryNo
displayedOnCommentsbooleanqueryNo
limitnumberqueryNo
skipnumberqueryNo

回應

Returns: APIGetUserBadgesResponse

範例

取得使用者徽章 範例
Copy Copy
1
2// 以下程式碼範例仍處於測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String | (可選)
7let badgeId = "badgeId_example" // String | (可選)
8let type = 987 // Double | (可選)
9let displayedOnComments = true // Bool | (可選)
10let limit = 987 // Double | (可選)
11let skip = 987 // Double | (可選)
12
13DefaultAPI.getUserBadges(tenantId: tenantId, options: DefaultAPI.GetUserBadgesOptions(userId: userId, badgeId: badgeId, type: type, displayedOnComments: displayedOnComments, limit: limit, skip: skip)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

updateUserBadge Internal Link

參數

名稱型別位置必填描述
tenantIdstringquery是
idstringpath是

回應

回傳: APIEmptySuccessResponse

範例

updateUserBadge 範例
Copy Copy
1
2// 下列程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateUserBadgeParams = UpdateUserBadgeParams(displayedOnComments: false) // UpdateUserBadgeParams |
8
9DefaultAPI.updateUserBadge(tenantId: tenantId, id: id, updateUserBadgeParams: updateUserBadgeParams) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getUserNotificationCount Internal Link

參數

名稱型別位置必填說明
tenantIdstringquery是
ssostringquery否

回應

回傳: GetUserNotificationCountResponse

範例

getUserNotificationCount 範例
Copy Copy
1
2// 下列程式碼範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String | 租戶 ID
6let sso = "sso_example" // String | SSO(選填)
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

getUserNotifications Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
urlIdstringqueryNo用於判斷目前的頁面是否已訂閱。
pageSizeintegerqueryNo
afterIdstringqueryNo
includeContextbooleanqueryNo
afterCreatedAtintegerqueryNo
unreadOnlybooleanqueryNo
dmOnlybooleanqueryNo
noDmbooleanqueryNo
includeTranslationsbooleanqueryNo
includeTenantNotificationsbooleanqueryNo
ssostringqueryNo

Response

回傳:GetMyNotificationsResponse

範例

取得使用者通知 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試階段。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String | 用於判斷目前的頁面是否已訂閱。 (optional)
7let pageSize = 987 // Int | (optional)
8let afterId = "afterId_example" // String | (optional)
9let includeContext = true // Bool | (optional)
10let afterCreatedAt = 987 // Int64 | (optional)
11let unreadOnly = true // Bool | (optional)
12let dmOnly = true // Bool | (optional)
13let noDm = true // Bool | (optional)
14let includeTranslations = true // Bool | (optional)
15let includeTenantNotifications = true // Bool | (optional)
16let sso = "sso_example" // String | (optional)
17
18PublicAPI.getUserNotifications(tenantId: tenantId, options: PublicAPI.GetUserNotificationsOptions(urlId: urlId, pageSize: pageSize, afterId: afterId, includeContext: includeContext, afterCreatedAt: afterCreatedAt, unreadOnly: unreadOnly, dmOnly: dmOnly, noDm: noDm, includeTranslations: includeTranslations, includeTenantNotifications: includeTenantNotifications, sso: sso)) { (response, error) in
19 guard error == nil else {
20 print(error)
21 return
22 }
23
24 if (response) {
25 dump(response)
26 }
27}
28

resetUserNotificationCount Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery是
ssostringquery否

回應

回傳:ResetUserNotificationsResponse

範例

resetUserNotificationCount 範例
Copy Copy
1
2// 下列程式範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let sso = "sso_example" // String | (可選)
7
8PublicAPI.resetUserNotificationCount(tenantId: tenantId, sso: sso) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

resetUserNotifications Internal Link

參數

名稱類型位置必要說明
tenantIdstringqueryYes
afterIdstringqueryNo
afterCreatedAtintegerqueryNo
unreadOnlybooleanqueryNo
dmOnlybooleanqueryNo
noDmbooleanqueryNo
ssostringqueryNo

回應

Returns: ResetUserNotificationsResponse

範例

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, options: PublicAPI.ResetUserNotificationsOptions(afterId: afterId, afterCreatedAt: afterCreatedAt, unreadOnly: unreadOnly, dmOnly: dmOnly, noDm: noDm, sso: sso)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

updateUserNotificationCommentSubscriptionStatus Internal Link

啟用或停用針對特定評論的通知。

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
notificationIdstringpath是
optedInOrOutstringpath是
commentIdstringquery是
ssostringquery否

回應

回傳: UpdateUserNotificationCommentSubscriptionStatusResponse

範例

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

updateUserNotificationPageSubscriptionStatus Internal Link

啟用或停用頁面通知。當使用者訂閱頁面時,會為新的根評論建立通知,並且也

參數

名稱類型位置必填說明
tenantIdstringquery是
urlIdstringquery是
urlstringquery是
pageTitlestringquery是
subscribedOrUnsubscribedstringpath是
ssostringquery否

回應

回傳: UpdateUserNotificationPageSubscriptionStatusResponse

範例

updateUserNotificationPageSubscriptionStatus 範例
Copy Copy
1
2// 下列程式範例仍為測試版。如遇任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let url = "url_example" // String |
8let pageTitle = "pageTitle_example" // String |
9let subscribedOrUnsubscribed = "subscribedOrUnsubscribed_example" // String |
10let sso = "sso_example" // String | (可選)
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

updateUserNotificationStatus Internal Link

參數

名稱類型位置必填說明
tenantIdstring查詢參數是
notificationIdstring路徑參數是
newStatusstring路徑參數是
ssostring查詢參數否

回應

回傳:UpdateUserNotificationStatusResponse

範例

updateUserNotificationStatus 範例
Copy Copy
1
2// 以下程式碼範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let notificationId = "notificationId_example" // String |
7let newStatus = "newStatus_example" // String |
8let sso = "sso_example" // String | (可選)
9
10PublicAPI.updateUserNotificationStatus(tenantId: tenantId, notificationId: notificationId, newStatus: newStatus, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getUserPresenceStatuses Internal Link

參數

名稱型別位置必填描述
tenantIdstringquery是
urlIdWSstringquery是
userIdsstringquery是

回應

回傳: GetUserPresenceStatusesResponse

範例

getUserPresenceStatuses 範例
Copy Copy
1
2// 下列程式範例仍為 beta。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // 字串 |
6let urlIdWS = "urlIdWS_example" // 字串 |
7let userIds = "userIds_example" // 字串 |
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

searchUsers Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringpath是
urlIdstringquery是
usernameStartsWithstringquery否
mentionGroupIdsarrayquery否
ssostringquery否
searchSectionstringquery否

回應

返回: SearchUsersResult

範例

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, options: PublicAPI.SearchUsersOptions(usernameStartsWith: usernameStartsWith, mentionGroupIds: mentionGroupIds, sso: sso, searchSection: searchSection)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

getUser Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是

回應

回傳:GetUserResponse

範例

getUser 範例
Copy Copy
1
2// 下列程式範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getUser(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

createVote Internal Link

參數

名稱類型位置必填說明
tenantIdstringqueryYes
commentIdstringqueryYes
directionstringqueryYes
userIdstringqueryNo
anonUserIdstringqueryNo

回應

回傳: VoteResponse

範例

createVote 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let direction = "direction_example" // String |
8let userId = "userId_example" // String | (可選)
9let anonUserId = "anonUserId_example" // String | (可選)
10
11DefaultAPI.createVote(tenantId: tenantId, commentId: commentId, direction: direction, options: DefaultAPI.CreateVoteOptions(userId: userId, anonUserId: anonUserId)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

deleteVote Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
idstringpath是
editKeystringquery否

回應

回傳: VoteDeleteResponse

範例

deleteVote 範例
Copy Copy
1
2// 下列程式碼範例仍處於 beta 階段。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let 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

getVotes Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery是
urlIdstringquery是

回應

回傳:GetVotesResponse

範例

getVotes 範例
Copy Copy
1
2// 下列程式碼範例仍為測試版。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7
8DefaultAPI.getVotes(tenantId: tenantId, urlId: urlId) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getVotesForUser Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery是
urlIdstringquery是
userIdstringquery否
anonUserIdstringquery否

回應

返回:GetVotesForUserResponse

範例

getVotesForUser 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試階段。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let userId = "userId_example" // String | (可選)
8let anonUserId = "anonUserId_example" // String | (可選)
9
10DefaultAPI.getVotesForUser(tenantId: tenantId, urlId: urlId, options: DefaultAPI.GetVotesForUserOptions(userId: userId, anonUserId: anonUserId)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

createWebhook Internal Link

將 URL 訂閱至評論事件(REST hook 訂閱)。若將相同的 URL 再次訂閱至相同的事件與網域,將回傳現有的訂閱。傳送內容以 HMAC 簽署,請參閱 webhooks 指南;舊版的 token 標頭永遠不會傳送至 API 訂閱。

參數

名稱類型位置必填說明
tenantIdstringquery是

回應

回傳:CreateWebhookResponse

範例

createWebhook 範例
Copy Copy
1
2// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createWebhookParams = CreateWebhookParams(url: "url_example", event: WebhookEventName(), domain: "domain_example", method: WebhookHTTPMethod()) // CreateWebhookParams |
7
8DefaultAPI.createWebhook(tenantId: tenantId, createWebhookParams: createWebhookParams) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

deleteWebhook Internal Link

取消訂閱(REST 鉤子取消訂閱)。僅能刪除透過此 API 建立的訂閱;在儀表板中管理的 webhook 必須在儀表板內編輯。

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

返回:APIEmptyResponse

Example

deleteWebhook 範例
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.deleteWebhook(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

getWebhooks Internal Link

列出為租戶設定的 Webhook,包括儀表板管理的行和 API 訂閱。

參數

名稱類型位置必填說明
tenantIdstringquery是
eventstringquery否
domainstringquery否
sourcestringquery否
skipnumberquery否

回應

返回:GetWebhooksResponse

範例

取得 Webhooks 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let event = WebhookEventName() // WebhookEventName | (optional)
7let domain = "domain_example" // String | (optional)
8let source = WebhookSource() // WebhookSource | (optional)
9let skip = 987 // Double | (optional)
10
11DefaultAPI.getWebhooks(tenantId: tenantId, options: DefaultAPI.GetWebhooksOptions(event: event, domain: domain, source: source, 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

getWebhookSamplePayloads Internal Link

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

Parameters

名稱類型位置必填說明
tenantIdstringquery是
eventstringquery否
limitnumberquery否

Response

返回:GetWebhookSamplePayloadsResponse

Example

getWebhookSamplePayloads 範例
Copy Copy
1
2// 以下程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let event = WebhookEventName() // WebhookEventName | (optional)
7let limit = 987 // Double | (optional)
8
9DefaultAPI.getWebhookSamplePayloads(tenantId: tenantId, options: DefaultAPI.GetWebhookSamplePayloadsOptions(event: event, limit: limit)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

需要幫助?

如果您在使用 Swift SDK 時遇到任何問題或有任何疑問,請:

貢獻

歡迎貢獻!請造訪 GitHub 存放庫 以取得貢獻指南。