FastComments.com

FastComments Swift SDK

これは FastComments の公式 Swift SDK です。

FastComments API の公式 Swift SDK

リポジトリ

GitHubで表示


インストール Internal Link

Swift パッケージマネージャ

以下を Package.swift ファイルに追加してください:

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

または Xcode で:

  1. File > パッケージを追加...
  2. リポジトリ URL を入力してください: https://github.com/fastcomments/fastcomments-swift.git
  3. 使用したいバージョンを選択してください

要件

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

ライブラリの内容 Internal Link

FastComments Swift SDK はいくつかのモジュールで構成されています:

  • Client Module - FastComments REST API 用の API クライアント

    • すべての API モデルに対する完全な型定義
    • 認証済み(DefaultAPI)、パブリック(PublicAPI)、およびモデレーション(ModerationAPI)のメソッド
    • 完全な async/await のサポート
    • 詳細な API ドキュメントは client/README.md を参照してください
  • SSO Module - サーバーサイドのシングルサインオン用ユーティリティ

    • ユーザー認証のための安全なトークン生成
    • シンプルな SSO モードとセキュアな SSO モードの両方をサポート
    • CryptoKit を使用した HMAC-SHA256 ベースのトークン署名

クイックスタート Internal Link

パブリック API の使用

import FastCommentsSwift

