FastComments.com

FastComments Swift SDK


這是 FastComments 的官方 Swift SDK。

FastComments API 的官方 Swift SDK

儲存庫

在 GitHub 上檢視


Installation Internal Link

Swift 套件管理器

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

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

或在 Xcode:

  1. 檔案 > 加入套件...
  2. 輸入儲存庫 URL: https://github.com/fastcomments/fastcomments-swift.git
  3. 選擇你要使用的版本

系統需求

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

Library Contents Internal Link

FastComments Swift SDK 由數個模組組成:

  • Client Module - 為 FastComments REST APIs 自動產生的 API 用戶端

    • 所有 API 模型的完整型別定義
    • 同時包含已授權的 (DefaultAPI) 與公開的 (PublicAPI) 端點
    • 完整的 async/await 支援
    • 詳細 API 文件請見 client/README.md
  • SSO Module - 伺服器端單一登入工具

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

Quick Start Internal Link

使用公開 API

import FastCommentsSwift

// 建立 API 用戶端
let publicApi = PublicAPI()

// Fetch comments for a page
do {
    let response = try await publicApi.getCommentsPublic(
        tenantId: "your-tenant-id",
        urlId: "page-url-id"
    )

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

使用已驗證的 API

import FastCommentsSwift

// 使用 API 金鑰建立設定
let defaultApi = DefaultAPI()
defaultApi.apiKey = "your-api-key"

// Fetch comments using authenticated API
do {
    let response = try await defaultApi.getComments(
        tenantId: "your-tenant-id",
        urlId: "page-url-id"
    )

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

使用 SSO 進行驗證

安全 SSO(建議用於生產環境)

import FastCommentsSwift

let apiKey = "your-api-key"

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

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

    print("SSO Token: \(token ?? "")")
    // 將此令牌傳給前端以進行驗證
} catch {
    print("Error creating SSO token: \(error)")
}

簡易 SSO(用於開發/測試)

import FastCommentsSwift

// 建立簡易 SSO 使用者資料(不需 API 金鑰)
let userData = SimpleSSOUserData(
    username: "johndoe",
    email: "user@example.com",
    avatar: "https://example.com/avatar.jpg"
)

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

Public vs Secured APIs Internal Link

FastComments SDK 提供兩種類型的 API 端點:

PublicAPI - 客戶端安全端點

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

  • 不需要 API 金鑰
  • 可以使用 SSO tokens 進行驗證
  • 對每個使用者/裝置實施速率限制
  • 適用於面向終端使用者的應用程式

範例用途: 在您的 iOS 應用程式中擷取和建立評論

DefaultAPI - 伺服器端端點

The DefaultAPI 包含需要 API 金鑰的已驗證端點。這些端點:

  • 需要您的 FastComments API 金鑰
  • 僅應從伺服器端程式碼呼叫
  • 提供對您的 FastComments 資料的完整存取
  • 以租戶為單位實施速率限制

範例用途: 管理操作、批次資料匯出、審核工具

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

Making API Calls Internal Link

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

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

Common Issues Internal Link

401 Unauthorized Errors

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

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

SSO Token Issues

If SSO tokens aren't working:

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

SSL/TLS Errors

If you encounter SSL/TLS errors:

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

Notes Internal Link

廣播 ID

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

let broadcastId = UUID().uuidString

aggregate Internal Link

將文件透過分組(若提供 groupBy)並套用多種運算進行彙總。支援不同的運算(例如 sum、countDistinct、avg 等)。

參數

名稱 類型 位置 必要 描述
tenantId string query
parentTenantId string query
includeStats boolean query

回應

回傳: AggregationResponse

範例

aggregate 範例
Copy Copy
1
2// 下列程式碼範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let aggregationRequest = AggregationRequest(query: [QueryPredicate(key: "key_example", value: QueryPredicate_value(), _operator: "_operator_example")], resourceName: "resourceName_example", groupBy: ["groupBy_example"], operations: [AggregationOperation(field: "field_example", op: AggregationOpType(), alias: "alias_example", expandArray: false)], sort: AggregationRequest_sort(dir: "dir_example", field: "field_example")) // AggregationRequest |
7let parentTenantId = "parentTenantId_example" // String | (選用)
8let includeStats = true // Bool | (選用)
9
10DefaultAPI.aggregate(tenantId: tenantId, aggregationRequest: aggregationRequest, parentTenantId: parentTenantId, includeStats: includeStats) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getAuditLogs Internal Link

參數

名稱 類型 位置 必填 說明
tenantId string query
limit number query
skip number query
order string query
after number query
before number query

回應

回傳: GetAuditLogs200Response

範例

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

blockFromCommentPublic Internal Link

Parameters

名稱 類型 位置 必填 說明
tenantId string query Yes
commentId string path Yes
sso string query No

Response

回傳: BlockFromCommentPublic200Response

範例

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

unBlockCommentPublic Internal Link

參數

名稱 類型 位置 必填 描述
tenantId string query
commentId string path
sso string query

回應

回傳: UnBlockCommentPublic200Response

範例

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

checkedCommentsForBlocked Internal Link

參數

Name Type Location Required Description
tenantId string query Yes
commentIds string query Yes 由逗號分隔的評論 ID 列表。
sso string query No

回應

回傳: CheckedCommentsForBlocked200Response

範例

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

blockUserFromComment Internal Link

參數

名稱 型別 位置 必填 描述
tenantId string query
id string path
userId string query
anonUserId string query

回應

回傳:BlockFromCommentPublic200Response

範例

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

createCommentPublic Internal Link

參數

Name Type Location Required Description
tenantId string path
urlId string query
broadcastId string query
sessionId string query
sso string query

回應

回傳: CreateCommentPublic200Response

範例

createCommentPublic 範例
Copy Copy
1
2// 下列程式範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let broadcastId = "broadcastId_example" // String |
8let commentData = CommentData(date: 123, localDateString: "localDateString_example", localDateHours: 123, commenterName: "commenterName_example", commenterEmail: "commenterEmail_example", commenterLink: "commenterLink_example", comment: "comment_example", productId: 123, userId: "userId_example", avatarSrc: "avatarSrc_example", parentId: "parentId_example", mentions: [CommentUserMentionInfo(id: "id_example", tag: "tag_example", rawTag: "rawTag_example", type: "type_example", sent: false)], hashTags: [CommentUserHashTagInfo(id: "id_example", tag: "tag_example", url: "url_example", retain: false)], pageTitle: "pageTitle_example", isFromMyAccountPage: false, url: "url_example", urlId: "urlId_example", meta: 123, moderationGroupIds: ["moderationGroupIds_example"], rating: 123, fromOfflineRestore: false, autoplayDelayMS: 123, feedbackIds: ["feedbackIds_example"], questionValues: "TODO") // CommentData |
9let sessionId = "sessionId_example" // String | (選用)
10let sso = "sso_example" // String | (選用)
11
12PublicAPI.createCommentPublic(tenantId: tenantId, urlId: urlId, broadcastId: broadcastId, commentData: commentData, sessionId: sessionId, sso: sso) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

deleteComment Internal Link

參數

Name Type Location Required Description
tenantId string query Yes
id string path Yes
contextUserId string query No
isLive boolean query No

回應

回傳: DeleteComment200Response

範例

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

deleteCommentPublic Internal Link

參數

Name Type Location Required Description
tenantId string path
commentId string path
broadcastId string query
editKey string query
sso string query

回應

回傳: DeleteCommentPublic200Response

範例

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

deleteCommentVote Internal Link

參數

名稱 類型 位置 必填 說明
tenantId string path
commentId string path
voteId string path
urlId string query
broadcastId string query
editKey string query
sso string query

回應

回傳: DeleteCommentVote200Response

範例

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

flagComment Internal Link

參數

Name Type Location Required Description
tenantId string query
id string path
userId string query
anonUserId string query

回應

回傳: FlagComment200Response

範例

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

getComment Internal Link

參數

名稱 類型 位置 必填 說明
tenantId string query
id string path

回應

回傳: GetComment200Response

範例

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

getComments Internal Link

參數

名稱 型別 位置 必填 描述
tenantId string query
page integer query
limit integer query
skip integer query
asTree boolean query
skipChildren integer query
limitChildren integer query
maxTreeDepth integer query
urlId string query
userId string query
anonUserId string query
contextUserId string query
hashTag string query
parentId string query
direction string query

回應

回傳: GetComments200Response

範例

getComments 範例
Copy Copy
1
2// 以下程式碼範例仍為測試版本。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let page = 987 // Int | (選填)
7let limit = 987 // Int | (選填)
8let skip = 987 // Int | (選填)
9let asTree = true // Bool | (選填)
10let skipChildren = 987 // Int | (選填)
11let limitChildren = 987 // Int | (選填)
12let maxTreeDepth = 987 // Int | (選填)
13let urlId = "urlId_example" // String | (選填)
14let userId = "userId_example" // String | (選填)
15let anonUserId = "anonUserId_example" // String | (選填)
16let contextUserId = "contextUserId_example" // String | (選填)
17let hashTag = "hashTag_example" // String | (選填)
18let parentId = "parentId_example" // String | (選填)
19let direction = SortDirections() // SortDirections | (選填)
20
21DefaultAPI.getComments(tenantId: tenantId, page: page, limit: limit, skip: skip, asTree: asTree, skipChildren: skipChildren, limitChildren: limitChildren, maxTreeDepth: maxTreeDepth, urlId: urlId, userId: userId, anonUserId: anonUserId, contextUserId: contextUserId, hashTag: hashTag, parentId: parentId, direction: direction) { (response, error) in
22 guard error == nil else {
23 print(error)
24 return
25 }
26
27 if (response) {
28 dump(response)
29 }
30}
31

getCommentsPublic Internal Link

req tenantId urlId

參數

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

回應

回傳: GetCommentsPublic200Response

範例

getCommentsPublic 範例
Copy Copy
1
2// 下列程式碼範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let page = 987 // Int | (可選)
8let direction = SortDirections() // SortDirections | (可選)
9let sso = "sso_example" // String | (可選)
10let skip = 987 // Int | (可選)
11let skipChildren = 987 // Int | (可選)
12let limit = 987 // Int | (可選)
13let limitChildren = 987 // Int | (可選)
14let countChildren = true // Bool | (可選)
15let fetchPageForCommentId = "fetchPageForCommentId_example" // String | (可選)
16let includeConfig = true // Bool | (可選)
17let countAll = true // Bool | (可選)
18let includei10n = true // Bool | (可選)
19let locale = "locale_example" // String | (可選)
20let modules = "modules_example" // String | (可選)
21let isCrawler = true // Bool | (可選)
22let includeNotificationCount = true // Bool | (可選)
23let asTree = true // Bool | (可選)
24let maxTreeDepth = 987 // Int | (可選)
25let useFullTranslationIds = true // Bool | (可選)
26let parentId = "parentId_example" // String | (可選)
27let searchText = "searchText_example" // String | (可選)
28let hashTags = ["inner_example"] // [String] | (可選)
29let userId = "userId_example" // String | (可選)
30let customConfigStr = "customConfigStr_example" // String | (可選)
31let afterCommentId = "afterCommentId_example" // String | (可選)
32let beforeCommentId = "beforeCommentId_example" // String | (可選)
33
34PublicAPI.getCommentsPublic(tenantId: tenantId, urlId: urlId, page: page, direction: direction, sso: sso, skip: skip, skipChildren: skipChildren, limit: limit, limitChildren: limitChildren, countChildren: countChildren, fetchPageForCommentId: fetchPageForCommentId, includeConfig: includeConfig, countAll: countAll, includei10n: includei10n, locale: locale, modules: modules, isCrawler: isCrawler, includeNotificationCount: includeNotificationCount, asTree: asTree, maxTreeDepth: maxTreeDepth, useFullTranslationIds: useFullTranslationIds, parentId: parentId, searchText: searchText, hashTags: hashTags, userId: userId, customConfigStr: customConfigStr, afterCommentId: afterCommentId, beforeCommentId: beforeCommentId) { (response, error) in
35 guard error == nil else {
36 print(error)
37 return
38 }
39
40 if (response) {
41 dump(response)
42 }
43}
44

getCommentText Internal Link

參數

Name Type Location Required Description
tenantId string path
commentId string path
editKey string query
sso string query

回應

回傳: GetCommentText200Response

範例

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

getCommentVoteUserNames Internal Link

參數

名稱 Type 位置 必填 說明
tenantId string path Yes
commentId string path Yes
dir integer query Yes
sso string query No

回應

回傳: GetCommentVoteUserNames200Response

範例

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

lockComment Internal Link

參數

名稱 類型 位置 必填 描述
tenantId string path Yes
commentId string path Yes
broadcastId string query Yes
sso string query No

回應

回傳: LockComment200Response

範例

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

pinComment Internal Link

參數

Name Type Location Required Description
tenantId string path
commentId string path
broadcastId string query
sso string query

回應

回傳: PinComment200Response

範例

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

saveComment Internal Link

參數

名稱 類型 Location 必填 說明
tenantId string query
isLive boolean query
doSpamCheck boolean query
sendEmails boolean query
populateNotifications boolean query

Response

回傳: SaveComment200Response

範例

saveComment 範例
Copy Copy
1
2// 下列程式碼範例仍在測試階段。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createCommentParams = CreateCommentParams(date: 123, localDateString: "localDateString_example", localDateHours: 123, commenterName: "commenterName_example", commenterEmail: "commenterEmail_example", commenterLink: "commenterLink_example", comment: "comment_example", productId: 123, userId: "userId_example", avatarSrc: "avatarSrc_example", parentId: "parentId_example", mentions: [CommentUserMentionInfo(id: "id_example", tag: "tag_example", rawTag: "rawTag_example", type: "type_example", sent: false)], hashTags: [CommentUserHashTagInfo(id: "id_example", tag: "tag_example", url: "url_example", retain: false)], pageTitle: "pageTitle_example", isFromMyAccountPage: false, url: "url_example", urlId: "urlId_example", meta: 123, moderationGroupIds: ["moderationGroupIds_example"], rating: 123, fromOfflineRestore: false, autoplayDelayMS: 123, feedbackIds: ["feedbackIds_example"], questionValues: "TODO", approved: false, domain: "domain_example", ip: "ip_example", isPinned: false, locale: "locale_example", reviewed: false, verified: false, votes: 123, votesDown: 123, votesUp: 123) // CreateCommentParams |
7let isLive = true // Bool | (選用)
8let doSpamCheck = true // Bool | (選用)
9let sendEmails = true // Bool | (選用)
10let populateNotifications = true // Bool | (選用)
11
12DefaultAPI.saveComment(tenantId: tenantId, createCommentParams: createCommentParams, isLive: isLive, doSpamCheck: doSpamCheck, sendEmails: sendEmails, populateNotifications: populateNotifications) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

saveCommentsBulk Internal Link

參數

Name Type Location Required Description
tenantId string query
isLive boolean query
doSpamCheck boolean query
sendEmails boolean query
populateNotifications boolean query

回傳

回傳: [SaveComment200Response]

範例

saveCommentsBulk 範例
Copy Copy
1
2// 以下範例程式碼仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createCommentParams = [CreateCommentParams(date: 123, localDateString: "localDateString_example", localDateHours: 123, commenterName: "commenterName_example", commenterEmail: "commenterEmail_example", commenterLink: "commenterLink_example", comment: "comment_example", productId: 123, userId: "userId_example", avatarSrc: "avatarSrc_example", parentId: "parentId_example", mentions: [CommentUserMentionInfo(id: "id_example", tag: "tag_example", rawTag: "rawTag_example", type: "type_example", sent: false)], hashTags: [CommentUserHashTagInfo(id: "id_example", tag: "tag_example", url: "url_example", retain: false)], pageTitle: "pageTitle_example", isFromMyAccountPage: false, url: "url_example", urlId: "urlId_example", meta: 123, moderationGroupIds: ["moderationGroupIds_example"], rating: 123, fromOfflineRestore: false, autoplayDelayMS: 123, feedbackIds: ["feedbackIds_example"], questionValues: "TODO", approved: false, domain: "domain_example", ip: "ip_example", isPinned: false, locale: "locale_example", reviewed: false, verified: false, votes: 123, votesDown: 123, votesUp: 123)] // [CreateCommentParams] |
7let isLive = true // Bool | (可選)
8let doSpamCheck = true // Bool | (可選)
9let sendEmails = true // Bool | (可選)
10let populateNotifications = true // Bool | (可選)
11
12DefaultAPI.saveCommentsBulk(tenantId: tenantId, createCommentParams: createCommentParams, isLive: isLive, doSpamCheck: doSpamCheck, sendEmails: sendEmails, populateNotifications: populateNotifications) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

setCommentText Internal Link

參數

名稱 類型 Location 必填 說明
tenantId string path
commentId string path
broadcastId string query
editKey string query
sso string query

回應

回傳: SetCommentText200Response

範例

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

unBlockUserFromComment Internal Link

參數

名稱 型別 位置 必填 說明
tenantId string query
id string path
userId string query
anonUserId string query

回應

回傳:UnBlockCommentPublic200Response

範例

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

unFlagComment Internal Link

參數

名稱 類型 位置 必填 描述
tenantId string query Yes
id string path Yes
userId string query No
anonUserId string query No

回應

回傳: FlagComment200Response

範例

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

unLockComment Internal Link

參數

名稱 類型 位置 必填 說明
tenantId string path Yes
commentId string path Yes
broadcastId string query Yes
sso string query No

回應

回傳: LockComment200Response

範例

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

unPinComment Internal Link

參數

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

回應

回傳: PinComment200Response

範例

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

updateComment Internal Link

參數

名稱 型別 位置 是否必填 描述
tenantId string query
id string path
contextUserId string query
doSpamCheck boolean query
isLive boolean query

回應

回傳: FlagCommentPublic200Response

範例

updateComment 範例
Copy Copy
1
2// 下列程式範例仍處於 Beta 階段。如遇任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updatableCommentParams = UpdatableCommentParams(urlId: "urlId_example", urlIdRaw: "urlIdRaw_example", url: "url_example", pageTitle: "pageTitle_example", userId: "userId_example", commenterEmail: "commenterEmail_example", commenterName: "commenterName_example", commenterLink: "commenterLink_example", comment: "comment_example", commentHTML: "commentHTML_example", parentId: "parentId_example", date: 123, localDateString: "localDateString_example", localDateHours: 123, votes: 123, votesUp: 123, votesDown: 123, expireAt: Date(), verified: false, verifiedDate: Date(), notificationSentForParent: false, notificationSentForParentTenant: false, reviewed: false, externalId: "externalId_example", externalParentId: "externalParentId_example", avatarSrc: "avatarSrc_example", isSpam: false, approved: false, isDeleted: false, isDeletedUser: false, isByAdmin: false, isByModerator: false, isPinned: false, isLocked: false, flagCount: 123, displayLabel: "displayLabel_example", meta: FComment_meta(wpUserId: "wpUserId_example", wpPostId: "wpPostId_example"), moderationGroupIds: ["moderationGroupIds_example"], feedbackIds: ["feedbackIds_example"]) // UpdatableCommentParams |
8let contextUserId = "contextUserId_example" // String | (可選)
9let doSpamCheck = true // Bool | (可選)
10let isLive = true // Bool | (可選)
11
12DefaultAPI.updateComment(tenantId: tenantId, id: id, updatableCommentParams: updatableCommentParams, contextUserId: contextUserId, doSpamCheck: doSpamCheck, isLive: isLive) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

voteComment Internal Link


參數

Name Type Location Required Description
tenantId string path Yes
commentId string path Yes
urlId string query Yes
broadcastId string query Yes
sessionId string query No
sso string query No

回應

回傳: VoteComment200Response

範例

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

addDomainConfig Internal Link

參數

Name Type Location Required Description
tenantId string query

回應

回傳: AddDomainConfig200Response

範例

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

deleteDomainConfig Internal Link

參數

名稱 類型 位置 必要 說明
tenantId string query Yes
domain string path Yes

回應

回傳: DeleteDomainConfig200Response

範例

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

getDomainConfig Internal Link

參數

名稱 類型 位置 必填 說明
tenantId string query
domain string path

回應

回傳: GetDomainConfig200Response

範例

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

getDomainConfigs Internal Link

參數

Name Type Location Required Description
tenantId string query Yes

回應

回傳: GetDomainConfigs200Response

範例

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

patchDomainConfig Internal Link

參數

名稱 類型 位置 必需 說明
tenantId string query
domainToUpdate string path

回應

回傳: GetDomainConfig200Response

範例

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

putDomainConfig Internal Link

Parameters

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

Response

Returns: GetDomainConfig200Response

Example

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

createEmailTemplate Internal Link

參數

Name Type Location Required Description
tenantId string query

回應

回傳: CreateEmailTemplate200Response

範例

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

deleteEmailTemplate Internal Link

參數

Name Type Location Required Description
tenantId string query
id string path

回應

回傳: FlagCommentPublic200Response

範例

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

deleteEmailTemplateRenderError Internal Link

參數

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

回應

Returns: FlagCommentPublic200Response

範例

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

getEmailTemplate Internal Link

參數

名稱 類型 位置 必填 說明
tenantId string query
id string path

回應

回傳: GetEmailTemplate200Response

範例

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

getEmailTemplateDefinitions Internal Link

參數

名稱 類型 位置 必填 說明
tenantId string query

回應

回傳: GetEmailTemplateDefinitions200Response

範例

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

getEmailTemplateRenderErrors Internal Link

參數

名稱 類型 位置 必填 說明
tenantId string query
id string path
skip number query

回應

回傳: GetEmailTemplateRenderErrors200Response

範例

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

getEmailTemplates Internal Link

參數

名稱 類型 位置 必填 說明
tenantId string query
skip number query

回應

回傳: GetEmailTemplates200Response

範例

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

renderEmailTemplate Internal Link

參數

Name Type Location Required Description
tenantId string query
locale string query

回應

回傳: RenderEmailTemplate200Response

範例

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

updateEmailTemplate Internal Link

參數

Name Type Location Required Description
tenantId string query
id string path

回應

回傳: FlagCommentPublic200Response

範例

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

getEventLog Internal Link

req tenantId urlId userIdWS

Parameters

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

Response

回傳: GetEventLog200Response

Example

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

getGlobalEventLog Internal Link

req tenantId urlId userIdWS

參數

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

回應

回傳: GetEventLog200Response

範例

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

createFeedPost Internal Link

參數

Name Type Location Required Description
tenantId string query
broadcastId string query
isLive boolean query
doSpamCheck boolean query
skipDupCheck boolean query

回應

回傳: CreateFeedPost200Response

範例

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

createFeedPostPublic Internal Link

參數

名稱 類型 位置 必填 說明
tenantId string path
broadcastId string query
sso string query

回應

回傳:CreateFeedPostPublic200Response

範例

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

deleteFeedPostPublic Internal Link

參數

名稱 類型 Location 必填 描述
tenantId string path
postId string path
broadcastId string query
sso string query

回應

回傳: DeleteFeedPostPublic200Response

範例

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

getFeedPosts Internal Link

req tenantId afterId

參數

Name Type Location Required Description
tenantId string query
afterId string query
limit integer query
tags array query

回應

回傳: GetFeedPosts200Response

範例

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

getFeedPostsPublic Internal Link


req tenantId afterId

參數

名稱 型別 位置 必填 說明
tenantId string path
afterId string query
limit integer query
tags array query
sso string query
isCrawler boolean query
includeUserInfo boolean query

回應

回傳: GetFeedPostsPublic200Response

範例

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

getFeedPostsStats Internal Link

參數

名稱 類型 位置 必填 說明
tenantId string path
postIds array query
sso string query

回應

回傳: GetFeedPostsStats200Response

範例

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

getUserReactsPublic Internal Link

參數

名稱 類型 位置 必填 描述
tenantId string 路徑
postIds array 查詢
sso string 查詢

回應

回傳: GetUserReactsPublic200Response

範例

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

reactFeedPostPublic Internal Link

參數

Name Type Location Required Description
tenantId string path
postId string path
isUndo boolean query
broadcastId string query
sso string query

回應

回傳: ReactFeedPostPublic200Response

範例

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

updateFeedPost Internal Link

參數

名稱 型別 位置 必填 說明
tenantId string query
id string path

回應

回傳:FlagCommentPublic200Response

範例

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

updateFeedPostPublic Internal Link

參數

Name Type Location Required Description
tenantId string path
postId string path
broadcastId string query
sso string query

回應

回傳: CreateFeedPostPublic200Response

範例

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

flagCommentPublic Internal Link

參數

Name Type Location Required Description
tenantId string query
commentId string path
isFlagged boolean query
sso string query

回應

回傳: FlagCommentPublic200Response

範例

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

addHashTag Internal Link

參數

名稱 類型 位置 必填 描述
tenantId string query

回應

回傳:AddHashTag200Response

範例

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

addHashTagsBulk Internal Link

參數

Name Type Location Required Description
tenantId string query

回傳

回傳: AddHashTagsBulk200Response

範例

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

deleteHashTag Internal Link

參數

名稱 類型 位置 必填 描述
tag string path
tenantId string query

回應

回傳: FlagCommentPublic200Response

範例

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

getHashTags Internal Link

參數

名稱 Type Location 必填 說明
tenantId string query
page number query

回應

回傳: GetHashTags200Response

範例

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

patchHashTag Internal Link

參數

Name Type Location Required Description
tag string path
tenantId string query

回應

回傳: PatchHashTag200Response

範例

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

createModerator Internal Link

參數

名稱 型別 位置 必填 說明
tenantId string query

回應

回傳:CreateModerator200Response

範例

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

deleteModerator Internal Link

參數

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

回應

回傳: FlagCommentPublic200Response

範例

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

getModerator Internal Link

參數

名稱 類型 位置 必填 說明
tenantId string query
id string path

回應

回傳:GetModerator200Response

範例

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

getModerators Internal Link

參數

名稱 類型 位置 必填 說明
tenantId string query
skip number query

回應

回傳: GetModerators200Response

範例

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

sendInvite Internal Link

參數

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

回應

回傳: FlagCommentPublic200Response

範例

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

updateModerator Internal Link

參數

名稱 類型 位置 必填 描述
tenantId string query Yes
id string path Yes

回應

返回: FlagCommentPublic200Response

範例

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

deleteNotificationCount Internal Link


參數

名稱 類型 位置 必填 描述
tenantId string query
id string path

回應

回傳:FlagCommentPublic200Response

範例

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

getCachedNotificationCount Internal Link

參數

名稱 類型 位置 必填 說明
tenantId string query Yes
id string path Yes

回應

回傳: GetCachedNotificationCount200Response

範例

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

getNotificationCount Internal Link

參數

Name Type Location Required Description
tenantId string query
userId string query
urlId string query
fromCommentId string query
viewed boolean query
type string query

回應

回傳: GetNotificationCount200Response

範例

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

getNotifications Internal Link

參數

Name Type Location Required Description
tenantId string query
userId string query
urlId string query
fromCommentId string query
viewed boolean query
type string query
skip number query

回應

回傳值: GetNotifications200Response

範例

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

updateNotification Internal Link

參數

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

回應

回傳: FlagCommentPublic200Response

範例

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

addPage Internal Link

參數

名稱 類型 位置 必填 說明
tenantId string query

回應

回傳: AddPageAPIResponse

範例

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

deletePage Internal Link

參數

Name Type Location Required Description
tenantId string query
id string path

回傳

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

getPageByURLId Internal Link

參數

名稱 Type 位置 必填 描述
tenantId string 查詢
urlId string 查詢

回應

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

getPages Internal Link

參數

名稱 型別 位置 必填 描述
tenantId string query

回應

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

patchPage Internal Link

參數

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

回傳

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

deletePendingWebhookEvent Internal Link

參數

Name Type Location Required Description
tenantId string query
id string path

回應

回傳: FlagCommentPublic200Response

範例

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

getPendingWebhookEventCount Internal Link

參數

名稱 類型 位置 必填 描述
tenantId string query
commentId string query
externalId string query
eventType string query
type string query
domain string query
attemptCountGT number query

回應

回傳: GetPendingWebhookEventCount200Response

範例

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

getPendingWebhookEvents Internal Link

參數

Name Type Location Required Description
tenantId string 查詢
commentId string 查詢
externalId string 查詢
eventType string 查詢
type string 查詢
domain string 查詢
attemptCountGT number 查詢
skip number 查詢

回應

回傳: GetPendingWebhookEvents200Response

範例

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

createQuestionConfig Internal Link

參數

名稱 類型 位置 必填 說明
tenantId string query

回應

回傳: CreateQuestionConfig200Response

範例

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

deleteQuestionConfig Internal Link

參數

名稱 類型 位置 必填 說明
tenantId string query
id string path

回應

回傳: FlagCommentPublic200Response

範例

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

getQuestionConfig Internal Link

參數

名稱 類型 所在位置 必填 說明
tenantId string query
id string path

回應

回傳:GetQuestionConfig200Response

範例

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

getQuestionConfigs Internal Link

參數

Name Type Location Required Description
tenantId string query
skip number query

回傳

回傳: GetQuestionConfigs200Response

範例

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

updateQuestionConfig Internal Link

參數

名稱 類型 位置 是否必填 說明
tenantId string query
id string path

回應

回傳: FlagCommentPublic200Response

範例

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

createQuestionResult Internal Link

參數

名稱 Type Location 必填 說明
tenantId string query

回應

回傳: CreateQuestionResult200Response

範例

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

deleteQuestionResult Internal Link


參數

名稱 類型 位置 必填 描述
tenantId string query
id string path

回應

回傳: FlagCommentPublic200Response

範例

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

getQuestionResult Internal Link

參數

Name Type Location Required Description
tenantId string query
id string path

回應

回傳:GetQuestionResult200Response

範例

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

getQuestionResults Internal Link

參數

Name Type Location Required Description
tenantId string query
urlId string query
userId string query
startDate string query
questionId string query
questionIds string query
skip number query

回應

回傳: GetQuestionResults200Response

範例

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

updateQuestionResult Internal Link

參數

Name Type Location Required Description
tenantId string query
id string path

回應

回傳: FlagCommentPublic200Response

範例

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

aggregateQuestionResults Internal Link

參數

名稱 類型 位置 必填 描述
tenantId string query
questionId string query
questionIds array query
urlId string query
timeBucket string query
startDate string query
forceRecalculate boolean query

回應

回傳: AggregateQuestionResults200Response

範例

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

bulkAggregateQuestionResults Internal Link

參數

Name Type Location Required Description
tenantId string query Yes
forceRecalculate boolean query No

回應

Returns: BulkAggregateQuestionResults200Response

範例

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

combineCommentsWithQuestionResults Internal Link

參數

Name Type Location Required Description
tenantId string query
questionId string query
questionIds array query
urlId string query
startDate string query
forceRecalculate boolean query
minValue number query
maxValue number query
limit number query

回應

回傳: CombineCommentsWithQuestionResults200Response

範例

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

addSSOUser Internal Link

參數

名稱 類型 位置 必填 說明
tenantId string query

回應

回傳: AddSSOUserAPIResponse

範例

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

deleteSSOUser Internal Link

參數

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

回應

回傳: DeleteSSOUserAPIResponse

範例

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

getSSOUserByEmail Internal Link

參數

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

回應

回傳: GetSSOUserByEmailAPIResponse

範例

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

getSSOUserById Internal Link

參數

名稱 類型 位置 必填 說明
tenantId string query
id string path

回應

回傳:GetSSOUserByIdAPIResponse

範例

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

getSSOUsers Internal Link

參數

名稱 類型 位置 必填 描述
tenantId string query
skip integer query

回應

回傳: GetSSOUsers200Response

範例

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

patchSSOUser Internal Link


參數

Name Type Location Required Description
tenantId string query Yes
id string path Yes
updateComments boolean query No

回應

回傳: PatchSSOUserAPIResponse

範例

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

putSSOUser Internal Link

參數

名稱 類型 位置 必填 描述
tenantId string query
id string path
updateComments boolean query

回應

傳回: PutSSOUserAPIResponse

範例

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

createSubscription Internal Link

參數

名稱 類型 位置 必填 說明
tenantId string query Yes

回應

回傳: CreateSubscriptionAPIResponse

範例

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

deleteSubscription Internal Link

參數

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

回應

回傳: DeleteSubscriptionAPIResponse

範例

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

getSubscriptions Internal Link

參數

名稱 類型 位置 必填 描述
tenantId string query
userId string query

回應

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

getTenantDailyUsages Internal Link

參數

Name Type Location Required Description
tenantId string query
yearNumber number query
monthNumber number query
dayNumber number query
skip number query

回應

回傳: GetTenantDailyUsages200Response

範例

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

createTenantPackage Internal Link

參數

名稱 類型 位置 必填 描述
tenantId string query

回應

回傳: CreateTenantPackage200Response

範例

createTenantPackage 範例
Copy Copy
1
2// 以下程式範例仍為測試版。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createTenantPackageBody = CreateTenantPackageBody(name: "name_example", monthlyCostUSD: 123, yearlyCostUSD: 123, monthlyStripePlanId: "monthlyStripePlanId_example", yearlyStripePlanId: "yearlyStripePlanId_example", maxMonthlyPageLoads: 123, maxMonthlyAPICredits: 123, maxMonthlySmallWidgetsCredits: 123, maxMonthlyComments: 123, maxConcurrentUsers: 123, maxTenantUsers: 123, maxSSOUsers: 123, maxModerators: 123, maxDomains: 123, maxWhiteLabeledTenants: 123, maxMonthlyEventLogRequests: 123, 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, flexChatGPTCostCents: 123, flexChatGPTUnit: 123, flexMinimumCostCents: 123, flexManagedTenantCostCents: 123, flexSSOAdminCostCents: 123, flexSSOAdminUnit: 123, flexSSOModeratorCostCents: 123, flexSSOModeratorUnit: 123) // CreateTenantPackageBody |
7
8DefaultAPI.createTenantPackage(tenantId: tenantId, createTenantPackageBody: createTenantPackageBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

deleteTenantPackage Internal Link

參數

名稱 型別 位置 必要 說明
tenantId string query
id string path

回應

回傳: FlagCommentPublic200Response

範例

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

getTenantPackage Internal Link

參數

名稱 類型 位置 必填 描述
tenantId string query Yes
id string path Yes

回應

回傳: GetTenantPackage200Response

範例

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

getTenantPackages Internal Link


參數

名稱 型別 位置 必填 說明
tenantId string query Yes
skip number query No

回應

回傳: GetTenantPackages200Response

範例

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

replaceTenantPackage Internal Link

參數

名稱 類型 位置 必填 描述
tenantId string query Yes
id string path Yes

回應

回傳: FlagCommentPublic200Response

範例

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

updateTenantPackage Internal Link

參數

Name Type Location Required Description
tenantId string query
id string path

回應

回傳: FlagCommentPublic200Response

範例

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

createTenantUser Internal Link


參數

名稱 類型 位置 必填 描述
tenantId string query

回應

回傳: CreateTenantUser200Response

範例

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

deleteTenantUser Internal Link

參數

名稱 類型 位置 必填 描述
tenantId string query
id string path
deleteComments string query
commentDeleteMode string query

回應

回傳: FlagCommentPublic200Response

範例

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

getTenantUser Internal Link

參數

名稱 類型 位置 必填 說明
tenantId string query
id string path

回應

回傳:GetTenantUser200Response

範例

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

getTenantUsers Internal Link

參數

名稱 類型 位置 必要 描述
tenantId string query
skip number query

回應

回傳: GetTenantUsers200Response

範例

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

replaceTenantUser Internal Link

參數

名稱 類型 位置 必填 描述
tenantId string query
id string path
updateComments string query

回應

回傳: FlagCommentPublic200Response

範例

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

參數

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

回應

回傳: FlagCommentPublic200Response

範例

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

updateTenantUser Internal Link

參數

名稱 Type Location 必需 說明
tenantId string query
id string path
updateComments string query

回應

回傳: FlagCommentPublic200Response

範例

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

createTenant Internal Link


參數

名稱 類型 位置 必填 描述
tenantId string query

回應

回傳: CreateTenant200Response

範例

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

deleteTenant Internal Link

參數

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

回應

回傳: FlagCommentPublic200Response

範例

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

getTenant Internal Link

參數

Name Type Location Required Description
tenantId string query
id string path

回應

回傳: GetTenant200Response

範例

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

getTenants Internal Link

參數

Name Type Location Required Description
tenantId string query Yes
meta string query No
skip number query No

回應

回傳: GetTenants200Response

範例

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

updateTenant Internal Link

參數

名稱 Type Location 必填 描述
tenantId string query
id string path

回應

回傳: FlagCommentPublic200Response

範例

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

uploadImage Internal Link

上傳並調整圖片大小

參數

名稱 類型 位置 必填 說明
tenantId string path Yes
sizePreset string query No 大小預設: "Default" (1000x1000px) 或 "CrossPlatform" (為常用裝置產生尺寸)
urlId string query No 上傳發生的頁面 ID,用以設定

回應

回傳: UploadImageResponse

範例

uploadImage 範例
Copy Copy
1
2// 下列程式範例仍為測試版。如有問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let file = URL(string: "https://example.com")! // URL |
7let sizePreset = SizePreset() // SizePreset | 大小預設:\"Default\" (1000x1000px) 或 \"CrossPlatform\" (為常用裝置產生尺寸) (選填)
8let urlId = "urlId_example" // String | 上傳發生的頁面 ID,用以設定 (選填)
9
10PublicAPI.uploadImage(tenantId: tenantId, file: file, sizePreset: sizePreset, urlId: urlId) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getUserBadgeProgressById Internal Link

參數

Name Type Location Required Description
tenantId string query
id string path

回應

回傳: GetUserBadgeProgressById200Response

範例

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

getUserBadgeProgressByUserId Internal Link

參數

名稱 類型 位置 必填 描述
tenantId string query
userId string path

回應

回傳:GetUserBadgeProgressById200Response

範例

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

getUserBadgeProgressList Internal Link

參數

Name Type Location Required Description
tenantId string query
userId string query
limit number query
skip number query

回應

回傳:GetUserBadgeProgressList200Response

範例

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

createUserBadge Internal Link

參數

Name Type Location Required Description
tenantId string query

回傳

回傳: CreateUserBadge200Response

範例

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

deleteUserBadge Internal Link

參數

Name Type Location Required Description
tenantId string query
id string path

回應

回傳: UpdateUserBadge200Response

範例

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

getUserBadge Internal Link

參數

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

回應

回傳: GetUserBadge200Response

範例

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

getUserBadges Internal Link

參數

名稱 型別 位置 必填 描述
tenantId string query
userId string query
badgeId string query
type number query
displayedOnComments boolean query
limit number query
skip number query

回應

回傳: GetUserBadges200Response

範例

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

updateUserBadge Internal Link

參數

名稱 型別 位置 必填 說明
tenantId string query
id string path

回應

回傳: UpdateUserBadge200Response

範例

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

getUserNotificationCount Internal Link

參數

Name Type Location Required Description
tenantId string query
sso string query

回應

回傳: GetUserNotificationCount200Response

範例

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

getUserNotifications Internal Link

參數

名稱 類型 位置 必填 說明
tenantId string query
pageSize integer query
afterId string query
includeContext boolean query
afterCreatedAt integer query
unreadOnly boolean query
dmOnly boolean query
noDm boolean query
includeTranslations boolean query
sso string query

回應

回傳: GetUserNotifications200Response

範例

getUserNotifications 範例
Copy Copy
1
2// 以下程式碼範例仍為 beta。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let pageSize = 987 // Int | (可選)
7let afterId = "afterId_example" // String | (可選)
8let includeContext = true // Bool | (可選)
9let afterCreatedAt = 987 // Int64 | (可選)
10let unreadOnly = true // Bool | (可選)
11let dmOnly = true // Bool | (可選)
12let noDm = true // Bool | (可選)
13let includeTranslations = true // Bool | (可選)
14let sso = "sso_example" // String | (可選)
15
16PublicAPI.getUserNotifications(tenantId: tenantId, pageSize: pageSize, afterId: afterId, includeContext: includeContext, afterCreatedAt: afterCreatedAt, unreadOnly: unreadOnly, dmOnly: dmOnly, noDm: noDm, includeTranslations: includeTranslations, sso: sso) { (response, error) in
17 guard error == nil else {
18 print(error)
19 return
20 }
21
22 if (response) {
23 dump(response)
24 }
25}
26

resetUserNotificationCount Internal Link

參數

名稱 類型 位置 必填 描述
tenantId string query
sso string query

回應

回傳:ResetUserNotifications200Response

範例

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

resetUserNotifications Internal Link

參數

名稱 類型 位置 必填 說明
tenantId string query
afterId string query
afterCreatedAt integer query
unreadOnly boolean query
dmOnly boolean query
noDm boolean query
sso string query

回應

回傳: ResetUserNotifications200Response

範例

resetUserNotifications 範例
Copy Copy
1
2// 下列程式範例仍為 Beta。如有任何問題,請透過 http://github.com/OpenAPITools/openapi-generator/issues/new 回報
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let afterId = "afterId_example" // String | (選用)
7let afterCreatedAt = 987 // Int64 | (選用)
8let unreadOnly = true // Bool | (選用)
9let dmOnly = true // Bool | (選用)
10let noDm = true // Bool | (選用)
11let sso = "sso_example" // String | (選用)
12
13PublicAPI.resetUserNotifications(tenantId: tenantId, afterId: afterId, afterCreatedAt: afterCreatedAt, unreadOnly: unreadOnly, dmOnly: dmOnly, noDm: noDm, sso: sso) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

updateUserNotificationCommentSubscriptionStatus Internal Link

啟用或停用特定留言的通知。

參數

Name Type Location Required Description
tenantId string query
notificationId string path
optedInOrOut string path
commentId string query
sso string query

回傳

回傳: UpdateUserNotificationStatus200Response

範例

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

updateUserNotificationPageSubscriptionStatus Internal Link

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

參數

名稱 類型 位置 必填 描述
tenantId string query
urlId string query
url string query
pageTitle string query
subscribedOrUnsubscribed string path
sso string query

回應

回傳:UpdateUserNotificationStatus200Response

範例

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

updateUserNotificationStatus Internal Link

參數

名稱 類型 位置 必填 描述
tenantId string query
notificationId string path
newStatus string path
sso string query

回應

回傳: UpdateUserNotificationStatus200Response

範例

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

getUserPresenceStatuses Internal Link

參數

名稱 類型 位置 必填 描述
tenantId string query
urlIdWS string query
userIds string query

回應

回傳:GetUserPresenceStatuses200Response

範例

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

searchUsers Internal Link

參數

Name Type Location Required Description
tenantId string path
urlId string query
usernameStartsWith string query
mentionGroupIds array query
sso string query

回應

回傳: SearchUsers200Response

範例

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

getUser Internal Link

參數

Name Type Location Required Description
tenantId string query
id string path

回應

回傳: GetUser200Response

範例

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

createVote Internal Link

參數

名稱 類型 位置 必填 說明
tenantId string query
commentId string query
direction string query
userId string query
anonUserId string query

回應

回傳: VoteComment200Response

範例

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

deleteVote Internal Link

參數

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

回傳

回傳: DeleteCommentVote200Response

範例

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

getVotes Internal Link

參數

名稱 類型 位置 必填 描述
tenantId string query
urlId string query

回應

回傳: GetVotes200Response

範例

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

getVotesForUser Internal Link

參數

Name Type Location Required Description
tenantId string query
urlId string query
userId string query
anonUserId string query

回應

回傳: GetVotesForUser200Response

範例

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

需要幫助?

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

貢獻

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