FastComments.com

FastComments Swift 軟體開發套件


這是 FastComments 的官方 Swift SDK。

FastComments API 的官方 Swift SDK

儲存庫

在 GitHub 上檢視


安裝 Internal Link

Swift 套件管理員

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

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

或在 Xcode 中:

  1. File > Add Packages...
  2. 輸入儲存庫 URL:https://github.com/fastcomments/fastcomments-swift.git
  3. 選擇您想使用的版本

系統需求

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

函式庫內容 Internal Link

FastComments Swift SDK 包含數個模組:

  • 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 - Client-Safe Methods

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

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

範例使用情境: 在 iOS 應用中取得與建立評論

DefaultAPI - Server-Side Methods

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

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

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

ModerationAPI - Moderator Dashboard Methods

ModerationAPI 提供完整的即時與快速審核 API 套件。每個 ModerationAPI 方法皆接受 sso 參數,並可透過 SSO 或 FastComments.com 會話 Cookie 進行驗證。

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

重要: 絕不要在客戶端程式碼中暴露您的 API 金鑰。API 金鑰只能在伺服器端使用。

呼叫 API Internal Link


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

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

常見問題 Internal Link

401 未授權錯誤

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

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

SSO 令牌問題

如果 SSO 令牌無法運作:

  1. 在生產環境使用安全模式:在生產環境中,始終使用帶有您的 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

聚合 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

取得稽核日誌 Internal Link

Parameters

名稱類型位置必填描述
tenantIdstringquery
limitnumberquery
skipnumberquery
orderstringquery
afternumberquery
beforenumberquery

Response

Returns: GetAuditLogsResponse

Example

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

公開登出 Internal Link

回應

回傳: APIEmptyResponse

範例

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

公開封鎖(留言) Internal Link

參數

NameTypeLocationRequiredDescription
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

公開取消封鎖留言 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

檢查被封鎖的留言 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

從留言封鎖使用者 Internal Link

參數

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

回應

返回:BlockSuccess

範例

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

公開建立留言 Internal Link

參數

名稱類型位置必填說明
tenantIdstringpath
urlIdstringquery
broadcastIdstringquery
sessionIdstringquery
ssostringquery

回應