// ページのコメントを取得
do {
    let response = try await PublicAPI.getCommentsPublic(
        tenantId: "your-tenant-id",
        urlId: "page-url-id"
    )

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

認証済み API の使用

import FastCommentsSwift

// 共有設定に API キーを設定 (x-api-key ヘッダーとして送信されます)
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "your-api-key"

// 認証済み API を使用してコメントを取得
do {
    let response = try await DefaultAPI.getComments(
        tenantId: "your-tenant-id",
        options: .init(urlId: "page-url-id")
    )

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

モデレーション API の使用

import FastCommentsSwift

// モデレーションメソッドは、実行モデレーター用の `sso` トークンで認可されます
// (FastCommentsSSO で生成し、上記の SSO セクションを参照してください)。
do {
    let response = try await ModerationAPI.getApiComments(
        options: .init(
            page: 0,
            count: 30,
            sso: ssoToken
        )
    )

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

認証に SSO を使用

セキュア SSO(本番環境推奨)

import FastCommentsSwift

let apiKey = "your-api-key"

// セキュア SSO ユーザーデータを作成 (サーバー側のみ!)
let userData = SecureSSOUserData(
    id: "user-123",              // User ID
    email: "user@example.com",   // Email
    username: "johndoe",         // Username
    avatar: "https://example.com/avatar.jpg" // Avatar URL
)

// SSO トークンを生成
do {
    let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
    let token = try sso.createToken()

    print("SSO Token: \(token ?? "")")
    // このトークンをフロントエンドに渡して認証に使用
} catch {
    print("Error creating SSO token: \(error)")
}

シンプル SSO(開発/テスト用)

import FastCommentsSwift

// シンプル SSO ユーザーデータを作成 (API キーは不要)
let userData = SimpleSSOUserData(
    username: "johndoe",
    email: "user@example.com",
    avatar: "https://example.com/avatar.jpg"
)

// シンプル SSO トークンを生成
let sso = FastCommentsSSO.createSimple(simpleSSOUserData: userData)
do {
    let token = try sso.createToken()
    print("Simple SSO Token: \(token ?? "")")
} catch {
    print("Error creating SSO token: \(error)")
}

APIクライアント Internal Link

The FastComments SDK は 3 つの API クライアントを提供します:

PublicAPI - クライアント安全なメソッド

PublicAPI には、クライアント側のコード(iOS/macOS アプリ)から安全に呼び出せるメソッドが含まれています。これらのメソッドは:

  • API キーを必要としません
  • 認証に SSO トークンを使用できます
  • ユーザー/デバイスごとにレート制限があります
  • エンドユーザー向けアプリケーションに適しています

使用例: iOS アプリでコメントを取得・作成する

DefaultAPI - サーバー側メソッド

DefaultAPI には、API キーが必要な認証済みメソッドが含まれています。これらのメソッドは:

  • FastComments API キーが必要です
  • サーバー側のコードからのみ呼び出すべきです
  • FastComments データへのフルアクセスが可能です
  • テナントごとにレート制限があります

使用例: 管理操作、バルクデータエクスポート、ユーザー管理

ModerationAPI - モデレーターダッシュボードメソッド

ModerationAPI は、豊富なライブ・高速モデレーション API を提供します。すべての ModerationAPI メソッドは sso パラメータを受け取り、SSO または FastComments.com のセッションクッキーで認証できます。

使用例: コミュニティのモデレーター向けモデレーション体験を構築する

IMPORTANT: クライアント側のコードに API キーを決して公開しないでください。API キーはサーバー側でのみ使用すべきです。

API呼び出しの実行 Internal Link

Swift SDK は、すべての API 呼び出しにモダンな async/await 構文を使用します:

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

よくある問題 Internal Link

401 Unauthorized エラー

認証済み API を使用しているときに 401 エラーが発生する場合:

  1. API キーを確認: FastComments ダッシュボードから正しい API キーを使用していることを確認してください
  2. テナント ID を確認: テナント ID がアカウントと一致していることを確認してください
  3. API キーの形式: API キーは共有設定の x-api-key ヘッダーとして設定する必要があります:
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "YOUR_API_KEY"
  1. 間違った API の使用: 認証済み呼び出しには DefaultAPIPublicAPI ではなく)を使用していることを確認してください

SSO トークンの問題

SSO トークンが機能しない場合:

  1. 本番環境ではセキュアモードを使用: 本番環境では常に API キーと共に FastCommentsSSO.createSecure() を使用してください
  2. サーバー側のみ: セキュア SSO トークンはサーバー上で生成し、クライアントに API キーを公開しないでください
  3. ユーザーデータを確認: 必要なフィールド(id、email、username)がすべて提供されていることを確認してください
  4. トークンの有効期限: セキュア SSO トークンにはタイムスタンプが含まれ、期限切れになる可能性があります。必要に応じて新しいトークンを生成してください。

SSL/TLS エラー

SSL/TLS エラーが発生した場合:

  1. アプリの Info.plist が fastcomments.com への HTTPS 接続を許可していることを確認してください
  2. 接続をブロックする可能性のある App Transport Security の例外を使用していないか確認してください

注意事項 Internal Link

ブロードキャストID

いくつかの API 呼び出しで broadcastId を渡す必要があることがわかるでしょう。イベントを受信すると、この ID が返されます。クライアント側で楽観的に変更を適用するつもりなら(これは最良の体験を提供するため、おそらくそうするでしょう)、そのイベントを無視すべきかどうかがわかります。ここには UUID を渡してください。ID はセッション内で二度出現しない程度に十分一意である必要があります。

let broadcastId = UUID().uuidString

aggregate Internal Link

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

Parameters

名前場所必須説明
tenantIdstringqueryはい
parentTenantIdstringqueryいいえ
includeStatsbooleanqueryいいえ

Response

Returns: AggregateResponse

Example

集計例
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, options: DefaultAPI.AggregateOptions(parentTenantId: parentTenantId, includeStats: includeStats)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getAuditLogs Internal Link

Parameters

名前場所必須説明
tenantIdstringqueryYes
limitnumberqueryNo
skipnumberqueryNo
orderstringqueryNo
afternumberqueryNo
beforenumberqueryNo

Response

戻り値: GetAuditLogsResponse

Example

getAuditLogs の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new から報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let limit = 987 // Double | (オプション)
7let skip = 987 // Double | (オプション)
8let order = SORT_DIR() // SORTDIR | (オプション)
9let after = 987 // Double | (オプション)
10let before = 987 // Double | (オプション)
11
12DefaultAPI.getAuditLogs(tenantId: tenantId, options: DefaultAPI.GetAuditLogsOptions(limit: limit, skip: skip, order: order, after: after, before: before)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

logoutPublic Internal Link

レスポンス

戻り値: APIEmptyResponse

logoutPublic の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5
6PublicAPI.logoutPublic() { (response, error) in
7 guard error == nil else {
8 print(error)
9 return
10 }
11
12 if (response) {
13 dump(response)
14 }
15}
16

blockFromCommentPublic Internal Link

パラメーター

名前場所必須説明
tenantIdstringqueryはい
commentIdstringpathはい
ssostringqueryいいえ

レスポンス

戻り値: BlockSuccess

blockFromCommentPublic の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let publicBlockFromCommentParams = PublicBlockFromCommentParams(commentIds: ["commentIds_example"]) // PublicBlockFromCommentParams |
8let sso = "sso_example" // String | (オプション)
9
10PublicAPI.blockFromCommentPublic(tenantId: tenantId, commentId: commentId, publicBlockFromCommentParams: publicBlockFromCommentParams, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

unBlockCommentPublic Internal Link

パラメータ

名前Location必須説明
tenantIdstringqueryはい
commentIdstringpathはい
ssostringqueryいいえ

レスポンス

返却: UnblockSuccess

unBlockCommentPublic の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let publicBlockFromCommentParams = PublicBlockFromCommentParams(commentIds: ["commentIds_example"]) // PublicBlockFromCommentParams |
8let sso = "sso_example" // String | (オプション)
9
10PublicAPI.unBlockCommentPublic(tenantId: tenantId, commentId: commentId, publicBlockFromCommentParams: publicBlockFromCommentParams, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

checkedCommentsForBlocked Internal Link


パラメータ

名前場所必須説明
tenantIdstringqueryはい
commentIdsstringqueryはいカンマ区切りのコメントIDのリスト。
ssostringqueryいいえ

レスポンス

戻り値: CheckBlockedCommentsResponse

checkedCommentsForBlocked の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentIds = "commentIds_example" // String | カンマ区切りのコメントIDのリスト。
7let sso = "sso_example" // String | (オプション)
8
9PublicAPI.checkedCommentsForBlocked(tenantId: tenantId, commentIds: commentIds, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

blockUserFromComment Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo
anonUserIdstringqueryNo

レスポンス

戻り値: BlockSuccess

blockUserFromComment 例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let blockFromCommentParams = BlockFromCommentParams(commentIdsToCheck: ["commentIdsToCheck_example"]) // BlockFromCommentParams |
8let userId = "userId_example" // String | (オプション)
9let anonUserId = "anonUserId_example" // String | (オプション)
10
11DefaultAPI.blockUserFromComment(tenantId: tenantId, id: id, blockFromCommentParams: blockFromCommentParams, options: DefaultAPI.BlockUserFromCommentOptions(userId: userId, anonUserId: anonUserId)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

createCommentPublic Internal Link

パラメータ

名前場所必須説明
tenantIdstringpathYes
urlIdstringqueryYes
broadcastIdstringqueryYes
sessionIdstringqueryNo
ssostringqueryNo

レスポンス

返却: SaveCommentsResponseWithPresence

createCommentPublic の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new から報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let broadcastId = "broadcastId_example" // String |
8let commentData = CommentData(date: 123, localDateString: "localDateString_example", localDateHours: 123, commenterName: "commenterName_example", commenterEmail: "commenterEmail_example", commenterLink: "commenterLink_example", comment: "comment_example", productId: 123, userId: "userId_example", avatarSrc: "avatarSrc_example", parentId: "parentId_example", mentions: [CommentUserMentionInfo(id: "id_example", tag: "tag_example", rawTag: "rawTag_example", type: "type_example", sent: false)], hashTags: [CommentUserHashTagInfo(id: "id_example", tag: "tag_example", url: "url_example", retain: false)], pageTitle: "pageTitle_example", isFromMyAccountPage: false, url: "url_example", urlId: "urlId_example", meta: 123, moderationGroupIds: ["moderationGroupIds_example"], rating: 123, fromOfflineRestore: false, autoplayDelayMS: 123, feedbackIds: ["feedbackIds_example"], questionValues: "TODO", tos: false, botId: "botId_example") // CommentData |
9let sessionId = "sessionId_example" // String | (optional)
10let sso = "sso_example" // String | (optional)
11
12PublicAPI.createCommentPublic(tenantId: tenantId, urlId: urlId, broadcastId: broadcastId, commentData: commentData, options: PublicAPI.CreateCommentPublicOptions(sessionId: sessionId, sso: sso)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

deleteComment Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
contextUserIdstringqueryNo
isLivebooleanqueryNo

応答

返り値: DeleteCommentResult

deleteComment の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let contextUserId = "contextUserId_example" // String | (optional) -> (オプション)
8let isLive = true // Bool | (optional) -> (オプション)
9
10DefaultAPI.deleteComment(tenantId: tenantId, id: id, options: DefaultAPI.DeleteCommentOptions(contextUserId: contextUserId, isLive: isLive)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

deleteCommentPublic Internal Link

パラメータ

名前場所必須説明
tenantId文字列パスはい
commentId文字列パスはい
broadcastId文字列クエリはい
editKey文字列クエリいいえ
sso文字列クエリいいえ

応答

返り値: PublicAPIDeleteCommentResponse

deleteCommentPublic の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String |
8let editKey = "editKey_example" // String | (任意)
9let sso = "sso_example" // String | (任意)
10
11PublicAPI.deleteCommentPublic(tenantId: tenantId, commentId: commentId, broadcastId: broadcastId, options: PublicAPI.DeleteCommentPublicOptions(editKey: editKey, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

deleteCommentVote Internal Link

パラメータ

名前場所必須説明
tenantIdstringpathYes
commentIdstringpathYes
voteIdstringpathYes
urlIdstringqueryYes
broadcastIdstringqueryYes
editKeystringqueryNo
ssostringqueryNo

レスポンス

返却: VoteDeleteResponse

deleteCommentVote 例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let voteId = "voteId_example" // String |
8let urlId = "urlId_example" // String |
9let broadcastId = "broadcastId_example" // String |
10let editKey = "editKey_example" // String | (オプション)
11let sso = "sso_example" // String | (オプション)
12
13PublicAPI.deleteCommentVote(tenantId: tenantId, commentId: commentId, voteId: voteId, urlId: urlId, broadcastId: broadcastId, options: PublicAPI.DeleteCommentVoteOptions(editKey: editKey, sso: sso)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

flagComment Internal Link

パラメータ

名前タイプ場所必須説明
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo
anonUserIdstringqueryNo

レスポンス

戻り値: FlagCommentResponse

flagComment 例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let userId = "userId_example" // String | (optional)
8let anonUserId = "anonUserId_example" // String | (optional)
9
10DefaultAPI.flagComment(tenantId: tenantId, id: id, options: DefaultAPI.FlagCommentOptions(userId: userId, anonUserId: anonUserId)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getComment Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい

レスポンス

戻り値: APIGetCommentResponse

getComment の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getComment(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getComments Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
pageintegerqueryNo
limitintegerqueryNo
skipintegerqueryNo
asTreebooleanqueryNo
skipChildrenintegerqueryNo
limitChildrenintegerqueryNo
maxTreeDepthintegerqueryNo
urlIdstringqueryNo
userIdstringqueryNo
anonUserIdstringqueryNo
contextUserIdstringqueryNo
hashTagstringqueryNo
parentIdstringqueryNo
directionstringqueryNo
fromDateintegerqueryNo
toDateintegerqueryNo

応答

返却: APIGetCommentsResponse

getComments の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let page = 987 // Int | (optional)
7let limit = 987 // Int | (optional)
8let skip = 987 // Int | (optional)
9let asTree = true // Bool | (optional)
10let skipChildren = 987 // Int | (optional)
11let limitChildren = 987 // Int | (optional)
12let maxTreeDepth = 987 // Int | (optional)
13let urlId = "urlId_example" // String | (optional)
14let userId = "userId_example" // String | (optional)
15let anonUserId = "anonUserId_example" // String | (optional)
16let contextUserId = "contextUserId_example" // String | (optional)
17let hashTag = "hashTag_example" // String | (optional)
18let parentId = "parentId_example" // String | (optional)
19let direction = SortDirections() // SortDirections | (optional)
20let fromDate = 987 // Int64 | (optional)
21let toDate = 987 // Int64 | (optional)
22
23DefaultAPI.getComments(tenantId: tenantId, options: DefaultAPI.GetCommentsOptions(page: page, limit: limit, skip: skip, asTree: asTree, skipChildren: skipChildren, limitChildren: limitChildren, maxTreeDepth: maxTreeDepth, urlId: urlId, userId: userId, anonUserId: anonUserId, contextUserId: contextUserId, hashTag: hashTag, parentId: parentId, direction: direction, fromDate: fromDate, toDate: toDate)) { (response, error) in
24 guard error == nil else {
25 print(error)
26 return
27 }
28
29 if (response) {
30 dump(response)
31 }
32}
33

getCommentsPublic Internal Link

リクエスト
tenantId
urlId

パラメータ

名前タイプ場所必須説明
tenantIdstringpathYes
urlIdstringqueryYes
pageintegerqueryNo
directionstringqueryNo
ssostringqueryNo
skipintegerqueryNo
skipChildrenintegerqueryNo
limitintegerqueryNo
limitChildrenintegerqueryNo
countChildrenbooleanqueryNo
fetchPageForCommentIdstringqueryNo
includeConfigbooleanqueryNo
countAllbooleanqueryNo
includei10nbooleanqueryNo
localestringqueryNo
modulesstringqueryNo
isCrawlerbooleanqueryNo
includeNotificationCountbooleanqueryNo
asTreebooleanqueryNo
maxTreeDepthintegerqueryNo
useFullTranslationIdsbooleanqueryNo
parentIdstringqueryNo
searchTextstringqueryNo
hashTagsarrayqueryNo
userIdstringqueryNo
customConfigStrstringqueryNo
afterCommentIdstringqueryNo
beforeCommentIdstringqueryNo

レスポンス

戻り値: GetCommentsResponseWithPresencePublicComment

getCommentsPublic の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へレポートしてください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let page = 987 // Int | (optional)
8let direction = SortDirections() // SortDirections | (optional)
9let sso = "sso_example" // String | (optional)
10let skip = 987 // Int | (optional)
11let skipChildren = 987 // Int | (optional)
12let limit = 987 // Int | (optional)
13let limitChildren = 987 // Int | (optional)
14let countChildren = true // Bool | (optional)
15let fetchPageForCommentId = "fetchPageForCommentId_example" // String | (optional)
16let includeConfig = true // Bool | (optional)
17let countAll = true // Bool | (optional)
18let includei10n = true // Bool | (optional)
19let locale = "locale_example" // String | (optional)
20let modules = "modules_example" // String | (optional)
21let isCrawler = true // Bool | (optional)
22let includeNotificationCount = true // Bool | (optional)
23let asTree = true // Bool | (optional)
24let maxTreeDepth = 987 // Int | (optional)
25let useFullTranslationIds = true // Bool | (optional)
26let parentId = "parentId_example" // String | (optional)
27let searchText = "searchText_example" // String | (optional)
28let hashTags = ["inner_example"] // [String] | (optional)
29let userId = "userId_example" // String | (optional)
30let customConfigStr = "customConfigStr_example" // String | (optional)
31let afterCommentId = "afterCommentId_example" // String | (optional)
32let beforeCommentId = "beforeCommentId_example" // String | (optional)
33
34PublicAPI.getCommentsPublic(tenantId: tenantId, urlId: urlId, options: PublicAPI.GetCommentsPublicOptions(page: page, direction: direction, sso: sso, skip: skip, skipChildren: skipChildren, limit: limit, limitChildren: limitChildren, countChildren: countChildren, fetchPageForCommentId: fetchPageForCommentId, includeConfig: includeConfig, countAll: countAll, includei10n: includei10n, locale: locale, modules: modules, isCrawler: isCrawler, includeNotificationCount: includeNotificationCount, asTree: asTree, maxTreeDepth: maxTreeDepth, useFullTranslationIds: useFullTranslationIds, parentId: parentId, searchText: searchText, hashTags: hashTags, userId: userId, customConfigStr: customConfigStr, afterCommentId: afterCommentId, beforeCommentId: beforeCommentId)) { (response, error) in
35 guard error == nil else {
36 print(error)
37 return
38 }
39
40 if (response) {
41 dump(response)
42 }
43}
44

getCommentText Internal Link

パラメータ

名前場所必須説明
tenantIdstringpathYes
commentIdstringpathYes
editKeystringqueryNo
ssostringqueryNo

レスポンス

戻り値: PublicAPIGetCommentTextResponse

getCommentText の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let editKey = "editKey_example" // String | (オプション)
8let sso = "sso_example" // String | (オプション)
9
10PublicAPI.getCommentText(tenantId: tenantId, commentId: commentId, options: PublicAPI.GetCommentTextOptions(editKey: editKey, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getCommentVoteUserNames Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringpathはい
commentIdstringpathはい
dirintegerqueryはい
ssostringqueryいいえ

レスポンス

戻り値: GetCommentVoteUserNamesSuccessResponse

getCommentVoteUserNames の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new から報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let dir = 987 // Int |
8let sso = "sso_example" // String | (オプション)
9
10PublicAPI.getCommentVoteUserNames(tenantId: tenantId, commentId: commentId, dir: dir, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

lockComment Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringpathはい
commentIdstringpathはい
broadcastIdstringqueryはい
ssostringqueryいいえ

レスポンス

戻り値: APIEmptyResponse

lockComment の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new にて報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String |
8let sso = "sso_example" // String | (オプション)
9
10PublicAPI.lockComment(tenantId: tenantId, commentId: commentId, broadcastId: broadcastId, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

pinComment Internal Link


パラメータ

NameTypeLocationRequiredDescription
tenantIdstringpathはい
commentIdstringpathはい
broadcastIdstringqueryはい
ssostringqueryいいえ

レスポンス

戻り値: ChangeCommentPinStatusResponse

pinComment の例
Copy Copy
1
2// 以下のコードサンプルはまだベータです。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String |
8let sso = "sso_example" // String | (オプション)
9
10PublicAPI.pinComment(tenantId: tenantId, commentId: commentId, broadcastId: broadcastId, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

saveComment Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
isLivebooleanqueryNo
doSpamCheckbooleanqueryNo
sendEmailsbooleanqueryNo
populateNotificationsbooleanqueryNo

レスポンス

返却: APISaveCommentResponse

saveComment の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createCommentParams = CreateCommentParams(date: 123, localDateString: "localDateString_example", localDateHours: 123, commenterName: "commenterName_example", commenterEmail: "commenterEmail_example", commenterLink: "commenterLink_example", comment: "comment_example", productId: 123, userId: "userId_example", avatarSrc: "avatarSrc_example", parentId: "parentId_example", mentions: [CommentUserMentionInfo(id: "id_example", tag: "tag_example", rawTag: "rawTag_example", type: "type_example", sent: false)], hashTags: [CommentUserHashTagInfo(id: "id_example", tag: "tag_example", url: "url_example", retain: false)], pageTitle: "pageTitle_example", isFromMyAccountPage: false, url: "url_example", urlId: "urlId_example", meta: 123, moderationGroupIds: ["moderationGroupIds_example"], rating: 123, fromOfflineRestore: false, autoplayDelayMS: 123, feedbackIds: ["feedbackIds_example"], questionValues: "TODO", tos: false, botId: "botId_example", approved: false, domain: "domain_example", ip: "ip_example", isPinned: false, locale: "locale_example", reviewed: false, verified: false, votes: 123, votesDown: 123, votesUp: 123) // CreateCommentParams |
7let isLive = true // Bool | (オプション)
8let doSpamCheck = true // Bool | (オプション)
9let sendEmails = true // Bool | (オプション)
10let populateNotifications = true // Bool | (オプション)
11
12DefaultAPI.saveComment(tenantId: tenantId, createCommentParams: createCommentParams, options: DefaultAPI.SaveCommentOptions(isLive: isLive, doSpamCheck: doSpamCheck, sendEmails: sendEmails, populateNotifications: populateNotifications)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

saveCommentsBulk Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
isLivebooleanqueryNo
doSpamCheckbooleanqueryNo
sendEmailsbooleanqueryNo
populateNotificationsbooleanqueryNo

レスポンス

Returns: [SaveCommentsBulkResponse]

saveCommentsBulk の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new から報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createCommentParams = [CreateCommentParams(date: 123, localDateString: "localDateString_example", localDateHours: 123, commenterName: "commenterName_example", commenterEmail: "commenterEmail_example", commenterLink: "commenterLink_example", comment: "comment_example", productId: 123, userId: "userId_example", avatarSrc: "avatarSrc_example", parentId: "parentId_example", mentions: [CommentUserMentionInfo(id: "id_example", tag: "tag_example", rawTag: "rawTag_example", type: "type_example", sent: false)], hashTags: [CommentUserHashTagInfo(id: "id_example", tag: "tag_example", url: "url_example", retain: false)], pageTitle: "pageTitle_example", isFromMyAccountPage: false, url: "url_example", urlId: "urlId_example", meta: 123, moderationGroupIds: ["moderationGroupIds_example"], rating: 123, fromOfflineRestore: false, autoplayDelayMS: 123, feedbackIds: ["feedbackIds_example"], questionValues: "TODO", tos: false, botId: "botId_example", approved: false, domain: "domain_example", ip: "ip_example", isPinned: false, locale: "locale_example", reviewed: false, verified: false, votes: 123, votesDown: 123, votesUp: 123)] // [CreateCommentParams] |
7let isLive = true // Bool | (optional)
8let doSpamCheck = true // Bool | (optional)
9let sendEmails = true // Bool | (optional)
10let populateNotifications = true // Bool | (optional)
11
12DefaultAPI.saveCommentsBulk(tenantId: tenantId, createCommentParams: createCommentParams, options: DefaultAPI.SaveCommentsBulkOptions(isLive: isLive, doSpamCheck: doSpamCheck, sendEmails: sendEmails, populateNotifications: populateNotifications)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

setCommentText Internal Link

パラメータ

名前種類場所必須説明
tenantIdstringpathはい
commentIdstringpathはい
broadcastIdstringqueryはい
editKeystringqueryいいえ
ssostringqueryいいえ

レスポンス

戻り値: PublicAPISetCommentTextResponse

setCommentText の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String |
8let commentTextUpdateRequest = CommentTextUpdateRequest(comment: "comment_example", mentions: [CommentUserMentionInfo(id: "id_example", tag: "tag_example", rawTag: "rawTag_example", type: "type_example", sent: false)], hashTags: [CommentUserHashTagInfo(id: "id_example", tag: "tag_example", url: "url_example", retain: false)]) // CommentTextUpdateRequest |
9let editKey = "editKey_example" // String | (オプション)
10let sso = "sso_example" // String | (オプション)
11
12PublicAPI.setCommentText(tenantId: tenantId, commentId: commentId, broadcastId: broadcastId, commentTextUpdateRequest: commentTextUpdateRequest, options: PublicAPI.SetCommentTextOptions(editKey: editKey, sso: sso)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

unBlockUserFromComment Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい
userIdstringqueryいいえ
anonUserIdstringqueryいいえ

レスポンス

返り値: UnblockSuccess

unBlockUserFromCommentの例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let unBlockFromCommentParams = UnBlockFromCommentParams(commentIdsToCheck: ["commentIdsToCheck_example"]) // UnBlockFromCommentParams |
8let userId = "userId_example" // String | (オプション)
9let anonUserId = "anonUserId_example" // String | (オプション)
10
11DefaultAPI.unBlockUserFromComment(tenantId: tenantId, id: id, unBlockFromCommentParams: unBlockFromCommentParams, options: DefaultAPI.UnBlockUserFromCommentOptions(userId: userId, anonUserId: anonUserId)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

unFlagComment Internal Link

パラメータ

名前タイプ場所必須説明
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo
anonUserIdstringqueryNo

応答

戻り値: FlagCommentResponse

unFlagComment 例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let userId = "userId_example" // String | (optional)
8let anonUserId = "anonUserId_example" // String | (optional)
9
10DefaultAPI.unFlagComment(tenantId: tenantId, id: id, options: DefaultAPI.UnFlagCommentOptions(userId: userId, anonUserId: anonUserId)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

unLockComment Internal Link

パラメータ

名前場所必須説明
tenantIdstringpathはい
commentIdstringpathはい
broadcastIdstringqueryはい
ssostringqueryいいえ

レスポンス

戻り値: APIEmptyResponse

unLockComment の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new から報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String |
8let sso = "sso_example" // String | (オプション)
9
10PublicAPI.unLockComment(tenantId: tenantId, commentId: commentId, broadcastId: broadcastId, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

unPinComment Internal Link

パラメータ

名前場所必須説明
tenantIdstringpathはい
commentIdstringpathはい
broadcastIdstringqueryはい
ssostringqueryいいえ

レスポンス

戻り値: ChangeCommentPinStatusResponse

unPinCommentの例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String |
8let sso = "sso_example" // String | (任意)
9
10PublicAPI.unPinComment(tenantId: tenantId, commentId: commentId, broadcastId: broadcastId, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

updateComment Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
idstringpathYes
contextUserIdstringqueryNo
doSpamCheckbooleanqueryNo
isLivebooleanqueryNo

応答

返却: APIEmptyResponse

updateComment の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updatableCommentParams = UpdatableCommentParams(urlId: "urlId_example", urlIdRaw: "urlIdRaw_example", url: "url_example", pageTitle: "pageTitle_example", userId: "userId_example", commenterEmail: "commenterEmail_example", commenterName: "commenterName_example", commenterLink: "commenterLink_example", comment: "comment_example", commentHTML: "commentHTML_example", parentId: "parentId_example", date: 123, localDateString: "localDateString_example", localDateHours: 123, votes: 123, votesUp: 123, votesDown: 123, expireAt: Date(), verified: false, verifiedDate: Date(), notificationSentForParent: false, notificationSentForParentTenant: false, reviewed: false, externalId: "externalId_example", externalParentId: "externalParentId_example", avatarSrc: "avatarSrc_example", isSpam: false, approved: false, isDeleted: false, isDeletedUser: false, isByAdmin: false, isByModerator: false, isPinned: false, isLocked: false, flagCount: 123, displayLabel: "displayLabel_example", meta: APICommentBase_meta(wpUserId: "wpUserId_example", wpPostId: "wpPostId_example"), moderationGroupIds: ["moderationGroupIds_example"], feedbackIds: ["feedbackIds_example"]) // UpdatableCommentParams |
8let contextUserId = "contextUserId_example" // String | (optional)
9let doSpamCheck = true // Bool | (optional)
10let isLive = true // Bool | (optional)
11
12DefaultAPI.updateComment(tenantId: tenantId, id: id, updatableCommentParams: updatableCommentParams, options: DefaultAPI.UpdateCommentOptions(contextUserId: contextUserId, doSpamCheck: doSpamCheck, isLive: isLive)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

voteComment Internal Link

パラメータ

名前場所必須説明
tenantIdstringpathはい
commentIdstringpathはい
urlIdstringqueryはい
broadcastIdstringqueryはい
sessionIdstringqueryいいえ
ssostringqueryいいえ

レスポンス

返却: VoteResponse

voteComment の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let urlId = "urlId_example" // String |
8let broadcastId = "broadcastId_example" // String |
9let voteBodyParams = VoteBodyParams(commenterEmail: "commenterEmail_example", commenterName: "commenterName_example", voteDir: "voteDir_example", url: "url_example") // VoteBodyParams |
10let sessionId = "sessionId_example" // String | (任意)
11let sso = "sso_example" // String | (任意)
12
13PublicAPI.voteComment(tenantId: tenantId, commentId: commentId, urlId: urlId, broadcastId: broadcastId, voteBodyParams: voteBodyParams, options: PublicAPI.VoteCommentOptions(sessionId: sessionId, sso: sso)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

getCommentsForUser Internal Link

パラメータ

名前場所必須説明
userIdstringqueryNo
directionstringqueryNo
repliesToUserIdstringqueryNo
pagenumberqueryNo
includei10nbooleanqueryNo
localestringqueryNo
isCrawlerbooleanqueryNo

レスポンス

返却: GetCommentsForUserResponse

getCommentsForUser の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let userId = "userId_example" // String | (オプション)
6let direction = SortDirections() // SortDirections | (オプション)
7let repliesToUserId = "repliesToUserId_example" // String | (オプション)
8let page = 987 // Double | (オプション)
9let includei10n = true // Bool | (オプション)
10let locale = "locale_example" // String | (オプション)
11let isCrawler = true // Bool | (オプション)
12
13PublicAPI.getCommentsForUser(options: PublicAPI.GetCommentsForUserOptions(userId: userId, direction: direction, repliesToUserId: repliesToUserId, page: page, includei10n: includei10n, locale: locale, isCrawler: isCrawler)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

addDomainConfig Internal Link


パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

レスポンス

戻り値: AddDomainConfigResponse

addDomainConfig の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let addDomainConfigParams = AddDomainConfigParams(domain: "domain_example", emailFromName: "emailFromName_example", emailFromEmail: "emailFromEmail_example", logoSrc: "logoSrc_example", logoSrc100px: "logoSrc100px_example", footerUnsubscribeURL: "footerUnsubscribeURL_example", emailHeaders: "TODO") // AddDomainConfigParams |
7
8DefaultAPI.addDomainConfig(tenantId: tenantId, addDomainConfigParams: addDomainConfigParams) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

deleteDomainConfig Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
domainstringpathはい

レスポンス

戻り値: DeleteDomainConfigResponse

deleteDomainConfig の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let domain = "domain_example" // String |
7
8DefaultAPI.deleteDomainConfig(tenantId: tenantId, domain: domain) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getDomainConfig Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい
domainstringpathはい

レスポンス

戻り値: GetDomainConfigResponse

getDomainConfig の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let domain = "domain_example" // String |
7
8DefaultAPI.getDomainConfig(tenantId: tenantId, domain: domain) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getDomainConfigs Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい

レスポンス

戻り値: GetDomainConfigsResponse

getDomainConfigs の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // 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

パラメータ

名前場所必須説明
tenantIdstringqueryはい
domainToUpdatestringpathはい

レスポンス

戻り値: PatchDomainConfigResponse

patchDomainConfig の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let domainToUpdate = "domainToUpdate_example" // String |
7let patchDomainConfigParams = PatchDomainConfigParams(domain: "domain_example", emailFromName: "emailFromName_example", emailFromEmail: "emailFromEmail_example", logoSrc: "logoSrc_example", logoSrc100px: "logoSrc100px_example", footerUnsubscribeURL: "footerUnsubscribeURL_example", emailHeaders: "TODO") // PatchDomainConfigParams |
8
9DefaultAPI.patchDomainConfig(tenantId: tenantId, domainToUpdate: domainToUpdate, patchDomainConfigParams: patchDomainConfigParams) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

putDomainConfig Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい
domainToUpdatestringpathはい

レスポンス

返却値: PutDomainConfigResponse

putDomainConfig の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let domainToUpdate = "domainToUpdate_example" // String |
7let updateDomainConfigParams = UpdateDomainConfigParams(domain: "domain_example", emailFromName: "emailFromName_example", emailFromEmail: "emailFromEmail_example", logoSrc: "logoSrc_example", logoSrc100px: "logoSrc100px_example", footerUnsubscribeURL: "footerUnsubscribeURL_example", emailHeaders: "TODO") // UpdateDomainConfigParams |
8
9DefaultAPI.putDomainConfig(tenantId: tenantId, domainToUpdate: domainToUpdate, updateDomainConfigParams: updateDomainConfigParams) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

createEmailTemplate Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい

レスポンス

返却値: CreateEmailTemplateResponse

createEmailTemplate の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createEmailTemplateBody = CreateEmailTemplateBody(emailTemplateId: "emailTemplateId_example", displayName: "displayName_example", ejs: "ejs_example", domain: "domain_example", translationOverridesByLocale: "TODO", testData: "TODO") // CreateEmailTemplateBody |
7
8DefaultAPI.createEmailTemplate(tenantId: tenantId, createEmailTemplateBody: createEmailTemplateBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

deleteEmailTemplate Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい
idstringpathはい

Response

戻り値: APIEmptyResponse

deleteEmailTemplate の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.deleteEmailTemplate(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

deleteEmailTemplateRenderError Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
idstringpathYes
errorIdstringpathYes

レスポンス

戻り値: APIEmptyResponse

deleteEmailTemplateRenderError の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let errorId = "errorId_example" // String |
8
9DefaultAPI.deleteEmailTemplateRenderError(tenantId: tenantId, id: id, errorId: errorId) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getEmailTemplate Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい
idstringpathはい

レスポンス

返却: GetEmailTemplateResponse

getEmailTemplate の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getEmailTemplate(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getEmailTemplateDefinitions Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい

レスポンス

戻り値: GetEmailTemplateDefinitionsResponse

getEmailTemplateDefinitions の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題があれば http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6
7DefaultAPI.getEmailTemplateDefinitions(tenantId: tenantId) { (response, error) in
8 guard error == nil else {
9 print(error)
10 return
11 }
12
13 if (response) {
14 dump(response)
15 }
16}
17

getEmailTemplateRenderErrors Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい
skipnumberqueryいいえ

レスポンス

戻り値: GetEmailTemplateRenderErrorsResponse

getEmailTemplateRenderErrors の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let skip = 987 // Double | (任意)
8
9DefaultAPI.getEmailTemplateRenderErrors(tenantId: tenantId, id: id, skip: skip) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getEmailTemplates Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
skipnumberqueryいいえ

レスポンス

返却値: GetEmailTemplatesResponse

getEmailTemplates の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let skip = 987 // Double | (省略可能)
7
8DefaultAPI.getEmailTemplates(tenantId: tenantId, skip: skip) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

renderEmailTemplate Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
localestringqueryいいえ

レスポンス

戻り値: RenderEmailTemplateResponse

renderEmailTemplate の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let renderEmailTemplateBody = RenderEmailTemplateBody(emailTemplateId: "emailTemplateId_example", ejs: "ejs_example", testData: "TODO", translationOverridesByLocale: "TODO") // RenderEmailTemplateBody |
7let locale = "locale_example" // String | (オプション)
8
9DefaultAPI.renderEmailTemplate(tenantId: tenantId, renderEmailTemplateBody: renderEmailTemplateBody, locale: locale) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

updateEmailTemplate Internal Link


パラメータ

名前場所必須説明
tenantIdstringqueryYes
idstringpathYes

レスポンス

返却: APIEmptyResponse

updateEmailTemplate の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateEmailTemplateBody = UpdateEmailTemplateBody(emailTemplateId: "emailTemplateId_example", displayName: "displayName_example", ejs: "ejs_example", domain: "domain_example", translationOverridesByLocale: "TODO", testData: "TODO") // UpdateEmailTemplateBody |
8
9DefaultAPI.updateEmailTemplate(tenantId: tenantId, id: id, updateEmailTemplateBody: updateEmailTemplateBody) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getEventLog Internal Link

req tenantId urlId userIdWS

パラメータ

名前場所必須説明
tenantIdstringpathはい
urlIdstringqueryはい
userIdWSstringqueryはい
startTimeintegerqueryはい
endTimeintegerqueryいいえ

レスポンス

戻り値: GetEventLogResponse

getEventLog の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let userIdWS = "userIdWS_example" // String |
8let startTime = 987 // Int64 |
9let endTime = 987 // Int64 | (オプション)
10
11PublicAPI.getEventLog(tenantId: tenantId, urlId: urlId, userIdWS: userIdWS, startTime: startTime, endTime: endTime) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

getGlobalEventLog Internal Link

リクエスト tenantId urlId userIdWS

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringpathはい
urlIdstringqueryはい
userIdWSstringqueryはい
startTimeintegerqueryはい
endTimeintegerqueryいいえ

レスポンス

戻り値: GetEventLogResponse

getGlobalEventLog の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let userIdWS = "userIdWS_example" // String |
8let startTime = 987 // Int64 |
9let endTime = 987 // Int64 | (オプション)
10
11PublicAPI.getGlobalEventLog(tenantId: tenantId, urlId: urlId, userIdWS: userIdWS, startTime: startTime, endTime: endTime) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

createFeedPost Internal Link

パラメータ

名前タイプ場所必須説明
tenantIdstringqueryYes
broadcastIdstringqueryNo
isLivebooleanqueryNo
doSpamCheckbooleanqueryNo
skipDupCheckbooleanqueryNo

応答

戻り値: CreateFeedPostsResponse

createFeedPost の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createFeedPostParams = CreateFeedPostParams(title: "title_example", contentHTML: "contentHTML_example", media: [FeedPostMediaItem(title: "title_example", linkUrl: "linkUrl_example", sizes: [FeedPostMediaItemAsset(w: 123, h: 123, src: "src_example")])], links: [FeedPostLink(text: "text_example", title: "title_example", description: "description_example", url: "url_example")], fromUserId: "fromUserId_example", fromUserDisplayName: "fromUserDisplayName_example", tags: ["tags_example"], meta: "TODO") // CreateFeedPostParams |
7let broadcastId = "broadcastId_example" // String | (optional)
8let isLive = true // Bool | (optional)
9let doSpamCheck = true // Bool | (optional)
10let skipDupCheck = true // Bool | (optional)
11
12DefaultAPI.createFeedPost(tenantId: tenantId, createFeedPostParams: createFeedPostParams, options: DefaultAPI.CreateFeedPostOptions(broadcastId: broadcastId, isLive: isLive, doSpamCheck: doSpamCheck, skipDupCheck: skipDupCheck)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

createFeedPostPublic Internal Link

パラメータ

名前場所必須説明
tenantIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

レスポンス

戻り値: CreateFeedPostResponse

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

deleteFeedPostPublic Internal Link

パラメータ

名前場所必須説明
tenantIdstringpathYes
postIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

レスポンス

戻り値: DeleteFeedPostPublicResponse

deleteFeedPostPublic の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let postId = "postId_example" // String |
7let broadcastId = "broadcastId_example" // String | (optional)
8let sso = "sso_example" // String | (optional)
9
10PublicAPI.deleteFeedPostPublic(tenantId: tenantId, postId: postId, options: PublicAPI.DeleteFeedPostPublicOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getFeedPosts Internal Link

リクエスト
tenantId
afterId

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
afterIdstringqueryNo
limitintegerqueryNo
tagsarrayqueryNo

レスポンス

返り値: GetFeedPostsResponse

getFeedPosts の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new まで報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let afterId = "afterId_example" // String | (オプション)
7let limit = 987 // Int | (オプション)
8let tags = ["inner_example"] // [String] | (オプション)
9
10DefaultAPI.getFeedPosts(tenantId: tenantId, options: DefaultAPI.GetFeedPostsOptions(afterId: afterId, limit: limit, tags: tags)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getFeedPostsPublic Internal Link

req tenantId afterId

パラメータ

名前場所必須説明
tenantIdstringpathはい
afterIdstringqueryいいえ
limitintegerqueryいいえ
tagsarrayqueryいいえ
ssostringqueryいいえ
isCrawlerbooleanqueryいいえ
includeUserInfobooleanqueryいいえ

レスポンス

戻り値: PublicFeedPostsResponse

getFeedPostsPublic の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題があれば、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let afterId = "afterId_example" // String | (任意)
7let limit = 987 // Int | (任意)
8let tags = ["inner_example"] // [String] | (任意)
9let sso = "sso_example" // String | (任意)
10let isCrawler = true // Bool | (任意)
11let includeUserInfo = true // Bool | (任意)
12
13PublicAPI.getFeedPostsPublic(tenantId: tenantId, options: PublicAPI.GetFeedPostsPublicOptions(afterId: afterId, limit: limit, tags: tags, sso: sso, isCrawler: isCrawler, includeUserInfo: includeUserInfo)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

getFeedPostsStats Internal Link


パラメータ

名前場所必須説明
tenantIdstringpathはい
postIdsarrayqueryはい
ssostringqueryいいえ

レスポンス

戻り値: FeedPostsStatsResponse

getFeedPostsStats の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let postIds = ["inner_example"] // [String] |
7let sso = "sso_example" // String | (オプション)
8
9PublicAPI.getFeedPostsStats(tenantId: tenantId, postIds: postIds, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getUserReactsPublic Internal Link

パラメータ

名前場所必須説明
tenantIdstringpathYes
postIdsarrayqueryNo
ssostringqueryNo

レスポンス

返却: UserReactsResponse

getUserReactsPublic 例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let postIds = ["inner_example"] // [String] | (オプション)
7let sso = "sso_example" // String | (オプション)
8
9PublicAPI.getUserReactsPublic(tenantId: tenantId, options: PublicAPI.GetUserReactsPublicOptions(postIds: postIds, sso: sso)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

reactFeedPostPublic Internal Link

パラメータ

名前場所必須説明
tenantIdstringpathYes
postIdstringpathYes
isUndobooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

レスポンス

返却: ReactFeedPostResponse

reactFeedPostPublic 例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let postId = "postId_example" // String |
7let reactBodyParams = ReactBodyParams(reactType: "reactType_example") // ReactBodyParams |
8let isUndo = true // Bool | (省略可能)
9let broadcastId = "broadcastId_example" // String | (省略可能)
10let sso = "sso_example" // String | (省略可能)
11
12PublicAPI.reactFeedPostPublic(tenantId: tenantId, postId: postId, reactBodyParams: reactBodyParams, options: PublicAPI.ReactFeedPostPublicOptions(isUndo: isUndo, broadcastId: broadcastId, sso: sso)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

updateFeedPost Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
idstringpathYes

レスポンス

戻り値: APIEmptyResponse

updateFeedPost の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let feedPost = FeedPost(id: "id_example", tenantId: "tenantId_example", title: "title_example", fromUserId: "fromUserId_example", fromUserDisplayName: "fromUserDisplayName_example", fromUserAvatar: "fromUserAvatar_example", fromIpHash: "fromIpHash_example", tags: ["tags_example"], weight: 123, meta: "TODO", contentHTML: "contentHTML_example", media: [FeedPostMediaItem(title: "title_example", linkUrl: "linkUrl_example", sizes: [FeedPostMediaItemAsset(w: 123, h: 123, src: "src_example")])], links: [FeedPostLink(text: "text_example", title: "title_example", description: "description_example", url: "url_example")], createdAt: Date(), reacts: "TODO", commentCount: 123) // FeedPost |
8
9DefaultAPI.updateFeedPost(tenantId: tenantId, id: id, feedPost: feedPost) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

updateFeedPostPublic Internal Link

Parameters

名前場所必須説明
tenantIdstringpathYes
postIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

レスポンス

返却: CreateFeedPostResponse

updateFeedPostPublic の例
Copy Copy
1
2// 以下のコードサンプルはベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new に報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let postId = "postId_example" // String |
7let updateFeedPostParams = UpdateFeedPostParams(title: "title_example", contentHTML: "contentHTML_example", media: [FeedPostMediaItem(title: "title_example", linkUrl: "linkUrl_example", sizes: [FeedPostMediaItemAsset(w: 123, h: 123, src: "src_example")])], links: [FeedPostLink(text: "text_example", title: "title_example", description: "description_example", url: "url_example")], tags: ["tags_example"], meta: "TODO") // UpdateFeedPostParams |
8let broadcastId = "broadcastId_example" // String | (オプション)
9let sso = "sso_example" // String | (オプション)
10
11PublicAPI.updateFeedPostPublic(tenantId: tenantId, postId: postId, updateFeedPostParams: updateFeedPostParams, options: PublicAPI.UpdateFeedPostPublicOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

flagCommentPublic Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい
commentIdstringpathはい
isFlaggedbooleanqueryはい
ssostringqueryいいえ

レスポンス

返却値: APIEmptyResponse

flagCommentPublic の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let isFlagged = true // Bool |
8let sso = "sso_example" // String | (任意)
9
10PublicAPI.flagCommentPublic(tenantId: tenantId, commentId: commentId, isFlagged: isFlagged, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getGifLarge Internal Link

パラメータ

名前場所必須説明
tenantIdstringpathはい
largeInternalURLSanitizedstringqueryはい

レスポンス

戻り値: GifGetLargeResponse

getGifLarge の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let largeInternalURLSanitized = "largeInternalURLSanitized_example" // String |
7
8PublicAPI.getGifLarge(tenantId: tenantId, largeInternalURLSanitized: largeInternalURLSanitized) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getGifsSearch Internal Link

パラメータ

名前場所必須説明
tenantIdstringpathYes
searchstringqueryYes
localestringqueryNo
ratingstringqueryNo
pagenumberqueryNo

レスポンス

返却: GetGifsSearchResponse

getGifsSearch の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let search = "search_example" // String |
7let locale = "locale_example" // String | (オプション)
8let rating = "rating_example" // String | (オプション)
9let page = 987 // Double | (オプション)
10
11PublicAPI.getGifsSearch(tenantId: tenantId, search: search, options: PublicAPI.GetGifsSearchOptions(locale: locale, rating: rating, page: page)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

getGifsTrending Internal Link

パラメータ

名前場所必須説明
tenantIdstringpathYes
localestringqueryNo
ratingstringqueryNo
pagenumberqueryNo

レスポンス

返却: GetGifsTrendingResponse

getGifsTrending 例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let locale = "locale_example" // String | (オプション)
7let rating = "rating_example" // String | (オプション)
8let page = 987 // Double | (オプション)
9
10PublicAPI.getGifsTrending(tenantId: tenantId, options: PublicAPI.GetGifsTrendingOptions(locale: locale, rating: rating, page: page)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

addHashTag Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

レスポンス

Returns: CreateHashTagResponse

addHashTag の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createHashTagBody = CreateHashTagBody(tenantId: "tenantId_example", tag: "tag_example", url: "url_example") // CreateHashTagBody | (optional)
7
8DefaultAPI.addHashTag(tenantId: tenantId, createHashTagBody: createHashTagBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

addHashTagsBulk Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes

レスポンス

返却: BulkCreateHashTagsResponse

addHashTagsBulk の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let bulkCreateHashTagsBody = BulkCreateHashTagsBody(tenantId: "tenantId_example", tags: [BulkCreateHashTagsBody_tags_inner(url: "url_example", tag: "tag_example")]) // BulkCreateHashTagsBody | (optional)
7
8DefaultAPI.addHashTagsBulk(tenantId: tenantId, bulkCreateHashTagsBody: bulkCreateHashTagsBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

deleteHashTag Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
tagstringpathYes

応答

戻り値: APIEmptyResponse

deleteHashTag の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let tag = "tag_example" // String |
7let deleteHashTagRequestBody = DeleteHashTagRequestBody(tenantId: "tenantId_example") // DeleteHashTagRequestBody | (オプション)
8
9DefaultAPI.deleteHashTag(tenantId: tenantId, tag: tag, deleteHashTagRequestBody: deleteHashTagRequestBody) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getHashTags Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
pagenumberqueryいいえ

レスポンス

返却: GetHashTagsResponse

getHashTags の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let page = 987 // Double | (任意)
7
8DefaultAPI.getHashTags(tenantId: tenantId, page: page) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

patchHashTag Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
tagstringpathはい

レスポンス

戻り値: UpdateHashTagResponse

patchHashTag の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let tag = "tag_example" // String |
7let updateHashTagBody = UpdateHashTagBody(tenantId: "tenantId_example", url: "url_example", tag: "tag_example") // UpdateHashTagBody | (オプション)
8
9DefaultAPI.patchHashTag(tenantId: tenantId, tag: tag, updateHashTagBody: updateHashTagBody) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

deleteModerationVote Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
commentIdstringpathはい
voteIdstringpathはい
broadcastIdstringqueryいいえ
ssostringqueryいいえ

レスポンス

戻り値: VoteDeleteResponse

deleteModerationVote の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let voteId = "voteId_example" // String |
8let broadcastId = "broadcastId_example" // String | (オプション)
9let sso = "sso_example" // String | (オプション)
10
11ModerationAPI.deleteModerationVote(tenantId: tenantId, commentId: commentId, voteId: voteId, options: ModerationAPI.DeleteModerationVoteOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

getApiComments Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
pagenumberqueryNo
countnumberqueryNo
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
sortsstringqueryNo
demobooleanqueryNo
ssostringqueryNo

レスポンス

返却: ModerationAPIGetCommentsResponse

getApiComments 例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new に報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let page = 987 // Double | (オプション)
7let count = 987 // Double | (オプション)
8let textSearch = "textSearch_example" // String | (オプション)
9let byIPFromComment = "byIPFromComment_example" // String | (オプション)
10let filters = "filters_example" // String | (オプション)
11let searchFilters = "searchFilters_example" // String | (オプション)
12let sorts = "sorts_example" // String | (オプション)
13let demo = true // Bool | (オプション)
14let sso = "sso_example" // String | (オプション)
15
16ModerationAPI.getApiComments(tenantId: tenantId, options: ModerationAPI.GetApiCommentsOptions(page: page, count: count, textSearch: textSearch, byIPFromComment: byIPFromComment, filters: filters, searchFilters: searchFilters, sorts: sorts, demo: demo, sso: sso)) { (response, error) in
17 guard error == nil else {
18 print(error)
19 return
20 }
21
22 if (response) {
23 dump(response)
24 }
25}
26

getApiExportStatus Internal Link

パラメータ

名前タイプ場所必須説明
tenantIdstringqueryはい
batchJobIdstringqueryいいえ
ssostringqueryいいえ

応答

返却: ModerationExportStatusResponse

getApiExportStatus の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let batchJobId = "batchJobId_example" // String | (オプション)
7let sso = "sso_example" // String | (オプション)
8
9ModerationAPI.getApiExportStatus(tenantId: tenantId, options: ModerationAPI.GetApiExportStatusOptions(batchJobId: batchJobId, sso: sso)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getApiIds Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
afterIdstringqueryNo
demobooleanqueryNo
ssostringqueryNo

応答

Returns: ModerationAPIGetCommentIdsResponse

getApiIds 例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let textSearch = "textSearch_example" // String | (任意)
7let byIPFromComment = "byIPFromComment_example" // String | (任意)
8let filters = "filters_example" // String | (任意)
9let searchFilters = "searchFilters_example" // String | (任意)
10let afterId = "afterId_example" // String | (任意)
11let demo = true // Bool | (任意)
12let sso = "sso_example" // String | (任意)
13
14ModerationAPI.getApiIds(tenantId: tenantId, options: ModerationAPI.GetApiIdsOptions(textSearch: textSearch, byIPFromComment: byIPFromComment, filters: filters, searchFilters: searchFilters, afterId: afterId, demo: demo, sso: sso)) { (response, error) in
15 guard error == nil else {
16 print(error)
17 return
18 }
19
20 if (response) {
21 dump(response)
22 }
23}
24

getBanUsersFromComment Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
commentIdstringpathはい
ssostringqueryいいえ

レスポンス

戻り値: GetBannedUsersFromCommentResponse

getBanUsersFromComment の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let sso = "sso_example" // String | (オプション)
8
9ModerationAPI.getBanUsersFromComment(tenantId: tenantId, commentId: commentId, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getCommentBanStatus Internal Link

パラメータ

名前位置必須説明
tenantIdstringqueryはい
commentIdstringpathはい
ssostringqueryいいえ

応答

戻り値: GetCommentBanStatusResponse

getCommentBanStatus の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let sso = "sso_example" // String | (optional)
8
9ModerationAPI.getCommentBanStatus(tenantId: tenantId, commentId: commentId, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getCommentChildren Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

応答

返り値: ModerationAPIChildCommentsResponse

getCommentChildren 例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let sso = "sso_example" // String | (オプション)
8
9ModerationAPI.getCommentChildren(tenantId: tenantId, commentId: commentId, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getCount Internal Link

パラメータ

名前タイプ場所必須説明
tenantIdstringqueryはい
text-searchstringqueryいいえ
byIPFromCommentstringqueryいいえ
filterstringqueryいいえ
searchFiltersstringqueryいいえ
demobooleanqueryいいえ
ssostringqueryいいえ

レスポンス

Returns: ModerationAPICountCommentsResponse

getCount の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題があれば、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let textSearch = "textSearch_example" // String | (オプション)
7let byIPFromComment = "byIPFromComment_example" // String | (オプション)
8let filter = "filter_example" // String | (オプション)
9let searchFilters = "searchFilters_example" // String | (オプション)
10let demo = true // Bool | (オプション)
11let sso = "sso_example" // String | (オプション)
12
13ModerationAPI.getCount(tenantId: tenantId, options: ModerationAPI.GetCountOptions(textSearch: textSearch, byIPFromComment: byIPFromComment, filter: filter, searchFilters: searchFilters, demo: demo, sso: sso)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

getCounts Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringクエリはい
ssostringクエリいいえ

レスポンス

返り値: GetBannedUsersCountResponse

getCounts の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください。
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let sso = "sso_example" // String | (オプション)
7
8ModerationAPI.getCounts(tenantId: tenantId, sso: sso) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getLogs Internal Link

Parameters(パラメータ)

名前場所必須説明
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

Response(レスポンス)

返却: ModerationAPIGetLogsResponse

Example(例)

getLogs の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let sso = "sso_example" // String | (オプション)
8
9ModerationAPI.getLogs(tenantId: tenantId, commentId: commentId, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getManualBadges Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
ssostringqueryいいえ

レスポンス

返却: GetTenantManualBadgesResponse

getManualBadges の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題があれば、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let sso = "sso_example" // String | (オプション)
7
8ModerationAPI.getManualBadges(tenantId: tenantId, sso: sso) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getManualBadgesForUser Internal Link

パラメータ

名前ロケーション必須説明
tenantIdstringqueryYes
badgesUserIdstringqueryNo
commentIdstringqueryNo
ssostringqueryNo

レスポンス

返却: GetUserManualBadgesResponse

getManualBadgesForUser の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new から報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let badgesUserId = "badgesUserId_example" // String | (オプション)
7let commentId = "commentId_example" // String | (オプション)
8let sso = "sso_example" // String | (オプション)
9
10ModerationAPI.getManualBadgesForUser(tenantId: tenantId, options: ModerationAPI.GetManualBadgesForUserOptions(badgesUserId: badgesUserId, commentId: commentId, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getModerationComment Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
commentIdstringpathYes
includeEmailbooleanqueryNo
includeIPbooleanqueryNo
ssostringqueryNo

応答

戻り値: ModerationAPICommentResponse

getModerationComment の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let includeEmail = true // Bool | (optional)
8let includeIP = true // Bool | (optional)
9let sso = "sso_example" // String | (optional)
10
11ModerationAPI.getModerationComment(tenantId: tenantId, commentId: commentId, options: ModerationAPI.GetModerationCommentOptions(includeEmail: includeEmail, includeIP: includeIP, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

getModerationCommentText Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
commentIdstringpathはい
ssostringqueryいいえ

応答

返却: GetCommentTextResponse

getModerationCommentText の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new から報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let sso = "sso_example" // String | (オプション)
8
9ModerationAPI.getModerationCommentText(tenantId: tenantId, commentId: commentId, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getPreBanSummary Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
commentIdstringpathYes
includeByUserIdAndEmailbooleanqueryNo
includeByIPbooleanqueryNo
includeByEmailDomainbooleanqueryNo
ssostringqueryNo

レスポンス

返却: PreBanSummary

getPreBanSummary の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題があれば、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let includeByUserIdAndEmail = true // Bool | (オプション)
8let includeByIP = true // Bool | (オプション)
9let includeByEmailDomain = true // Bool | (オプション)
10let sso = "sso_example" // String | (オプション)
11
12ModerationAPI.getPreBanSummary(tenantId: tenantId, commentId: commentId, options: ModerationAPI.GetPreBanSummaryOptions(includeByUserIdAndEmail: includeByUserIdAndEmail, includeByIP: includeByIP, includeByEmailDomain: includeByEmailDomain, sso: sso)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

getSearchCommentsSummary Internal Link


パラメータ

名前場所必須説明
tenantIdstringqueryYes
valuestringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
ssostringqueryNo

レスポンス

返却: ModerationCommentSearchResponse

getSearchCommentsSummary の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題があれば、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let value = "value_example" // String | (オプション)
7let filters = "filters_example" // String | (オプション)
8let searchFilters = "searchFilters_example" // String | (オプション)
9let sso = "sso_example" // String | (オプション)
10
11ModerationAPI.getSearchCommentsSummary(tenantId: tenantId, options: ModerationAPI.GetSearchCommentsSummaryOptions(value: value, filters: filters, searchFilters: searchFilters, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

getSearchPages Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
valuestringqueryNo
ssostringqueryNo

応答

返り値: ModerationPageSearchResponse

getSearchPages 例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題があれば、http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let value = "value_example" // String | (オプション)
7let sso = "sso_example" // String | (オプション)
8
9ModerationAPI.getSearchPages(tenantId: tenantId, options: ModerationAPI.GetSearchPagesOptions(value: value, sso: sso)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getSearchSites Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
valuestringqueryいいえ
ssostringqueryいいえ

レスポンス

戻り値: ModerationSiteSearchResponse

getSearchSites の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let value = "value_example" // String | (オプション)
7let sso = "sso_example" // String | (オプション)
8
9ModerationAPI.getSearchSites(tenantId: tenantId, options: ModerationAPI.GetSearchSitesOptions(value: value, sso: sso)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getSearchSuggest Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
text-searchstringqueryNo
ssostringqueryNo

レスポンス

返却: ModerationSuggestResponse

getSearchSuggest の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let textSearch = "textSearch_example" // String | (オプション)
7let sso = "sso_example" // String | (オプション)
8
9ModerationAPI.getSearchSuggest(tenantId: tenantId, options: ModerationAPI.GetSearchSuggestOptions(textSearch: textSearch, sso: sso)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getSearchUsers Internal Link

パラメータ

名前タイプ場所必須説明
tenantIdstringqueryはい
valuestringqueryいいえ
ssostringqueryいいえ

レスポンス

返却: ModerationUserSearchResponse

getSearchUsers の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new にレポートしてください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let value = "value_example" // String | (オプション)
7let sso = "sso_example" // String | (オプション)
8
9ModerationAPI.getSearchUsers(tenantId: tenantId, options: ModerationAPI.GetSearchUsersOptions(value: value, sso: sso)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getTrustFactor Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
userIdstringqueryNo
ssostringqueryNo

応答

返却: GetUserTrustFactorResponse

getTrustFactor の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題があれば、http://github.com/OpenAPITools/openapi-generator/issues/new に報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String | (オプション)
7let sso = "sso_example" // String | (オプション)
8
9ModerationAPI.getTrustFactor(tenantId: tenantId, options: ModerationAPI.GetTrustFactorOptions(userId: userId, sso: sso)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getUserBanPreference Internal Link

Parameters

名前場所必須説明
tenantIdstringqueryはい
ssostringqueryいいえ

Response

返り値: APIModerateGetUserBanPreferencesResponse

getUserBanPreference の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let sso = "sso_example" // String | (オプション)
7
8ModerationAPI.getUserBanPreference(tenantId: tenantId, sso: sso) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getUserInternalProfile Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
commentIdstringqueryいいえ
ssostringqueryいいえ

レスポンス

返却: GetUserInternalProfileResponse

getUserInternalProfile の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new から報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // 文字列 |
6let commentId = "commentId_example" // 文字列 | (オプション)
7let sso = "sso_example" // 文字列 | (オプション)
8
9ModerationAPI.getUserInternalProfile(tenantId: tenantId, options: ModerationAPI.GetUserInternalProfileOptions(commentId: commentId, sso: sso)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

postAdjustCommentVotes Internal Link

パラメータ

名前タイプロケーション必須説明
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

応答

返却: AdjustVotesResponse

postAdjustCommentVotes 例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new から報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let adjustCommentVotesParams = AdjustCommentVotesParams(adjustVoteAmount: 123) // AdjustCommentVotesParams |
8let broadcastId = "broadcastId_example" // String | (optional)
9let sso = "sso_example" // String | (optional)
10
11ModerationAPI.postAdjustCommentVotes(tenantId: tenantId, commentId: commentId, adjustCommentVotesParams: adjustCommentVotesParams, options: ModerationAPI.PostAdjustCommentVotesOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

postApiExport Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
text-searchstringqueryいいえ
byIPFromCommentstringqueryいいえ
filtersstringqueryいいえ
searchFiltersstringqueryいいえ
sortsstringqueryいいえ
ssostringqueryいいえ

レスポンス

返却: ModerationExportResponse

postApiExport 例
Copy Copy
1
2// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let textSearch = "textSearch_example" // String | (optional) // (オプション)
7let byIPFromComment = "byIPFromComment_example" // String | (optional) // (オプション)
8let filters = "filters_example" // String | (optional) // (オプション)
9let searchFilters = "searchFilters_example" // String | (optional) // (オプション)
10let sorts = "sorts_example" // String | (optional) // (オプション)
11let sso = "sso_example" // String | (optional) // (オプション)
12
13ModerationAPI.postApiExport(tenantId: tenantId, options: ModerationAPI.PostApiExportOptions(textSearch: textSearch, byIPFromComment: byIPFromComment, filters: filters, searchFilters: searchFilters, sorts: sorts, sso: sso)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

postBanUserFromComment Internal Link

パラメータ

名前位置必須説明
tenantIdstringqueryYes
commentIdstringpathYes
banEmailbooleanqueryNo
banEmailDomainbooleanqueryNo
banIPbooleanqueryNo
deleteAllUsersCommentsbooleanqueryNo
bannedUntilstringqueryNo
isShadowBanbooleanqueryNo
updateIdstringqueryNo
banReasonstringqueryNo
ssostringqueryNo

レスポンス

戻り値: BanUserFromCommentResult

postBanUserFromComment の例
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 banEmail = true // Bool | (オプション)
8let banEmailDomain = true // Bool | (オプション)
9let banIP = true // Bool | (オプション)
10let deleteAllUsersComments = true // Bool | (オプション)
11let bannedUntil = "bannedUntil_example" // String | (オプション)
12let isShadowBan = true // Bool | (オプション)
13let updateId = "updateId_example" // String | (オプション)
14let banReason = "banReason_example" // String | (オプション)
15let sso = "sso_example" // String | (オプション)
16
17ModerationAPI.postBanUserFromComment(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostBanUserFromCommentOptions(banEmail: banEmail, banEmailDomain: banEmailDomain, banIP: banIP, deleteAllUsersComments: deleteAllUsersComments, bannedUntil: bannedUntil, isShadowBan: isShadowBan, updateId: updateId, banReason: banReason, sso: sso)) { (response, error) in
18 guard error == nil else {
19 print(error)
20 return
21 }
22
23 if (response) {
24 dump(response)
25 }
26}
27

postBanUserUndo Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
ssostringqueryいいえ

応答

返却: APIEmptyResponse

postBanUserUndo の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let banUserUndoParams = BanUserUndoParams(changelog: APIBanUserChangeLog(createdBannedUserId: "createdBannedUserId_example", updatedBannedUserId: "updatedBannedUserId_example", deletedBannedUsers: [APIBannedUser(id: "id_example", tenantId: "tenantId_example", userId: "userId_example", email: "email_example", username: "username_example", ipHash: "ipHash_example", createdAt: Date(), bannedByUserId: "bannedByUserId_example", bannedCommentText: "bannedCommentText_example", banType: "banType_example", bannedUntil: Date(), hasEmailWildcard: false, banReason: "banReason_example")], changedValuesBefore: APIBanUserChangedValues(id: "id_example", tenantId: "tenantId_example", userId: "userId_example", email: "email_example", username: "username_example", ipHash: "ipHash_example", createdAt: Date(), bannedByUserId: "bannedByUserId_example", bannedCommentText: "bannedCommentText_example", banType: "banType_example", bannedUntil: Date(), hasEmailWildcard: false, banReason: "banReason_example"))) // BanUserUndoParams |
7let sso = "sso_example" // String | (オプション)
8
9ModerationAPI.postBanUserUndo(tenantId: tenantId, banUserUndoParams: banUserUndoParams, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

postBulkPreBanSummary Internal Link

Parameters

名前場所必須説明
tenantIdstringqueryYes
includeByUserIdAndEmailbooleanqueryNo
includeByIPbooleanqueryNo
includeByEmailDomainbooleanqueryNo
ssostringqueryNo

Response

戻り値: BulkPreBanSummary

Example

postBulkPreBanSummary 例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let bulkPreBanParams = BulkPreBanParams(commentIds: ["commentIds_example"]) // BulkPreBanParams |
7let includeByUserIdAndEmail = true // Bool | (オプション)
8let includeByIP = true // Bool | (オプション)
9let includeByEmailDomain = true // Bool | (オプション)
10let sso = "sso_example" // String | (オプション)
11
12ModerationAPI.postBulkPreBanSummary(tenantId: tenantId, bulkPreBanParams: bulkPreBanParams, options: ModerationAPI.PostBulkPreBanSummaryOptions(includeByUserIdAndEmail: includeByUserIdAndEmail, includeByIP: includeByIP, includeByEmailDomain: includeByEmailDomain, sso: sso)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

postCommentsByIds Internal Link

パラメータ

名前タイプ場所必須説明
tenantIdstringqueryYes
ssostringqueryNo

応答

返り値: ModerationAPIChildCommentsResponse

postCommentsByIds の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentsByIdsParams = CommentsByIdsParams(ids: ["ids_example"]) // CommentsByIdsParams |
7let sso = "sso_example" // String | (オプション)
8
9ModerationAPI.postCommentsByIds(tenantId: tenantId, commentsByIdsParams: commentsByIdsParams, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

postFlagComment Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

レスポンス

戻り値: APIEmptyResponse

postFlagComment の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new にて報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String | (オプション)
8let sso = "sso_example" // String | (オプション)
9
10ModerationAPI.postFlagComment(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostFlagCommentOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

postRemoveComment Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

レスポンス

戻り値: PostRemoveCommentApiResponse

postRemoveComment の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String | (optional)
8let sso = "sso_example" // String | (optional)
9
10ModerationAPI.postRemoveComment(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostRemoveCommentOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

postRestoreDeletedComment Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

レスポンス

返却: APIEmptyResponse

postRestoreDeletedComment 例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String | (オプション)
8let sso = "sso_example" // String | (オプション)
9
10ModerationAPI.postRestoreDeletedComment(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostRestoreDeletedCommentOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

postSetCommentApprovalStatus Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
commentIdstringpathはい
approvedbooleanqueryいいえ
broadcastIdstringqueryいいえ
ssostringqueryいいえ

応答

戻り値: SetCommentApprovedResponse

postSetCommentApprovalStatus の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let approved = true // Bool | (オプション)
8let broadcastId = "broadcastId_example" // String | (オプション)
9let sso = "sso_example" // String | (オプション)
10
11ModerationAPI.postSetCommentApprovalStatus(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostSetCommentApprovalStatusOptions(approved: approved, broadcastId: broadcastId, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

postSetCommentReviewStatus Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
commentIdstringpathはい
reviewedbooleanqueryいいえ
broadcastIdstringqueryいいえ
ssostringqueryいいえ

応答

返却: APIEmptyResponse

postSetCommentReviewStatus 例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let reviewed = true // Bool | (オプション)
8let broadcastId = "broadcastId_example" // String | (オプション)
9let sso = "sso_example" // String | (オプション)
10
11ModerationAPI.postSetCommentReviewStatus(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostSetCommentReviewStatusOptions(reviewed: reviewed, broadcastId: broadcastId, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

postSetCommentSpamStatus Internal Link

Parameters

名前位置必須説明
tenantIdstringqueryはい
commentIdstringpathはい
spambooleanqueryいいえ
permNotSpambooleanqueryいいえ
broadcastIdstringqueryいいえ
ssostringqueryいいえ

Response

戻り値: APIEmptyResponse

Example

postSetCommentSpamStatus の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let spam = true // Bool | (optional)
8let permNotSpam = true // Bool | (optional)
9let broadcastId = "broadcastId_example" // String | (optional)
10let sso = "sso_example" // String | (optional)
11
12ModerationAPI.postSetCommentSpamStatus(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostSetCommentSpamStatusOptions(spam: spam, permNotSpam: permNotSpam, broadcastId: broadcastId, sso: sso)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

postSetCommentText Internal Link

パラメータ

名前ロケーション必須説明
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

応答

返却: SetCommentTextResponse

postSetCommentText の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let setCommentTextParams = SetCommentTextParams(comment: "comment_example") // SetCommentTextParams |
8let broadcastId = "broadcastId_example" // String | (オプション)
9let sso = "sso_example" // String | (オプション)
10
11ModerationAPI.postSetCommentText(tenantId: tenantId, commentId: commentId, setCommentTextParams: setCommentTextParams, options: ModerationAPI.PostSetCommentTextOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

postUnFlagComment Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい
commentIdstringpathはい
broadcastIdstringqueryいいえ
ssostringqueryいいえ

レスポンス

返却: APIEmptyResponse

postUnFlagCommentの例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let broadcastId = "broadcastId_example" // String | (オプション)
8let sso = "sso_example" // String | (オプション)
9
10ModerationAPI.postUnFlagComment(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostUnFlagCommentOptions(broadcastId: broadcastId, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

postVote Internal Link

パラメータ

名前Location必須説明
tenantIdstringqueryはい
commentIdstringpathはい
directionstringqueryいいえ
broadcastIdstringqueryいいえ
ssostringqueryいいえ

レスポンス

戻り値: VoteResponse

postVote 例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください。
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let direction = "direction_example" // String | (optional)
8let broadcastId = "broadcastId_example" // String | (optional)
9let sso = "sso_example" // String | (optional)
10
11ModerationAPI.postVote(tenantId: tenantId, commentId: commentId, options: ModerationAPI.PostVoteOptions(direction: direction, broadcastId: broadcastId, sso: sso)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

putAwardBadge Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
badgeIdstringqueryYes
userIdstringqueryNo
commentIdstringqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

レスポンス

返却: AwardUserBadgeResponse

putAwardBadge の例
Copy Copy
1
2// 次のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let badgeId = "badgeId_example" // String |
7let userId = "userId_example" // String | (オプション)
8let commentId = "commentId_example" // String | (オプション)
9let broadcastId = "broadcastId_example" // String | (オプション)
10let sso = "sso_example" // String | (オプション)
11
12ModerationAPI.putAwardBadge(tenantId: tenantId, badgeId: badgeId, options: ModerationAPI.PutAwardBadgeOptions(userId: userId, commentId: commentId, broadcastId: broadcastId, sso: sso)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

putCloseThread Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
urlIdstringqueryはい
ssostringqueryいいえ

レスポンス

返り値: APIEmptyResponse

putCloseThread の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let sso = "sso_example" // String | (オプション)
8
9ModerationAPI.putCloseThread(tenantId: tenantId, urlId: urlId, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

putRemoveBadge Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
badgeIdstringqueryYes
userIdstringqueryNo
commentIdstringqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

レスポンス

戻り値: RemoveUserBadgeResponse

putRemoveBadge 例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let badgeId = "badgeId_example" // String |
7let userId = "userId_example" // String | (オプション)
8let commentId = "commentId_example" // String | (オプション)
9let broadcastId = "broadcastId_example" // String | (オプション)
10let sso = "sso_example" // String | (オプション)
11
12ModerationAPI.putRemoveBadge(tenantId: tenantId, badgeId: badgeId, options: ModerationAPI.PutRemoveBadgeOptions(userId: userId, commentId: commentId, broadcastId: broadcastId, sso: sso)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

putReopenThread Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい
urlIdstringqueryはい
ssostringqueryいいえ

レスポンス

返却: APIEmptyResponse

putReopenThread の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題があれば、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let sso = "sso_example" // String | (optional)
8
9ModerationAPI.putReopenThread(tenantId: tenantId, urlId: urlId, sso: sso) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

setTrustFactor Internal Link

パラメータ

名前タイプ場所必須説明
tenantIdstringqueryYes
userIdstringqueryNo
trustFactorstringqueryNo
ssostringqueryNo

レスポンス

返却: SetUserTrustFactorResponse

setTrustFactor の例
Copy Copy
1
2// 以下のコードサンプルはベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String | (オプション)
7let trustFactor = "trustFactor_example" // String | (オプション)
8let sso = "sso_example" // String | (オプション)
9
10ModerationAPI.setTrustFactor(tenantId: tenantId, options: ModerationAPI.SetTrustFactorOptions(userId: userId, trustFactor: trustFactor, sso: sso)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

createModerator Internal Link

パラメータ

名前Location必須説明
tenantIdstringqueryはい

レスポンス

戻り値: CreateModeratorResponse

createModerator の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createModeratorBody = CreateModeratorBody(name: "name_example", email: "email_example", userId: "userId_example", moderationGroupIds: ["moderationGroupIds_example"]) // CreateModeratorBody |
7
8DefaultAPI.createModerator(tenantId: tenantId, createModeratorBody: createModeratorBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

deleteModerator Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい
sendEmailstringqueryいいえ

レスポンス

戻り値: APIEmptyResponse

deleteModerator の例
Copy Copy
1
2// 次のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let sendEmail = "sendEmail_example" // String | (オプション)
8
9DefaultAPI.deleteModerator(tenantId: tenantId, id: id, sendEmail: sendEmail) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getModerator Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい

レスポンス

戻り値: GetModeratorResponse

getModerator の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new から報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getModerator(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getModerators Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい
skipnumberqueryいいえ

レスポンス

戻り値: GetModeratorsResponse

getModerators の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new から報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let skip = 987 // Double | (オプション)
7
8DefaultAPI.getModerators(tenantId: tenantId, skip: skip) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

sendInvite Internal Link


パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい
fromNamestringqueryはい

レスポンス

戻り値: APIEmptyResponse

sendInvite の例
Copy Copy
1
2// 下記のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new を通じて報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let fromName = "fromName_example" // String |
8
9DefaultAPI.sendInvite(tenantId: tenantId, id: id, fromName: fromName) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

updateModerator Internal Link


パラメータ

名前場所必須説明
tenantIdstringqueryYes
idstringpathYes

レスポンス

戻り値: APIEmptyResponse

updateModerator の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateModeratorBody = UpdateModeratorBody(name: "name_example", email: "email_example", userId: "userId_example", moderationGroupIds: ["moderationGroupIds_example"]) // UpdateModeratorBody |
8
9DefaultAPI.updateModerator(tenantId: tenantId, id: id, updateModeratorBody: updateModeratorBody) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

deleteNotificationCount Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい

レスポンス

返却: APIEmptyResponse

deleteNotificationCount の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題があれば http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.deleteNotificationCount(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getCachedNotificationCount Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい

レスポンス

戻り値: GetCachedNotificationCountResponse

getCachedNotificationCount の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getCachedNotificationCount(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getNotificationCount Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
userIdstringqueryNo
urlIdstringqueryNo
fromCommentIdstringqueryNo
viewedbooleanqueryNo
typestringqueryNo

応答

Returns: GetNotificationCountResponse

getNotificationCount の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String | (optional)
7let urlId = "urlId_example" // String | (optional)
8let fromCommentId = "fromCommentId_example" // String | (optional)
9let viewed = true // Bool | (optional)
10let type = "type_example" // String | (optional)
11
12DefaultAPI.getNotificationCount(tenantId: tenantId, options: DefaultAPI.GetNotificationCountOptions(userId: userId, urlId: urlId, fromCommentId: fromCommentId, viewed: viewed, type: type)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

getNotifications Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
userIdstringqueryNo
urlIdstringqueryNo
fromCommentIdstringqueryNo
viewedbooleanqueryNo
typestringqueryNo
skipnumberqueryNo

レスポンス

戻り値: GetNotificationsResponse

getNotifications の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String | (オプション)
7let urlId = "urlId_example" // String | (オプション)
8let fromCommentId = "fromCommentId_example" // String | (オプション)
9let viewed = true // Bool | (オプション)
10let type = "type_example" // String | (オプション)
11let skip = 987 // Double | (オプション)
12
13DefaultAPI.getNotifications(tenantId: tenantId, options: DefaultAPI.GetNotificationsOptions(userId: userId, urlId: urlId, fromCommentId: fromCommentId, viewed: viewed, type: type, skip: skip)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

updateNotification Internal Link


パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい
userIdstringqueryいいえ

レスポンス

戻り値: APIEmptyResponse

updateNotification の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateNotificationBody = UpdateNotificationBody(viewed: false, optedOut: false) // UpdateNotificationBody |
8let userId = "userId_example" // String | (オプション)
9
10DefaultAPI.updateNotification(tenantId: tenantId, id: id, updateNotificationBody: updateNotificationBody, userId: userId) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

createV1PageReact Internal Link

パラメータ

名前場所必須説明
tenantIdstringpathYes
urlIdstringqueryYes
titlestringqueryNo

レスポンス

返却: CreateV1PageReact

createV1PageReact の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new にて報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let title = "title_example" // String | (任意)
8
9PublicAPI.createV1PageReact(tenantId: tenantId, urlId: urlId, title: title) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

createV2PageReact Internal Link

パラメータ

名前場所必須説明
tenantIdstringpathはい
urlIdstringqueryはい
idstringqueryはい
titlestringqueryいいえ

レスポンス

戻り値: CreateV1PageReact

createV2PageReact の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let id = "id_example" // String |
8let title = "title_example" // String | (オプション)
9
10PublicAPI.createV2PageReact(tenantId: tenantId, urlId: urlId, id: id, title: title) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

deleteV1PageReact Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringpathはい
urlIdstringqueryはい

レスポンス

戻り値: CreateV1PageReact

deleteV1PageReact の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new までご報告ください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7
8PublicAPI.deleteV1PageReact(tenantId: tenantId, urlId: urlId) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

deleteV2PageReact Internal Link

パラメータ

名前場所必須説明
tenantIdstringpathはい
urlIdstringqueryはい
idstringqueryはい

レスポンス

戻り値: CreateV1PageReact

deleteV2PageReact の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let id = "id_example" // String |
8
9PublicAPI.deleteV2PageReact(tenantId: tenantId, urlId: urlId, id: id) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getV1PageLikes Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringpathはい
urlIdstringqueryはい

レスポンス

戻り値: GetV1PageLikes

getV1PageLikes の例
Copy Copy
1
2// 以下のコード例はまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7
8PublicAPI.getV1PageLikes(tenantId: tenantId, urlId: urlId) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getV2PageReacts Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringpathはい
urlIdstringqueryはい

レスポンス

戻り値: GetV2PageReacts

getV2PageReacts の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new までご報告ください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7
8PublicAPI.getV2PageReacts(tenantId: tenantId, urlId: urlId) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getV2PageReactUsers Internal Link

パラメータ

名前場所必須説明
tenantIdstringpathはい
urlIdstringqueryはい
idstringqueryはい

レスポンス

戻り値: GetV2PageReactUsersResponse

getV2PageReactUsers の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let id = "id_example" // String |
8
9PublicAPI.getV2PageReactUsers(tenantId: tenantId, urlId: urlId, id: id) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

addPage Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい

レスポンス

戻り値: AddPageAPIResponse

addPage の例
Copy Copy
1
2// 以下のコードサンプルはまだベータです。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createAPIPageData = CreateAPIPageData(accessibleByGroupIds: ["accessibleByGroupIds_example"], rootCommentCount: 123, commentCount: 123, title: "title_example", url: "url_example", urlId: "urlId_example") // CreateAPIPageData |
7
8DefaultAPI.addPage(tenantId: tenantId, createAPIPageData: createAPIPageData) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

deletePage Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
idstringpathYes

レスポンス

戻り値: DeletePageAPIResponse

deletePage の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.deletePage(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getOfflineUsers Internal Link

Past commenters on the page who are NOT currently online. Sorted by displayName.
Use this after exhausting /users/online to render a "Members" section.
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.

パラメータ

名前場所必須説明
tenantIdstringpathはい
urlIdstringqueryはいページ URL 識別子(サーバー側でクリーンアップ済み)。
afterNamestringqueryいいえカーソル: 前回のレスポンスから nextAfterName を渡します。
afterUserIdstringqueryいいえカーソルのタイブレーカー: 前回のレスポンスから nextAfterUserId を渡します。afterName が設定されている場合に必要で、名前が同じエントリが除外されないようにします。

レスポンス

返却: PageUsersOfflineResponse

getOfflineUsers の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題があれば、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String | ページ URL 識別子(サーバー側でクリーンアップ済み)。
7let afterName = "afterName_example" // String | カーソル: 前回のレスポンスから nextAfterName を渡します。(任意)
8let afterUserId = "afterUserId_example" // String | カーソルのタイブレーカー: 前回のレスポンスから nextAfterUserId を渡します。afterName が設定されている場合に必要で、名前が同じエントリが除外されないようにします。(任意)
9
10PublicAPI.getOfflineUsers(tenantId: tenantId, urlId: urlId, options: PublicAPI.GetOfflineUsersOptions(afterName: afterName, afterUserId: afterUserId)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getOnlineUsers Internal Link

Currently-online viewers of a page: people whose websocket session is subscribed to the page right now.
Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).

Parameters

名前場所必須説明
tenantIdstringpathYes
urlIdstringqueryYesページ URL 識別子(サーバー側でクリーンアップ済み)。
afterNamestringqueryNoカーソル: 前回のレスポンスから nextAfterName を渡す。
afterUserIdstringqueryNoカーソルのタイブレーカー: 前回のレスポンスから nextAfterUserId を渡す。afterName が設定されている場合に必須で、名前が同じ場合にエントリが除外されません。

Response

Returns: PageUsersOnlineResponse

getOnlineUsers の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String | ページ URL 識別子(サーバー側でクリーンアップ済み)。
7let afterName = "afterName_example" // String | カーソル: 前回のレスポンスから nextAfterName を渡す。(optional)
8let afterUserId = "afterUserId_example" // String | カーソルのタイブレーカー: 前回のレスポンスから nextAfterUserId を渡す。afterName が設定されている場合に必須で、名前が同じ場合にエントリが除外されません。(optional)
9
10PublicAPI.getOnlineUsers(tenantId: tenantId, urlId: urlId, options: PublicAPI.GetOnlineUsersOptions(afterName: afterName, afterUserId: afterUserId)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getPageByURLId Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい
urlIdstringqueryはい

レスポンス

戻り値: GetPageByURLIdAPIResponse

getPageByURLId の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new まで報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7
8DefaultAPI.getPageByURLId(tenantId: tenantId, urlId: urlId) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getPages Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい

レスポンス

戻り値: GetPagesAPIResponse

getPages の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6
7DefaultAPI.getPages(tenantId: tenantId) { (response, error) in
8 guard error == nil else {
9 print(error)
10 return
11 }
12
13 if (response) {
14 dump(response)
15 }
16}
17

getPagesPublic Internal Link

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

Parameters

名前タイプ場所必須説明
tenantIdstringpathYes
cursorstringqueryNo前回のリクエストで nextCursor として返された不透明なページネーションカーソルです。sortBy と同じものに結び付けられます。
limitintegerqueryNo1..200、デフォルトは 50
qstringqueryNoオプションの大文字小文字を区別しないタイトルプレフィックスフィルタです。
sortBystringqueryNoソート順です。updatedAt(デフォルト、最新が最初)、commentCount(コメント数が多い順)、または title(アルファベット順)。
hasCommentsbooleanqueryNotrue の場合、少なくとも1つのコメントがあるページのみを返します。

Response

返却: GetPublicPagesResponse

getPagesPublic の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題があれば、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください。
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let cursor = "cursor_example" // String | 前回のリクエストで `nextCursor` として返された不透明なページネーションカーソルです。`sortBy` と同じものに結び付けられます。 (optional)
7let limit = 987 // Int | 1..200、デフォルトは 50 (optional)
8let q = "q_example" // String | オプションの大文字小文字を区別しないタイトルプレフィックスフィルタです。 (optional)
9let sortBy = PagesSortBy() // PagesSortBy | ソート順です。`updatedAt`(デフォルト、最新が最初)、`commentCount`(コメント数が多い順)、または `title`(アルファベット順)。 (optional)
10let hasComments = true // Bool | true の場合、少なくとも1つのコメントがあるページのみを返します。 (optional)
11
12PublicAPI.getPagesPublic(tenantId: tenantId, options: PublicAPI.GetPagesPublicOptions(cursor: cursor, limit: limit, q: q, sortBy: sortBy, hasComments: hasComments)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

getUsersInfo Internal Link


テナントの複数ユーザー情報。userIds を受け取り、User / SSOUser から表示情報を返します。 コメントウィジェットが、プレゼンスイベントで新たに現れたユーザーの情報を補完するために使用します。 ページコンテキストがないため、プライバシーは一律に適用されます(非公開プロファイルはマスクされます)。

パラメータ

名前位置必須説明
tenantIdstringpathYes
idsstringqueryYesカンマ区切りの userIds。

レスポンス

返却: PageUsersInfoResponse

getUsersInfo の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new から報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let ids = "ids_example" // String | カンマ区切りの userIds.
7
8PublicAPI.getUsersInfo(tenantId: tenantId, ids: ids) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

patchPage Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい

レスポンス

戻り値: 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

パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい

レスポンス

戻り値: APIEmptyResponse

deletePendingWebhookEvent の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new を通じて報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.deletePendingWebhookEvent(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getPendingWebhookEventCount Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
commentIdstringqueryNo
externalIdstringqueryNo
eventTypestringqueryNo
typestringqueryNo
domainstringqueryNo
attemptCountGTnumberqueryNo

レスポンス

戻り値: GetPendingWebhookEventCountResponse

getPendingWebhookEventCount の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new に報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String | (オプション)
7let externalId = "externalId_example" // String | (オプション)
8let eventType = "eventType_example" // String | (オプション)
9let type = "type_example" // String | (オプション)
10let domain = "domain_example" // String | (オプション)
11let attemptCountGT = 987 // Double | (オプション)
12
13DefaultAPI.getPendingWebhookEventCount(tenantId: tenantId, options: DefaultAPI.GetPendingWebhookEventCountOptions(commentId: commentId, externalId: externalId, eventType: eventType, type: type, domain: domain, attemptCountGT: attemptCountGT)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

getPendingWebhookEvents Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
commentIdstringqueryNo
externalIdstringqueryNo
eventTypestringqueryNo
typestringqueryNo
domainstringqueryNo
attemptCountGTnumberqueryNo
skipnumberqueryNo

レスポンス

返却: GetPendingWebhookEventsResponse

getPendingWebhookEvents の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String | (オプション)
7let externalId = "externalId_example" // String | (オプション)
8let eventType = "eventType_example" // String | (オプション)
9let type = "type_example" // String | (オプション)
10let domain = "domain_example" // String | (オプション)
11let attemptCountGT = 987 // Double | (オプション)
12let skip = 987 // Double | (オプション)
13
14DefaultAPI.getPendingWebhookEvents(tenantId: tenantId, options: DefaultAPI.GetPendingWebhookEventsOptions(commentId: commentId, externalId: externalId, eventType: eventType, type: type, domain: domain, attemptCountGT: attemptCountGT, skip: skip)) { (response, error) in
15 guard error == nil else {
16 print(error)
17 return
18 }
19
20 if (response) {
21 dump(response)
22 }
23}
24

createQuestionConfig Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい

レスポンス

戻り値: CreateQuestionConfigResponse

createQuestionConfig の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題があれば http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createQuestionConfigBody = CreateQuestionConfigBody(name: "name_example", question: "question_example", helpText: "helpText_example", type: "type_example", numStars: 123, min: 123, max: 123, defaultValue: 123, labelNegative: "labelNegative_example", labelPositive: "labelPositive_example", customOptions: [QuestionConfig_customOptions_inner(imageSrc: "imageSrc_example", name: "name_example")], subQuestionIds: ["subQuestionIds_example"], alwaysShowSubQuestions: false, reportingOrder: 123) // CreateQuestionConfigBody |
7
8DefaultAPI.createQuestionConfig(tenantId: tenantId, createQuestionConfigBody: createQuestionConfigBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

deleteQuestionConfig Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい

レスポンス

戻り値: APIEmptyResponse

deleteQuestionConfig の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.deleteQuestionConfig(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getQuestionConfig Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい

レスポンス

戻り値: GetQuestionConfigResponse

getQuestionConfig の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getQuestionConfig(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getQuestionConfigs Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
skipnumberqueryいいえ

レスポンス

戻り値: GetQuestionConfigsResponse

getQuestionConfigs の例
Copy Copy
1
2// 下記のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let skip = 987 // Double | (オプション)
7
8DefaultAPI.getQuestionConfigs(tenantId: tenantId, skip: skip) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

updateQuestionConfig Internal Link


パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい

レスポンス

戻り値: APIEmptyResponse

updateQuestionConfig の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateQuestionConfigBody = UpdateQuestionConfigBody(name: "name_example", question: "question_example", helpText: "helpText_example", type: "type_example", numStars: 123, min: 123, max: 123, defaultValue: 123, labelNegative: "labelNegative_example", labelPositive: "labelPositive_example", customOptions: [QuestionConfig_customOptions_inner(imageSrc: "imageSrc_example", name: "name_example")], subQuestionIds: ["subQuestionIds_example"], alwaysShowSubQuestions: false, 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


パラメータ

名称場所必須説明
tenantIdstringqueryはい

レスポンス

戻り値: CreateQuestionResultResponse

createQuestionResult の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createQuestionResultBody = CreateQuestionResultBody(urlId: "urlId_example", value: 123, questionId: "questionId_example", anonUserId: "anonUserId_example", userId: "userId_example", commentId: "commentId_example", meta: [MetaItem(name: "name_example", values: ["values_example"])]) // CreateQuestionResultBody |
7
8DefaultAPI.createQuestionResult(tenantId: tenantId, createQuestionResultBody: createQuestionResultBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

deleteQuestionResult Internal Link


パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい
idstringpathはい

レスポンス

戻り値: APIEmptyResponse

deleteQuestionResult の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new を通じて報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.deleteQuestionResult(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getQuestionResult Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい

レスポンス

返却: GetQuestionResultResponse

getQuestionResult の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new から報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getQuestionResult(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getQuestionResults Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
urlIdstringqueryいいえ
userIdstringqueryいいえ
startDatestringqueryいいえ
questionIdstringqueryいいえ
questionIdsstringqueryいいえ
skipnumberqueryいいえ

レスポンス

返却: GetQuestionResultsResponse

getQuestionResults の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String | (オプション)
7let userId = "userId_example" // String | (オプション)
8let startDate = "startDate_example" // String | (オプション)
9let questionId = "questionId_example" // String | (オプション)
10let questionIds = "questionIds_example" // String | (オプション)
11let skip = 987 // Double | (オプション)
12
13DefaultAPI.getQuestionResults(tenantId: tenantId, options: DefaultAPI.GetQuestionResultsOptions(urlId: urlId, userId: userId, startDate: startDate, questionId: questionId, questionIds: questionIds, skip: skip)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

updateQuestionResult Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい
idstringpathはい

レスポンス

戻り値: APIEmptyResponse

updateQuestionResult の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateQuestionResultBody = UpdateQuestionResultBody(urlId: "urlId_example", anonUserId: "anonUserId_example", userId: "userId_example", value: 123, commentId: "commentId_example", questionId: "questionId_example", meta: [MetaItem(name: "name_example", values: ["values_example"])]) // UpdateQuestionResultBody |
8
9DefaultAPI.updateQuestionResult(tenantId: tenantId, id: id, updateQuestionResultBody: updateQuestionResultBody) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

aggregateQuestionResults Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
questionIdstringqueryいいえ
questionIdsarrayqueryいいえ
urlIdstringqueryいいえ
timeBucketstringqueryいいえ
startDatestringqueryいいえ
forceRecalculatebooleanqueryいいえ

レスポンス

返却: AggregateQuestionResultsResponse

aggregateQuestionResults の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new に報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let questionId = "questionId_example" // String | (optional)
7let questionIds = ["inner_example"] // [String] | (optional)
8let urlId = "urlId_example" // String | (optional)
9let timeBucket = AggregateTimeBucket() // AggregateTimeBucket | (optional)
10let startDate = Date() // Date | (optional)
11let forceRecalculate = true // Bool | (optional)
12
13DefaultAPI.aggregateQuestionResults(tenantId: tenantId, options: DefaultAPI.AggregateQuestionResultsOptions(questionId: questionId, questionIds: questionIds, urlId: urlId, timeBucket: timeBucket, startDate: startDate, forceRecalculate: forceRecalculate)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

bulkAggregateQuestionResults Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
forceRecalculatebooleanqueryいいえ

レスポンス

戻り値: BulkAggregateQuestionResultsResponse

bulkAggregateQuestionResults の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let bulkAggregateQuestionResultsRequest = BulkAggregateQuestionResultsRequest(aggregations: [BulkAggregateQuestionItem(aggId: "aggId_example", questionId: "questionId_example", questionIds: ["questionIds_example"], urlId: "urlId_example", timeBucket: AggregateTimeBucket(), startDate: Date())]) // BulkAggregateQuestionResultsRequest |
7let forceRecalculate = true // Bool | (オプション)
8
9DefaultAPI.bulkAggregateQuestionResults(tenantId: tenantId, bulkAggregateQuestionResultsRequest: bulkAggregateQuestionResultsRequest, forceRecalculate: forceRecalculate) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

combineCommentsWithQuestionResults Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
questionIdstringqueryいいえ
questionIdsarrayqueryいいえ
urlIdstringqueryいいえ
startDatestringqueryいいえ
forceRecalculatebooleanqueryいいえ
minValuenumberqueryいいえ
maxValuenumberqueryいいえ
limitnumberqueryいいえ

応答

返り値: CombineQuestionResultsWithCommentsResponse

combineCommentsWithQuestionResults 例
Copy Copy
1
2// このコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let questionId = "questionId_example" // String | (オプション)
7let questionIds = ["inner_example"] // [String] | (オプション)
8let urlId = "urlId_example" // String | (オプション)
9let startDate = Date() // Date | (オプション)
10let forceRecalculate = true // Bool | (オプション)
11let minValue = 987 // Double | (オプション)
12let maxValue = 987 // Double | (オプション)
13let limit = 987 // Double | (オプション)
14
15DefaultAPI.combineCommentsWithQuestionResults(tenantId: tenantId, options: DefaultAPI.CombineCommentsWithQuestionResultsOptions(questionId: questionId, questionIds: questionIds, urlId: urlId, startDate: startDate, forceRecalculate: forceRecalculate, minValue: minValue, maxValue: maxValue, limit: limit)) { (response, error) in
16 guard error == nil else {
17 print(error)
18 return
19 }
20
21 if (response) {
22 dump(response)
23 }
24}
25

addSSOUser Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい

レスポンス

戻り値: AddSSOUserAPIResponse

addSSOUser の例
Copy Copy
1
2// 次のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createAPISSOUserData = CreateAPISSOUserData(groupIds: ["groupIds_example"], hasBlockedUsers: false, isProfileDMDisabled: false, isProfileCommentsPrivate: false, isProfileActivityPrivate: false, isCommentModeratorAdmin: false, isAdminAdmin: false, isAccountOwner: false, displayName: "displayName_example", displayLabel: "displayLabel_example", optedInSubscriptionNotifications: false, optedInNotifications: false, avatarSrc: "avatarSrc_example", loginCount: 123, createdFromUrlId: "createdFromUrlId_example", signUpDate: 123, email: "email_example", websiteUrl: "websiteUrl_example", username: "username_example", id: "id_example") // CreateAPISSOUserData |
7
8DefaultAPI.addSSOUser(tenantId: tenantId, createAPISSOUserData: createAPISSOUserData) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

deleteSSOUser Internal Link


パラメータ

名前場所必須説明
tenantIdstringqueryYes
idstringpathYes
deleteCommentsbooleanqueryNo
commentDeleteModestringqueryNo

レスポンス

戻り値: DeleteSSOUserAPIResponse

deleteSSOUser の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let deleteComments = true // Bool | (オプション)
8let commentDeleteMode = "commentDeleteMode_example" // String | (オプション)
9
10DefaultAPI.deleteSSOUser(tenantId: tenantId, id: id, options: DefaultAPI.DeleteSSOUserOptions(deleteComments: deleteComments, commentDeleteMode: commentDeleteMode)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getSSOUserByEmail Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
emailstringpathはい

レスポンス

戻り値: GetSSOUserByEmailAPIResponse

getSSOUserByEmail の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let email = "email_example" // String |
7
8DefaultAPI.getSSOUserByEmail(tenantId: tenantId, email: email) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getSSOUserById Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい

レスポンス

戻り値: GetSSOUserByIdAPIResponse

getSSOUserById の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getSSOUserById(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getSSOUsers Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
skipintegerqueryNo

レスポンス

戻り値: GetSSOUsersResponse

getSSOUsers の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let skip = 987 // Int | (任意)
7
8DefaultAPI.getSSOUsers(tenantId: tenantId, skip: skip) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

patchSSOUser Internal Link


パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい
idstringpathはい
updateCommentsbooleanqueryいいえ

レスポンス

戻り値: PatchSSOUserAPIResponse

patchSSOUser の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateAPISSOUserData = UpdateAPISSOUserData(groupIds: ["groupIds_example"], hasBlockedUsers: false, isProfileDMDisabled: false, isProfileCommentsPrivate: false, isProfileActivityPrivate: false, isCommentModeratorAdmin: false, isAdminAdmin: false, isAccountOwner: false, displayName: "displayName_example", displayLabel: "displayLabel_example", optedInSubscriptionNotifications: false, optedInNotifications: false, avatarSrc: "avatarSrc_example", loginCount: 123, createdFromUrlId: "createdFromUrlId_example", signUpDate: 123, email: "email_example", websiteUrl: "websiteUrl_example", username: "username_example", id: "id_example") // UpdateAPISSOUserData |
8let updateComments = true // Bool | (オプション)
9
10DefaultAPI.patchSSOUser(tenantId: tenantId, id: id, updateAPISSOUserData: updateAPISSOUserData, updateComments: updateComments) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

putSSOUser Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい
updateCommentsbooleanqueryいいえ

レスポンス

戻り値: PutSSOUserAPIResponse

putSSOUser の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateAPISSOUserData = UpdateAPISSOUserData(groupIds: ["groupIds_example"], hasBlockedUsers: false, isProfileDMDisabled: false, isProfileCommentsPrivate: false, isProfileActivityPrivate: false, isCommentModeratorAdmin: false, isAdminAdmin: false, isAccountOwner: false, displayName: "displayName_example", displayLabel: "displayLabel_example", optedInSubscriptionNotifications: false, optedInNotifications: false, avatarSrc: "avatarSrc_example", loginCount: 123, createdFromUrlId: "createdFromUrlId_example", signUpDate: 123, email: "email_example", websiteUrl: "websiteUrl_example", username: "username_example", id: "id_example") // UpdateAPISSOUserData |
8let updateComments = true // Bool | (省略可能)
9
10DefaultAPI.putSSOUser(tenantId: tenantId, id: id, updateAPISSOUserData: updateAPISSOUserData, updateComments: updateComments) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

createSubscription Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい

レスポンス

戻り値: CreateSubscriptionAPIResponse

createSubscription の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new までご報告ください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createAPIUserSubscriptionData = CreateAPIUserSubscriptionData(notificationFrequency: 123, pageTitle: "pageTitle_example", url: "url_example", urlId: "urlId_example", anonUserId: "anonUserId_example", userId: "userId_example") // CreateAPIUserSubscriptionData |
7
8DefaultAPI.createSubscription(tenantId: tenantId, createAPIUserSubscriptionData: createAPIUserSubscriptionData) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

deleteSubscription Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい
idstringpathはい
userIdstringqueryいいえ

レスポンス

戻り値: DeleteSubscriptionAPIResponse

deleteSubscription の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let userId = "userId_example" // String | (オプション)
8
9DefaultAPI.deleteSubscription(tenantId: tenantId, id: id, userId: userId) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getSubscriptions Internal Link


パラメータ

名前場所必須説明
tenantIdstringqueryはい
userIdstringqueryいいえ

レスポンス

戻り値: GetSubscriptionsAPIResponse

getSubscriptions の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new でご報告ください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String | (オプション)
7
8DefaultAPI.getSubscriptions(tenantId: tenantId, userId: userId) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

updateSubscription Internal Link

Parameters

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい
userIdstringqueryいいえ

Response

戻り値: UpdateSubscriptionAPIResponse

updateSubscription の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateAPIUserSubscriptionData = UpdateAPIUserSubscriptionData(notificationFrequency: 123) // UpdateAPIUserSubscriptionData |
8let userId = "userId_example" // String | (オプション)
9
10DefaultAPI.updateSubscription(tenantId: tenantId, id: id, updateAPIUserSubscriptionData: updateAPIUserSubscriptionData, userId: userId) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getTenantDailyUsages Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
yearNumbernumberqueryNo
monthNumbernumberqueryNo
dayNumbernumberqueryNo
skipnumberqueryNo

レスポンス

Returns: GetTenantDailyUsagesResponse

getTenantDailyUsages の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let yearNumber = 987 // Double | (オプション)
7let monthNumber = 987 // Double | (オプション)
8let dayNumber = 987 // Double | (オプション)
9let skip = 987 // Double | (オプション)
10
11DefaultAPI.getTenantDailyUsages(tenantId: tenantId, options: DefaultAPI.GetTenantDailyUsagesOptions(yearNumber: yearNumber, monthNumber: monthNumber, dayNumber: dayNumber, skip: skip)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

createTenantPackage Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい

レスポンス

戻り値: CreateTenantPackageResponse

createTenantPackage の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createTenantPackageBody = CreateTenantPackageBody(name: "name_example", monthlyCostUSD: 123, yearlyCostUSD: 123, monthlyStripePlanId: "monthlyStripePlanId_example", yearlyStripePlanId: "yearlyStripePlanId_example", maxMonthlyPageLoads: 123, maxMonthlyAPICredits: 123, maxMonthlySmallWidgetsCredits: 123, maxMonthlyComments: 123, maxConcurrentUsers: 123, maxTenantUsers: 123, maxSSOUsers: 123, maxModerators: 123, maxDomains: 123, maxWhiteLabeledTenants: 123, maxMonthlyEventLogRequests: 123, maxCustomCollectionSize: 123, hasWhiteLabeling: false, hasDebranding: false, hasLLMSpamDetection: false, forWhoText: "forWhoText_example", featureTaglines: ["featureTaglines_example"], hasAuditing: false, hasFlexPricing: false, enableSAML: false, flexPageLoadCostCents: 123, flexPageLoadUnit: 123, flexCommentCostCents: 123, flexCommentUnit: 123, flexSSOUserCostCents: 123, flexSSOUserUnit: 123, flexAPICreditCostCents: 123, flexAPICreditUnit: 123, flexSmallWidgetsCreditCostCents: 123, flexSmallWidgetsCreditUnit: 123, flexModeratorCostCents: 123, flexModeratorUnit: 123, flexAdminCostCents: 123, flexAdminUnit: 123, flexDomainCostCents: 123, flexDomainUnit: 123, flexLLMCostCents: 123, flexLLMUnit: 123, flexMinimumCostCents: 123, flexManagedTenantCostCents: 123, flexSSOAdminCostCents: 123, flexSSOAdminUnit: 123, flexSSOModeratorCostCents: 123, flexSSOModeratorUnit: 123) // CreateTenantPackageBody |
7
8DefaultAPI.createTenantPackage(tenantId: tenantId, createTenantPackageBody: createTenantPackageBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

deleteTenantPackage Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい

レスポンス

戻り値: APIEmptyResponse

deleteTenantPackage の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.deleteTenantPackage(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getTenantPackage Internal Link

パラメータ

名前場所必須説明
tenantIdstringクエリはい
idstringパスはい

レスポンス

戻り値: GetTenantPackageResponse

getTenantPackage の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new まで報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getTenantPackage(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getTenantPackages Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
skipnumberqueryいいえ

レスポンス

戻り値: GetTenantPackagesResponse

getTenantPackages の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let skip = 987 // Double | (オプション)
7
8DefaultAPI.getTenantPackages(tenantId: tenantId, skip: skip) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

replaceTenantPackage Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい

レスポンス

戻り値: APIEmptyResponse

replaceTenantPackage の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let replaceTenantPackageBody = ReplaceTenantPackageBody(name: "name_example", monthlyCostUSD: 123, yearlyCostUSD: 123, maxMonthlyPageLoads: 123, maxMonthlyAPICredits: 123, maxMonthlyComments: 123, maxConcurrentUsers: 123, maxTenantUsers: 123, maxSSOUsers: 123, maxModerators: 123, maxDomains: 123, maxCustomCollectionSize: 123, hasDebranding: false, forWhoText: "forWhoText_example", featureTaglines: ["featureTaglines_example"], hasFlexPricing: false, flexPageLoadCostCents: 123, flexPageLoadUnit: 123, flexCommentCostCents: 123, flexCommentUnit: 123, flexSSOUserCostCents: 123, flexSSOUserUnit: 123, flexAPICreditCostCents: 123, flexAPICreditUnit: 123, flexModeratorCostCents: 123, flexModeratorUnit: 123, flexAdminCostCents: 123, flexAdminUnit: 123, flexDomainCostCents: 123, flexDomainUnit: 123, flexMinimumCostCents: 123) // ReplaceTenantPackageBody |
8
9DefaultAPI.replaceTenantPackage(tenantId: tenantId, id: id, replaceTenantPackageBody: replaceTenantPackageBody) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

updateTenantPackage Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい
idstringpathはい

レスポンス

戻り値: APIEmptyResponse

updateTenantPackage の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new までご報告ください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateTenantPackageBody = UpdateTenantPackageBody(name: "name_example", monthlyCostUSD: 123, yearlyCostUSD: 123, maxMonthlyPageLoads: 123, maxMonthlyAPICredits: 123, maxMonthlyComments: 123, maxConcurrentUsers: 123, maxTenantUsers: 123, maxSSOUsers: 123, maxModerators: 123, maxDomains: 123, maxCustomCollectionSize: 123, hasDebranding: false, hasWhiteLabeling: false, forWhoText: "forWhoText_example", featureTaglines: ["featureTaglines_example"], hasFlexPricing: false, flexPageLoadCostCents: 123, flexPageLoadUnit: 123, flexCommentCostCents: 123, flexCommentUnit: 123, flexSSOUserCostCents: 123, flexSSOUserUnit: 123, flexAPICreditCostCents: 123, flexAPICreditUnit: 123, flexModeratorCostCents: 123, flexModeratorUnit: 123, flexAdminCostCents: 123, flexAdminUnit: 123, flexDomainCostCents: 123, flexDomainUnit: 123, flexMinimumCostCents: 123) // UpdateTenantPackageBody |
8
9DefaultAPI.updateTenantPackage(tenantId: tenantId, id: id, updateTenantPackageBody: updateTenantPackageBody) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

createTenantUser Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい

レスポンス

戻り値: CreateTenantUserResponse

createTenantUser の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createTenantUserBody = CreateTenantUserBody(username: "username_example", email: "email_example", displayName: "displayName_example", websiteUrl: "websiteUrl_example", signUpDate: 123, locale: "locale_example", verified: false, loginCount: 123, optedInNotifications: false, optedInTenantNotifications: false, hideAccountCode: false, avatarSrc: "avatarSrc_example", isHelpRequestAdmin: false, isAccountOwner: false, isAdminAdmin: false, isBillingAdmin: false, isAnalyticsAdmin: false, isCustomizationAdmin: false, isManageDataAdmin: false, isCommentModeratorAdmin: false, isAPIAdmin: false, moderatorIds: ["moderatorIds_example"], digestEmailFrequency: 123, displayLabel: "displayLabel_example") // CreateTenantUserBody |
7
8DefaultAPI.createTenantUser(tenantId: tenantId, createTenantUserBody: createTenantUserBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

deleteTenantUser Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい
deleteCommentsstringqueryいいえ
commentDeleteModestringqueryいいえ

レスポンス

戻り値: APIEmptyResponse

deleteTenantUser の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、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, options: DefaultAPI.DeleteTenantUserOptions(deleteComments: deleteComments, commentDeleteMode: commentDeleteMode)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getTenantUser Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい
idstringpathはい

レスポンス

戻り値: GetTenantUserResponse

getTenantUser の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getTenantUser(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getTenantUsers Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
skipnumberqueryいいえ

レスポンス

戻り値: GetTenantUsersResponse

getTenantUsers の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new までご報告ください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let skip = 987 // Double | (オプション)
7
8DefaultAPI.getTenantUsers(tenantId: tenantId, skip: skip) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

replaceTenantUser Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい
idstringpathはい
updateCommentsstringqueryいいえ

レスポンス

戻り値: APIEmptyResponse

replaceTenantUser の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let replaceTenantUserBody = ReplaceTenantUserBody(username: "username_example", email: "email_example", displayName: "displayName_example", websiteUrl: "websiteUrl_example", signUpDate: 123, locale: "locale_example", verified: false, loginCount: 123, optedInNotifications: false, optedInTenantNotifications: false, hideAccountCode: false, avatarSrc: "avatarSrc_example", isHelpRequestAdmin: false, isAccountOwner: false, isAdminAdmin: false, isBillingAdmin: false, isAnalyticsAdmin: false, isCustomizationAdmin: false, isManageDataAdmin: false, isCommentModeratorAdmin: false, isAPIAdmin: false, moderatorIds: ["moderatorIds_example"], digestEmailFrequency: 123, displayLabel: "displayLabel_example", createdFromUrlId: "createdFromUrlId_example", createdFromTenantId: "createdFromTenantId_example", lastLoginDate: 123, karma: 123) // ReplaceTenantUserBody |
8let updateComments = "updateComments_example" // String | (オプション)
9
10DefaultAPI.replaceTenantUser(tenantId: tenantId, id: id, replaceTenantUserBody: replaceTenantUserBody, updateComments: updateComments) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい
redirectURLstringqueryいいえ

レスポンス

戻り値: APIEmptyResponse

sendLoginLink の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let redirectURL = "redirectURL_example" // String | (オプション)
8
9DefaultAPI.sendLoginLink(tenantId: tenantId, id: id, redirectURL: redirectURL) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

updateTenantUser Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい
updateCommentsstringqueryいいえ

レスポンス

戻り値: APIEmptyResponse

updateTenantUser の例
Copy Copy
1
2// 以下のコードサンプルはまだベータです。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateTenantUserBody = UpdateTenantUserBody(username: "username_example", displayName: "displayName_example", websiteUrl: "websiteUrl_example", email: "email_example", signUpDate: 123, verified: false, loginCount: 123, optedInNotifications: false, optedInTenantNotifications: false, hideAccountCode: false, avatarSrc: "avatarSrc_example", isHelpRequestAdmin: false, isAccountOwner: false, isAdminAdmin: false, isBillingAdmin: false, isAnalyticsAdmin: false, isCustomizationAdmin: false, isManageDataAdmin: false, isCommentModeratorAdmin: false, isAPIAdmin: false, moderatorIds: ["moderatorIds_example"], locale: "locale_example", digestEmailFrequency: 123, displayLabel: "displayLabel_example") // UpdateTenantUserBody |
8let updateComments = "updateComments_example" // String | (オプション)
9
10DefaultAPI.updateTenantUser(tenantId: tenantId, id: id, updateTenantUserBody: updateTenantUserBody, updateComments: updateComments) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

createTenant Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい

レスポンス

戻り値: CreateTenantResponse

createTenant の例
Copy Copy
1
2// 以下のコードサンプルはまだベータです。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createTenantBody = CreateTenantBody(name: "name_example", domainConfiguration: [APIDomainConfiguration(id: "id_example", domain: "domain_example", emailFromName: "emailFromName_example", emailFromEmail: "emailFromEmail_example", emailHeaders: "TODO", wpSyncToken: "wpSyncToken_example", wpSynced: false, wpURL: "wpURL_example", createdAt: Date(), autoAddedDate: Date(), siteType: ImportedSiteType(), logoSrc: "logoSrc_example", logoSrc100px: "logoSrc100px_example", footerUnsubscribeURL: "footerUnsubscribeURL_example", disableUnsubscribeLinks: false)], email: "email_example", signUpDate: 123, packageId: "packageId_example", paymentFrequency: 123, billingInfoValid: false, billingHandledExternally: false, createdBy: "createdBy_example", isSetup: false, billingInfo: BillingInfo(name: "name_example", address: "address_example", city: "city_example", state: "state_example", zip: "zip_example", country: "country_example", currency: "currency_example", email: "email_example"), stripeCustomerId: "stripeCustomerId_example", stripeSubscriptionId: "stripeSubscriptionId_example", stripePlanId: "stripePlanId_example", enableProfanityFilter: false, enableSpamFilter: false, removeUnverifiedComments: false, unverifiedCommentsTTLms: 123, commentsRequireApproval: false, autoApproveCommentOnVerification: false, sendProfaneToSpam: false, deAnonIpAddr: 123, meta: "TODO") // CreateTenantBody |
7
8DefaultAPI.createTenant(tenantId: tenantId, createTenantBody: createTenantBody) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

deleteTenant Internal Link


パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい
idstringpathはい
surestringqueryいいえ

レスポンス

戻り値: APIEmptyResponse

deleteTenant の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題があれば http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let sure = "sure_example" // String | (任意)
8
9DefaultAPI.deleteTenant(tenantId: tenantId, id: id, sure: sure) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getTenant Internal Link


パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい

レスポンス

戻り値: GetTenantResponse

getTenant の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getTenant(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getTenants Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
metastringqueryNo
skipnumberqueryNo

レスポンス

返却: GetTenantsResponse

getTenants の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new に報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let meta = "meta_example" // String | (オプション)
7let skip = 987 // Double | (オプション)
8
9DefaultAPI.getTenants(tenantId: tenantId, options: DefaultAPI.GetTenantsOptions(meta: meta, skip: skip)) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

updateTenant Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい
idstringpathはい

レスポンス

戻り値: APIEmptyResponse

updateTenant Example
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

changeTicketState Internal Link


パラメータ

名前場所必須説明
tenantIdstringqueryはい
userIdstringqueryはい
idstringpathはい

レスポンス

戻り値: ChangeTicketStateResponse

changeTicketState の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String |
7let id = "id_example" // String |
8let changeTicketStateBody = ChangeTicketStateBody(state: 123) // ChangeTicketStateBody |
9
10DefaultAPI.changeTicketState(tenantId: tenantId, userId: userId, id: id, changeTicketStateBody: changeTicketStateBody) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

createTicket Internal Link

パラメータ

名前位置必須説明
tenantIdstringqueryはい
userIdstringqueryはい

レスポンス

返却値: CreateTicketResponse

createTicket の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String |
7let createTicketBody = CreateTicketBody(subject: "subject_example") // CreateTicketBody |
8
9DefaultAPI.createTicket(tenantId: tenantId, userId: userId, createTicketBody: createTicketBody) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getTicket Internal Link


パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい
idstringpathはい
userIdstringqueryいいえ

レスポンス

戻り値: GetTicketResponse

getTicket の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new からご報告ください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let userId = "userId_example" // String | (任意)
8
9DefaultAPI.getTicket(tenantId: tenantId, id: id, userId: userId) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getTickets Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
userIdstringqueryNo
statenumberqueryNo
skipnumberqueryNo
limitnumberqueryNo

応答

戻り値: GetTicketsResponse

getTickets の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String | (オプション)
7let state = 987 // Double | (オプション)
8let skip = 987 // Double | (オプション)
9let limit = 987 // Double | (オプション)
10
11DefaultAPI.getTickets(tenantId: tenantId, options: DefaultAPI.GetTicketsOptions(userId: userId, state: state, skip: skip, limit: limit)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

getTranslations Internal Link

パラメータ

名前場所必須説明
namespacestringpathはい
componentstringpathはい
localestringqueryいいえ
useFullTranslationIdsbooleanqueryいいえ

レスポンス

返却: GetTranslationsResponse

getTranslations 例
Copy Copy
1
2// 以下のコードサンプルはまだベータです。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let namespace = "namespace_example" // String |
6let component = "component_example" // String |
7let locale = "locale_example" // String | (オプション)
8let useFullTranslationIds = true // Bool | (オプション)
9
10PublicAPI.getTranslations(namespace: namespace, component: component, options: PublicAPI.GetTranslationsOptions(locale: locale, useFullTranslationIds: useFullTranslationIds)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

uploadImage Internal Link

画像のアップロードとリサイズ

パラメータ

名前場所必須説明
tenantIdstringpathYes
sizePresetstringqueryNoサイズプリセット: "Default" (1000x1000px) または "CrossPlatform" (一般的なデバイス用のサイズを作成)
urlIdstringqueryNoアップロードが行われているページの 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, options: PublicAPI.UploadImageOptions(sizePreset: sizePreset, urlId: urlId)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getUserBadgeProgressById Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい

レスポンス

返却値: APIGetUserBadgeProgressResponse

getUserBadgeProgressById の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getUserBadgeProgressById(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getUserBadgeProgressByUserId Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい
userIdstringpathはい

レスポンス

戻り値: APIGetUserBadgeProgressResponse

getUserBadgeProgressByUserId の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String |
7
8DefaultAPI.getUserBadgeProgressByUserId(tenantId: tenantId, userId: userId) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getUserBadgeProgressList Internal Link

パラメータ

名前タイプ場所必須説明
tenantIdstringqueryはい
userIdstringqueryいいえ
limitnumberqueryいいえ
skipnumberqueryいいえ

レスポンス

Returns: APIGetUserBadgeProgressListResponse

getUserBadgeProgressList の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new に報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String | (オプション)
7let limit = 987 // Double | (オプション)
8let skip = 987 // Double | (オプション)
9
10DefaultAPI.getUserBadgeProgressList(tenantId: tenantId, options: DefaultAPI.GetUserBadgeProgressListOptions(userId: userId, limit: limit, skip: skip)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

createUserBadge Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

レスポンス

戻り値: APICreateUserBadgeResponse

createUserBadge の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let createUserBadgeParams = CreateUserBadgeParams(userId: "userId_example", badgeId: "badgeId_example", displayedOnComments: false) // CreateUserBadgeParams |
7
8DefaultAPI.createUserBadge(tenantId: tenantId, createUserBadgeParams: createUserBadgeParams) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

deleteUserBadge Internal Link

パラメーター

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい

レスポンス

戻り値: APIEmptySuccessResponse

deleteUserBadge の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.deleteUserBadge(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getUserBadge Internal Link


パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい

レスポンス

返却: APIGetUserBadgeResponse

getUserBadge の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getUserBadge(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getUserBadges Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
userIdstringqueryいいえ
badgeIdstringqueryいいえ
typenumberqueryいいえ
displayedOnCommentsbooleanqueryいいえ
limitnumberqueryいいえ
skipnumberqueryいいえ

応答

返却: APIGetUserBadgesResponse

getUserBadges 例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題があれば、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let userId = "userId_example" // String | (オプション)
7let badgeId = "badgeId_example" // String | (オプション)
8let type = 987 // Double | (オプション)
9let displayedOnComments = true // Bool | (オプション)
10let limit = 987 // Double | (オプション)
11let skip = 987 // Double | (オプション)
12
13DefaultAPI.getUserBadges(tenantId: tenantId, options: DefaultAPI.GetUserBadgesOptions(userId: userId, badgeId: badgeId, type: type, displayedOnComments: displayedOnComments, limit: limit, skip: skip)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

updateUserBadge Internal Link


パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい
idstringpathはい

レスポンス

戻り値: APIEmptySuccessResponse

updateUserBadge の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new にて報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let updateUserBadgeParams = UpdateUserBadgeParams(displayedOnComments: false) // UpdateUserBadgeParams |
8
9DefaultAPI.updateUserBadge(tenantId: tenantId, id: id, updateUserBadgeParams: updateUserBadgeParams) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getUserNotificationCount Internal Link


パラメータ

名前場所必須説明
tenantIdstringqueryはい
ssostringqueryいいえ

レスポンス

返却値: GetUserNotificationCountResponse

getUserNotificationCount の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
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

パラメータ

名前場所必須説明
tenantIdstringqueryYes
urlIdstringqueryNo現在のページが購読されているかどうかを判定するために使用されます。
pageSizeintegerqueryNo
afterIdstringqueryNo
includeContextbooleanqueryNo
afterCreatedAtintegerqueryNo
unreadOnlybooleanqueryNo
dmOnlybooleanqueryNo
noDmbooleanqueryNo
includeTranslationsbooleanqueryNo
includeTenantNotificationsbooleanqueryNo
ssostringqueryNo

レスポンス

Returns: GetMyNotificationsResponse

getUserNotifications の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題があれば、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String | 現在のページが購読されているかどうかを判定するために使用されます。(optional)
7let pageSize = 987 // Int | (optional)
8let afterId = "afterId_example" // String | (optional)
9let includeContext = true // Bool | (optional)
10let afterCreatedAt = 987 // Int64 | (optional)
11let unreadOnly = true // Bool | (optional)
12let dmOnly = true // Bool | (optional)
13let noDm = true // Bool | (optional)
14let includeTranslations = true // Bool | (optional)
15let includeTenantNotifications = true // Bool | (optional)
16let sso = "sso_example" // String | (optional)
17
18PublicAPI.getUserNotifications(tenantId: tenantId, options: PublicAPI.GetUserNotificationsOptions(urlId: urlId, pageSize: pageSize, afterId: afterId, includeContext: includeContext, afterCreatedAt: afterCreatedAt, unreadOnly: unreadOnly, dmOnly: dmOnly, noDm: noDm, includeTranslations: includeTranslations, includeTenantNotifications: includeTenantNotifications, sso: sso)) { (response, error) in
19 guard error == nil else {
20 print(error)
21 return
22 }
23
24 if (response) {
25 dump(response)
26 }
27}
28

resetUserNotificationCount Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい
ssostringqueryいいえ

レスポンス

戻り値: ResetUserNotificationsResponse

resetUserNotificationCount の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let sso = "sso_example" // String | (オプション)
7
8PublicAPI.resetUserNotificationCount(tenantId: tenantId, sso: sso) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

resetUserNotifications Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
afterIdstringqueryNo
afterCreatedAtintegerqueryNo
unreadOnlybooleanqueryNo
dmOnlybooleanqueryNo
noDmbooleanqueryNo
ssostringqueryNo

レスポンス

返却: ResetUserNotificationsResponse

resetUserNotifications の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let afterId = "afterId_example" // String | (オプション)
7let afterCreatedAt = 987 // Int64 | (オプション)
8let unreadOnly = true // Bool | (オプション)
9let dmOnly = true // Bool | (オプション)
10let noDm = true // Bool | (オプション)
11let sso = "sso_example" // String | (オプション)
12
13PublicAPI.resetUserNotifications(tenantId: tenantId, options: PublicAPI.ResetUserNotificationsOptions(afterId: afterId, afterCreatedAt: afterCreatedAt, unreadOnly: unreadOnly, dmOnly: dmOnly, noDm: noDm, sso: sso)) { (response, error) in
14 guard error == nil else {
15 print(error)
16 return
17 }
18
19 if (response) {
20 dump(response)
21 }
22}
23

updateUserNotificationCommentSubscriptionStatus Internal Link

特定のコメントに対する通知を有効化または無効化します。

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい
notificationIdstringpathはい
optedInOrOutstringpathはい
commentIdstringqueryはい
ssostringqueryいいえ

レスポンス

戻り値: UpdateUserNotificationCommentSubscriptionStatusResponse

updateUserNotificationCommentSubscriptionStatus の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let notificationId = "notificationId_example" // String |
7let optedInOrOut = "optedInOrOut_example" // String |
8let commentId = "commentId_example" // String |
9let sso = "sso_example" // String | (オプション)
10
11PublicAPI.updateUserNotificationCommentSubscriptionStatus(tenantId: tenantId, notificationId: notificationId, optedInOrOut: optedInOrOut, commentId: commentId, sso: sso) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

updateUserNotificationPageSubscriptionStatus Internal Link


ページの通知を有効または無効にします。ユーザーがページを購読している場合、新しいルートコメントに対して通知が作成され、また

パラメータ

名前場所必須説明
tenantIdstringqueryはい
urlIdstringqueryはい
urlstringqueryはい
pageTitlestringqueryはい
subscribedOrUnsubscribedstringpathはい
ssostringqueryいいえ

レスポンス

返却値: UpdateUserNotificationPageSubscriptionStatusResponse

updateUserNotificationPageSubscriptionStatus の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let url = "url_example" // String |
8let pageTitle = "pageTitle_example" // String |
9let subscribedOrUnsubscribed = "subscribedOrUnsubscribed_example" // String |
10let sso = "sso_example" // String | (オプション)
11
12PublicAPI.updateUserNotificationPageSubscriptionStatus(tenantId: tenantId, urlId: urlId, url: url, pageTitle: pageTitle, subscribedOrUnsubscribed: subscribedOrUnsubscribed, sso: sso) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

updateUserNotificationStatus Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
notificationIdstringpathYes
newStatusstringpathYes
ssostringqueryNo

レスポンス

戻り値: UpdateUserNotificationStatusResponse

updateUserNotificationStatus の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let notificationId = "notificationId_example" // String |
7let newStatus = "newStatus_example" // String |
8let sso = "sso_example" // String | (オプション)
9
10PublicAPI.updateUserNotificationStatus(tenantId: tenantId, notificationId: notificationId, newStatus: newStatus, sso: sso) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

getUserPresenceStatuses Internal Link


パラメータ

名前場所必須説明
tenantIdstringクエリはい
urlIdWSstringクエリはい
userIdsstringクエリはい

レスポンス

返却: GetUserPresenceStatusesResponse

getUserPresenceStatuses の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlIdWS = "urlIdWS_example" // String |
7let userIds = "userIds_example" // String |
8
9PublicAPI.getUserPresenceStatuses(tenantId: tenantId, urlIdWS: urlIdWS, userIds: userIds) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

searchUsers Internal Link

パラメータ

名前タイプ場所必須説明
tenantIdstringpathYes
urlIdstringqueryYes
usernameStartsWithstringqueryNo
mentionGroupIdsarrayqueryNo
ssostringqueryNo
searchSectionstringqueryNo

レスポンス

Returns: SearchUsersResult

searchUsers の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let usernameStartsWith = "usernameStartsWith_example" // String | (optional)
8let mentionGroupIds = ["inner_example"] // [String] | (optional)
9let sso = "sso_example" // String | (optional)
10let searchSection = "searchSection_example" // String | (optional)
11
12PublicAPI.searchUsers(tenantId: tenantId, urlId: urlId, options: PublicAPI.SearchUsersOptions(usernameStartsWith: usernameStartsWith, mentionGroupIds: mentionGroupIds, sso: sso, searchSection: searchSection)) { (response, error) in
13 guard error == nil else {
14 print(error)
15 return
16 }
17
18 if (response) {
19 dump(response)
20 }
21}
22

getUser Internal Link


パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryはい
idstringpathはい

レスポンス

戻り値: GetUserResponse

getUser の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new を通じて報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7
8DefaultAPI.getUser(tenantId: tenantId, id: id) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

createVote Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
commentIdstringqueryYes
directionstringqueryYes
userIdstringqueryNo
anonUserIdstringqueryNo

応答

返り値: VoteResponse

createVote の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let commentId = "commentId_example" // String |
7let direction = "direction_example" // String |
8let userId = "userId_example" // String | (オプション)
9let anonUserId = "anonUserId_example" // String | (オプション)
10
11DefaultAPI.createVote(tenantId: tenantId, commentId: commentId, direction: direction, options: DefaultAPI.CreateVoteOptions(userId: userId, anonUserId: anonUserId)) { (response, error) in
12 guard error == nil else {
13 print(error)
14 return
15 }
16
17 if (response) {
18 dump(response)
19 }
20}
21

deleteVote Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryはい
idstringpathはい
editKeystringqueryいいえ

レスポンス

戻り値: VoteDeleteResponse

deleteVote の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let id = "id_example" // String |
7let editKey = "editKey_example" // String | (オプション)
8
9DefaultAPI.deleteVote(tenantId: tenantId, id: id, editKey: editKey) { (response, error) in
10 guard error == nil else {
11 print(error)
12 return
13 }
14
15 if (response) {
16 dump(response)
17 }
18}
19

getVotes Internal Link

パラメータ

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
urlIdstringqueryYes

レスポンス

戻り値: GetVotesResponse

getVotes の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は http://github.com/OpenAPITools/openapi-generator/issues/new で報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7
8DefaultAPI.getVotes(tenantId: tenantId, urlId: urlId) { (response, error) in
9 guard error == nil else {
10 print(error)
11 return
12 }
13
14 if (response) {
15 dump(response)
16 }
17}
18

getVotesForUser Internal Link

パラメータ

名前場所必須説明
tenantIdstringqueryYes
urlIdstringqueryYes
userIdstringqueryNo
anonUserIdstringqueryNo

レスポンス

返却: GetVotesForUserResponse

getVotesForUser の例
Copy Copy
1
2// 以下のコードサンプルはまだベータ版です。問題がある場合は、http://github.com/OpenAPITools/openapi-generator/issues/new へ報告してください
3import FastCommentsSwift
4
5let tenantId = "tenantId_example" // String |
6let urlId = "urlId_example" // String |
7let userId = "userId_example" // String | (オプション)
8let anonUserId = "anonUserId_example" // String | (オプション)
9
10DefaultAPI.getVotesForUser(tenantId: tenantId, urlId: urlId, options: DefaultAPI.GetVotesForUserOptions(userId: userId, anonUserId: anonUserId)) { (response, error) in
11 guard error == nil else {
12 print(error)
13 return
14 }
15
16 if (response) {
17 dump(response)
18 }
19}
20

ヘルプが必要ですか?

Swift SDK に関して問題が発生した場合や質問がある場合は、次のいずれかを行ってください:

貢献

貢献を歓迎します!貢献ガイドラインはGitHubリポジトリをご覧ください。