返回: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", tos: false, botId: "botId_example") // CommentData |
9let sessionId = "sessionId_example" // String | (可選)
10let sso = "sso_example" // String | (可選)
11
12PublicAPI.createCommentPublic(tenantId: tenantId, urlId: urlId, broadcastId: broadcastId, commentData: commentData, options: PublicAPI.CreateCommentPublicOptions(sessionId: sessionId, sso: sso)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

刪除留言 Internal Link

參數

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

公開刪除留言 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

刪除留言投票 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

檢舉留言 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

取得留言 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

取得留言 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

公開取得留言 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

回應

返回: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 | (可選)
33
34PublicAPI.getCommentsPublic(tenantId: tenantId, urlId: urlId, options: PublicAPI.GetCommentsPublicOptions(page: page, direction: direction, sso: sso, skip: skip, skipChildren: skipChildren, limit: limit, limitChildren: limitChildren, countChildren: countChildren, fetchPageForCommentId: fetchPageForCommentId, includeConfig: includeConfig, countAll: countAll, includei10n: includei10n, locale: locale, modules: modules, isCrawler: isCrawler, includeNotificationCount: includeNotificationCount, asTree: asTree, maxTreeDepth: maxTreeDepth, useFullTranslationIds: useFullTranslationIds, parentId: parentId, searchText: searchText, hashTags: hashTags, userId: userId, customConfigStr: customConfigStr, afterCommentId: afterCommentId, beforeCommentId: beforeCommentId)) { (response, error) in
35 guard error == nil else {
36 print(error)
37 return
38 }
39
40 if (response) {
41 dump(response)
42 }
43}
44

取得留言內容 Internal Link


參數

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

取得留言投票使用者名稱 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

鎖定留言 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

置頂留言 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

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

批次儲存留言 Internal Link

參數

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

回應

返回:[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", 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

設定留言內容 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

從留言取消封鎖使用者 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

取消檢舉留言 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

解鎖留言 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

取消置頂留言 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

更新留言 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

對留言投票 Internal Link

參數

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

回應

返回:VoteResponse

範例

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

取得使用者的留言 Internal Link

參數

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

新增網域設定 Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery

回應

回傳:AddDomainConfigResponse

範例

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

刪除網域設定 Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery
domainstringpath

回應

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

取得網域設定 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

取得網域設定清單 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

部分更新網域設定 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

覆寫網域設定 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

建立電子郵件範本 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

刪除電子郵件範本 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

刪除電子郵件範本渲染錯誤 Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
errorIdstringpath

回應

回傳: APIEmptyResponse

範例

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

取得電子郵件範本 Internal Link

參數

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

回應

回傳: GetEmailTemplateResponse

範例

getEmailTemplate 範例
Copy Copy
1
2// 下列程式碼範例仍為 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

取得電子郵件範本定義 Internal Link

參數

名稱類型位置必填描述
tenantIdstringquery

回傳

回傳: GetEmailTemplateDefinitionsResponse

範例

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

取得電子郵件範本渲染錯誤 Internal Link

參數

NameTypeLocationRequiredDescription
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

取得電子郵件範本清單 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

渲染電子郵件範本 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

更新電子郵件範本 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

取得事件日誌 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

取得全域事件日誌 Internal Link

req tenantId urlId userIdWS

參數

NameTypeLocationRequiredDescription
tenantIdstringpath
urlIdstringquery
userIdWSstringquery
startTimeintegerquery
endTimeintegerquery

回應

回傳: GetEventLogResponse

範例

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

建立動態貼文 Internal Link

參數

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

公開建立動態貼文 Internal Link

參數

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

回應

返回:CreateFeedPostResponse

範例

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

公開刪除動態貼文 Internal Link

參數

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

取得動態貼文 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

公開取得動態貼文 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

取得動態貼文統計 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

公開取得使用者對貼文的反應 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

公開對動態貼文反應 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

更新動態貼文 Internal Link

參數

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

回應

回傳: APIEmptyResponse

範例

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

公開更新動態貼文 Internal Link

參數

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

回應

回傳: CreateFeedPostResponse

範例

updateFeedPostPublic 範例
Copy Copy
1
2// 以下程式碼範例仍處於測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let postId = "postId_example" // String |
7let updateFeedPostParams = UpdateFeedPostParams(title: "title_example", contentHTML: "contentHTML_example", media: [FeedPostMediaItem(title: "title_example", linkUrl: "linkUrl_example", sizes: [FeedPostMediaItemAsset(w: 123, h: 123, src: "src_example")])], links: [FeedPostLink(text: "text_example", title: "title_example", description: "description_example", url: "url_example")], tags: ["tags_example"], meta: "TODO") // UpdateFeedPostParams |
8let broadcastId = "broadcastId_example" // String | (可選)
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

公開檢舉留言 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

取得大型動圖 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

搜尋動圖 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

取得熱門動圖 Internal Link

參數

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

回應

返回: GetGifsTrendingResponse

範例

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

新增標籤 Internal Link

參數

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

批次新增標籤 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

刪除標籤 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

取得標籤 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

部分更新標籤 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

刪除審核投票 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

取得 API 留言 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

取得 API 匯出狀態 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

取得 API ID 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

取得被留言封鎖的使用者 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

取得留言封鎖狀態 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

取得留言回覆 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

取得數量 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

取得多項數量 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

取得日誌 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

取得手動徽章 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

取得使用者的手動徽章 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

取得審核留言 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

取得審核留言內容 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

取得預封鎖摘要 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

取得搜尋留言摘要 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

搜尋頁面 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

搜尋網站 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

取得搜尋建議 Internal Link

參數

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

回應

返回:ModerationSuggestResponse

範例

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

搜尋使用者 Internal Link

參數

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

取得信任因子 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

取得使用者封鎖偏好 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

取得使用者內部檔案 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

調整留言投票 (POST) Internal Link

參數

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

回應

返回:AdjustVotesResponse

範例

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

發起 API 匯出 (POST) 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

從留言封鎖使用者 (POST) 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

撤銷封鎖使用者 (POST) 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

批次取得預封鎖摘要 (POST) 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

依 ID 取得留言 (POST) 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

檢舉留言 (POST) 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

移除留言 (POST) 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

還原已刪除留言 (POST) 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

設定留言核准狀態 (POST) 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

設定留言審核狀態 (POST) 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

設定留言為垃圾訊息狀態 (POST) 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

設定留言內容 (POST) 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

取消檢舉留言 (POST) 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

提交投票 (POST) 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

授予徽章 (PUT) 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

關閉討論串 (PUT) 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

移除徽章 (PUT) 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

重新開啟討論串 (PUT) 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

設定信任因子 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

建立管理員 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

刪除管理員 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

取得管理員 Internal Link


參數

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

回應

回傳: GetModeratorResponse

範例

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

取得管理員清單 Internal Link

參數

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

發送邀請 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

更新管理員 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

刪除通知計數 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

取得快取的通知計數 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

取得通知計數 Internal Link

參數

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

回應

返回:GetNotificationCountResponse

範例

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

取得通知 Internal Link

參數

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

更新通知 Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
userIdstringquery

回應

回傳: APIEmptyResponse

範例

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

建立 V1 頁面反應 Internal Link

參數

名稱TypeLocation必要說明
tenantIdstringpath
urlIdstringquery
titlestringquery

回應

回傳:CreateV1PageReact

範例

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

建立 V2 頁面反應 Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringpath
urlIdstringquery
idstringquery
titlestringquery

回傳

回傳: CreateV1PageReact

範例

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

刪除 V1 頁面反應 Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringpath
urlIdstringquery

回應

回傳: CreateV1PageReact

範例

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

刪除 V2 頁面反應 Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringpath
urlIdstringquery
idstringquery

回應

回傳: CreateV1PageReact

範例

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

取得 V1 頁面按讚數 Internal Link

參數

名稱類型Location必要描述
tenantIdstringpath
urlIdstringquery

回應

回傳: GetV1PageLikes

範例

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

取得 V2 頁面反應 Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringpath
urlIdstringquery

回應

回傳: GetV2PageReacts

範例

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

取得 V2 頁面反應使用者 Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringpath
urlIdstringquery
idstringquery

回傳

回傳:GetV2PageReactUsersResponse

範例

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

新增頁面 Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery

回應

回傳: AddPageAPIResponse

範例

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

刪除頁面 Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

回傳

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

取得離線使用者 Internal Link

Past commenters on the page who are NOT currently online. Sorted by displayName.
頁面上過去的評論者(目前未在線)。依 displayName 排序。

Use this after exhausting /users/online to render a "Members" section.
在耗盡 /users/online 後使用,以呈現「成員」區段。

Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
在 commenterName 上使用游標分頁:伺服器從 afterName 開始,透過 $gt 向前走訪部分 {tenantId, urlId, commenterName} 索引,無 $skip 成本。

Parameters

名稱類型位置必填說明
tenantIdstringpathYes
urlIdstringqueryYes頁面 URL 識別碼(在伺服器端清理)。
afterNamestringqueryNo游標:從先前的回應中傳入 nextAfterName。(可選)
afterUserIdstringqueryNo游標平手斷點:從先前的回應中傳入 nextAfterUserId。當 afterName 被設定時此為必填,以避免因名稱相同而遺漏條目。(可選)

Response

返回:PageUsersOfflineResponse

範例

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

取得在線使用者 Internal Link


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

參數

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

回應

返回: PageUsersOnlineResponse

範例

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

依 URL ID 取得頁面 Internal Link

參數

名稱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

取得頁面清單 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

取得使用者資訊 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

部分更新頁面 Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

回傳

回傳: PatchPageAPIResponse

範例

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

刪除待處理的 Webhook 事件 Internal Link

參數

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

回應

回傳: APIEmptyResponse

範例

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

取得待處理的 Webhook 事件數 Internal Link

參數

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

取得待處理的 Webhook 事件 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

建立問卷設定 Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery

回應

回傳: CreateQuestionConfigResponse

範例

createQuestionConfig 範例
Copy Copy
1
2// 下列程式範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createQuestionConfigBody = CreateQuestionConfigBody(name: "name_example", question: "question_example", helpText: "helpText_example", type: "type_example", numStars: 123, min: 123, max: 123, defaultValue: 123, labelNegative: "labelNegative_example", labelPositive: "labelPositive_example", customOptions: [QuestionConfig_customOptions_inner(imageSrc: "imageSrc_example", name: "name_example")], subQuestionIds: ["subQuestionIds_example"], alwaysShowSubQuestions: false, reportingOrder: 123) // CreateQuestionConfigBody |
7
8DefaultAPI.createQuestionConfig(tenantId: tenantId, createQuestionConfigBody: createQuestionConfigBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

刪除問卷設定 Internal Link

參數

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

取得問卷設定 Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

回應

回傳: GetQuestionConfigResponse

範例

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

取得問卷設定清單 Internal Link

參數

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

回應

回傳: GetQuestionConfigsResponse

範例

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

更新問卷設定 Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

回應

回傳: APIEmptyResponse

範例

updateQuestionConfig 範例
Copy Copy
1
2// 下列程式碼範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateQuestionConfigBody = UpdateQuestionConfigBody(name: "name_example", question: "question_example", helpText: "helpText_example", type: "type_example", numStars: 123, min: 123, max: 123, defaultValue: 123, labelNegative: "labelNegative_example", labelPositive: "labelPositive_example", customOptions: [QuestionConfig_customOptions_inner(imageSrc: "imageSrc_example", name: "name_example")], subQuestionIds: ["subQuestionIds_example"], alwaysShowSubQuestions: false, reportingOrder: 123) // UpdateQuestionConfigBody |
8
9DefaultAPI.updateQuestionConfig(tenantId: tenantId, id: id, updateQuestionConfigBody: updateQuestionConfigBody) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

建立問卷結果 Internal Link

參數

名稱TypeLocation必填描述
tenantIdstringquery

回應

回傳:CreateQuestionResultResponse

範例

createQuestionResult 範例
Copy Copy
1
2// 以下程式碼範例仍為測試版。若有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createQuestionResultBody = CreateQuestionResultBody(urlId: "urlId_example", value: 123, questionId: "questionId_example", anonUserId: "anonUserId_example", userId: "userId_example", commentId: "commentId_example", meta: [MetaItem(name: "name_example", values: ["values_example"])]) // CreateQuestionResultBody |
7
8DefaultAPI.createQuestionResult(tenantId: tenantId, createQuestionResultBody: createQuestionResultBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

刪除問卷結果 Internal Link


參數

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

回應

回傳: APIEmptyResponse

範例

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

取得問卷結果 Internal Link

參數

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

回應

回傳: GetQuestionResultResponse

範例

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

取得問卷結果清單 Internal Link

參數

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

回應

返回:GetQuestionResultsResponse

範例

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

更新問卷結果 Internal Link

參數

名稱類型位置必填說明
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, commentId: "commentId_example", questionId: "questionId_example", meta: [MetaItem(name: "name_example", values: ["values_example"])]) // UpdateQuestionResultBody |
8
9DefaultAPI.updateQuestionResult(tenantId: tenantId, id: id, updateQuestionResultBody: updateQuestionResultBody) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

彙總問卷結果 Internal Link

參數

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

回應

返回:AggregateQuestionResultsResponse

範例

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

批次彙總問卷結果 Internal Link

參數

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

回應

回傳: BulkAggregateQuestionResultsResponse

範例

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

合併留言與問卷結果 Internal Link

參數

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

回應

返回: CombineQuestionResultsWithCommentsResponse

範例

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

新增 SSO 使用者 Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery

回應

回傳: AddSSOUserAPIResponse

範例

addSSOUser 範例
Copy Copy
1
2// 下列程式範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createAPISSOUserData = CreateAPISSOUserData(groupIds: ["groupIds_example"], hasBlockedUsers: false, isProfileDMDisabled: false, isProfileCommentsPrivate: false, isProfileActivityPrivate: false, isCommentModeratorAdmin: false, isAdminAdmin: false, isAccountOwner: false, displayName: "displayName_example", displayLabel: "displayLabel_example", optedInSubscriptionNotifications: false, optedInNotifications: false, avatarSrc: "avatarSrc_example", loginCount: 123, createdFromUrlId: "createdFromUrlId_example", signUpDate: 123, email: "email_example", websiteUrl: "websiteUrl_example", username: "username_example", id: "id_example") // CreateAPISSOUserData |
7
8DefaultAPI.addSSOUser(tenantId: tenantId, createAPISSOUserData: createAPISSOUserData) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

刪除 SSO 使用者 Internal Link

參數

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

依電子郵件取得 SSO 使用者 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

依 ID 取得 SSO 使用者 Internal Link

參數

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

回應

回傳:GetSSOUserByIdAPIResponse

範例

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

取得 SSO 使用者清單 Internal Link

參數

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

部分更新 SSO 使用者 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

覆寫 SSO 使用者 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

建立訂閱 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

刪除訂閱 Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
userIdstringquery

回應

回傳: DeleteSubscriptionAPIResponse

範例

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

取得訂閱清單 Internal Link

參數

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

回應

回傳: GetSubscriptionsAPIResponse

範例

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

更新訂閱 Internal Link

參數

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

回應

回傳: UpdateSubscriptionAPIResponse

範例

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

取得租戶每日使用量 Internal Link

參數

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

回應

回傳:GetTenantDailyUsagesResponse

範例

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

建立租戶套件 Internal Link


參數

名稱類型位置必填描述
tenantIdstringquery

回應

回傳: CreateTenantPackageResponse

範例

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

刪除租戶套件 Internal Link

參數

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

回應

回傳: APIEmptyResponse

範例

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

取得租戶套件 Internal Link


參數

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

取得租戶套件清單 Internal Link

參數

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

回應

回傳: GetTenantPackagesResponse

範例

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

取代租戶套件 Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

回應

回傳:APIEmptyResponse

範例

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

更新租戶套件 Internal Link

參數

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

建立租戶使用者 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

刪除租戶使用者 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

取得租戶使用者 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

取得租戶使用者清單 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

取代租戶使用者 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

更新租戶使用者 Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
updateCommentsstringquery

回應

回傳: APIEmptyResponse

範例

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

建立租戶 Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery

回應

回傳: CreateTenantResponse

範例

createTenant 範例
Copy Copy
1
2// 以下範例程式碼仍處於測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // 字串 |
6let createTenantBody = CreateTenantBody(name: "name_example", domainConfiguration: [APIDomainConfiguration(id: "id_example", domain: "domain_example", emailFromName: "emailFromName_example", emailFromEmail: "emailFromEmail_example", emailHeaders: "TODO", wpSyncToken: "wpSyncToken_example", wpSynced: false, wpURL: "wpURL_example", createdAt: Date(), autoAddedDate: Date(), siteType: ImportedSiteType(), logoSrc: "logoSrc_example", logoSrc100px: "logoSrc100px_example", footerUnsubscribeURL: "footerUnsubscribeURL_example", disableUnsubscribeLinks: false)], email: "email_example", signUpDate: 123, packageId: "packageId_example", paymentFrequency: 123, billingInfoValid: false, billingHandledExternally: false, createdBy: "createdBy_example", isSetup: false, billingInfo: BillingInfo(name: "name_example", address: "address_example", city: "city_example", state: "state_example", zip: "zip_example", country: "country_example", currency: "currency_example", email: "email_example"), stripeCustomerId: "stripeCustomerId_example", stripeSubscriptionId: "stripeSubscriptionId_example", stripePlanId: "stripePlanId_example", enableProfanityFilter: false, enableSpamFilter: false, removeUnverifiedComments: false, unverifiedCommentsTTLms: 123, commentsRequireApproval: false, autoApproveCommentOnVerification: false, sendProfaneToSpam: false, deAnonIpAddr: 123, meta: "TODO") // CreateTenantBody |
7
8DefaultAPI.createTenant(tenantId: tenantId, createTenantBody: createTenantBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

刪除租戶 Internal Link


參數

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

取得租戶 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

取得租戶清單 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

更新租戶 Internal Link

參數

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

回應

回傳: APIEmptyResponse

範例

updateTenant 範例
Copy Copy
1
2// 下面的程式碼範例仍屬測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateTenantBody = UpdateTenantBody(name: "name_example", email: "email_example", signUpDate: 123, packageId: "packageId_example", paymentFrequency: 123, billingInfoValid: false, billingHandledExternally: false, createdBy: "createdBy_example", isSetup: false, domainConfiguration: [APIDomainConfiguration(id: "id_example", domain: "domain_example", emailFromName: "emailFromName_example", emailFromEmail: "emailFromEmail_example", emailHeaders: "TODO", wpSyncToken: "wpSyncToken_example", wpSynced: false, wpURL: "wpURL_example", createdAt: Date(), autoAddedDate: Date(), siteType: ImportedSiteType(), logoSrc: "logoSrc_example", logoSrc100px: "logoSrc100px_example", footerUnsubscribeURL: "footerUnsubscribeURL_example", disableUnsubscribeLinks: false)], billingInfo: BillingInfo(name: "name_example", address: "address_example", city: "city_example", state: "state_example", zip: "zip_example", country: "country_example", currency: "currency_example", email: "email_example"), stripeCustomerId: "stripeCustomerId_example", stripeSubscriptionId: "stripeSubscriptionId_example", stripePlanId: "stripePlanId_example", enableProfanityFilter: false, enableSpamFilter: false, removeUnverifiedComments: false, unverifiedCommentsTTLms: 123, commentsRequireApproval: false, autoApproveCommentOnVerification: false, sendProfaneToSpam: false, deAnonIpAddr: 123, meta: "TODO", managedByTenantId: "managedByTenantId_example") // UpdateTenantBody |
8
9DefaultAPI.updateTenant(tenantId: tenantId, id: id, updateTenantBody: updateTenantBody) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

變更工單狀態 Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery
userIdstringquery
idstringpath

回應

回傳:ChangeTicketStateResponse

範例

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

建立工單 Internal Link

參數

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

回應

回傳: CreateTicketResponse

範例

createTicket 範例
Copy Copy
1
2// 下列程式範例仍為 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

取得工單 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

取得工單清單 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

取得翻譯 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

上傳圖片 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

依 ID 取得使用者徽章進度 Internal Link

參數

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

回應

回傳:APIGetUserBadgeProgressResponse

範例

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

依使用者 ID 取得使用者徽章進度 Internal Link

參數

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

取得使用者徽章進度清單 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

建立使用者徽章 Internal Link

參數

名稱類型位置必填說明
tenantIdstringquery

回應

回傳:APICreateUserBadgeResponse

範例

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

刪除使用者徽章 Internal Link

參數

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

取得使用者徽章 Internal Link

參數

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

回應

回傳: APIGetUserBadgeResponse

範例

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

取得使用者徽章清單 Internal Link

參數

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

更新使用者徽章 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

取得使用者通知計數 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

取得使用者通知 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

重設使用者通知計數 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

重設使用者通知 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

更新使用者留言通知訂閱狀態 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

更新使用者頁面通知訂閱狀態 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

更新使用者通知狀態 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

取得使用者在線狀態 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

搜尋使用者 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

取得使用者 Internal Link

參數

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

回應

回傳:GetUserResponse

範例

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

建立投票 Internal Link

參數

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

刪除投票 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

取得投票 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

取得使用者的投票 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

需要幫助?

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

貢獻

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