
言語 🇯🇵 日本語
はじめに
ドキュメント
APIリファレンス
集計
監査ログ
コメントからブロック
ブロックされたコメントの確認
コメント
ドメイン設定
メールテンプレート
イベントログ
フィード投稿
コメントの通報
ハッシュタグ
モデレーター
通知カウント
通知
ページ
保留中のWebhookイベント
質問設定
質問結果
質問結果の集計
SSOユーザー
サブスクリプション
テナントの日次使用量
テナントパッケージ
テナントユーザー
テナント
画像アップロード
ユーザーバッジの進捗
ユーザーバッジ
ユーザー通知
ユーザーのプレゼンスステータス
ユーザー検索
ユーザー
投票
FastComments Swift SDK
これは FastComments の公式 Swift SDK です。
FastComments API の公式 Swift SDK
リポジトリ
インストール 
Swift パッケージマネージャー
次の内容を Package.swift ファイルに追加してください:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "0.0.1")
]
または Xcode で:
- ファイル > パッケージを追加...
- リポジトリの URL を入力してください:
https://github.com/fastcomments/fastcomments-swift.git - 使用するバージョンを選択します
要件
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
ライブラリの内容 
The FastComments Swift SDK は、いくつかのモジュールで構成されています:
Client Module - FastComments REST API 用に自動生成された API クライアント
- すべての API モデルに対する完全な型定義
- 認証済み(
DefaultAPI)とパブリック(PublicAPI)の両方のエンドポイント - 完全な async/await サポート
- 詳細な API ドキュメントは client/README.md を参照してください
SSO Module - サーバーサイドのシングルサインオン用ユーティリティ
- ユーザー認証のための安全なトークン生成
- シンプルな SSO モードとセキュアな SSO モードの両方をサポート
- CryptoKit を使用した HMAC-SHA256 ベースのトークン署名
クイックスタート 
パブリックAPIの使用
import FastCommentsSwift
// APIクライアントを作成
let publicApi = PublicAPI()
// ページのコメントを取得
do {
let response = try await publicApi.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Found \(response.comments?.count ?? 0) comments")
for comment in response.comments ?? [] {
print("Comment: \(comment.comment ?? "")")
}
} catch {
print("Error fetching comments: \(error)")
}
認証済みAPIの使用
import FastCommentsSwift
// APIキーで設定を作成
let defaultApi = DefaultAPI()
defaultApi.apiKey = "your-api-key"
// 認証済みAPIを使ってコメントを取得
do {
let response = try await defaultApi.getComments(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Total comments: \(response.count ?? 0)")
for comment in response.comments ?? [] {
print("Comment ID: \(comment.id ?? ""), Text: \(comment.comment ?? "")")
}
} catch {
print("Error: \(error)")
}
SSOを使った認証
セキュアSSO(本番環境に推奨)
import FastCommentsSwift
let apiKey = "your-api-key"
// セキュアSSOユーザーデータを作成(サーバー側のみ!)
let userData = SecureSSOUserData(
id: "user-123", // ユーザーID
email: "user@example.com", // メール
username: "johndoe", // ユーザー名
avatar: "https://example.com/avatar.jpg" // アバターのURL
)
// SSOトークンを生成
do {
let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
let token = try sso.createToken()
print("SSO Token: \(token ?? "")")
// このトークンをフロントエンドに渡して認証に使用する
} catch {
print("Error creating SSO token: \(error)")
}
シンプルSSO(開発/テスト用)
import FastCommentsSwift
// シンプルSSOユーザーデータを作成(APIキー不要)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// シンプルSSOトークンを生成
let sso = FastCommentsSSO.createSimple(simpleSSOUserData: userData)
do {
let token = try sso.createToken()
print("Simple SSO Token: \(token ?? "")")
} catch {
print("Error creating SSO token: \(error)")
}
公開APIと保護されたAPIの違い 
The FastComments SDK provides two types of API endpoints:
PublicAPI - クライアント向け安全エンドポイント
The PublicAPI contains endpoints that are safe to call from client-side code (iOS/macOS apps). These endpoints:
- API key を必要としません
- 認証に SSO tokens を使用できます
- ユーザー/デバイスごとにレート制限されます
- エンドユーザー向けアプリケーションに適しています
Example use case: iOSアプリでのコメントの取得と作成
DefaultAPI - サーバーサイドエンドポイント
The DefaultAPI contains authenticated endpoints that require an API key. These endpoints:
- あなたの FastComments API key が必要です
- サーバー側のコードからのみ呼び出すべきです
- あなたの FastComments データへのフルアクセスを提供します
- テナントごとにレート制限されます
Example use case: 管理操作、大量データのエクスポート、モデレーションツール
IMPORTANT: クライアント側のコードに API key を決して公開しないでください。API keys はサーバー側でのみ使用してください。
APIの呼び出し方 
Swift SDK はすべての API 呼び出しに対してモダンな async/await 構文を使用します:
let response = try await publicApi.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
よくある問題 
401 Unauthorized エラー
認証された API を使用している際に 401 エラーが発生する場合:
- API key を確認: FastComments ダッシュボードの正しい API key を使用していることを確認してください
- tenant ID を確認: tenant ID がアカウントに一致していることを確認してください
- API key の設定方法: API key は API クライアントに設定する必要があります:
let defaultApi = DefaultAPI()
defaultApi.apiKey = "YOUR_API_KEY"
- 誤った API を使用していないか: 認証が必要な呼び出しでは
DefaultAPI(PublicAPIではない)を使用していることを確認してください
SSO トークンの問題
SSO トークンが機能しない場合:
- 本番では secure mode を使用: 本番環境では常に
FastCommentsSSO.createSecure()を API key とともに使用してください - サーバー側のみで生成: セキュアな SSO トークンはサーバーで生成し、API key をクライアントに露出しないでください
- ユーザーデータを確認: 必要なすべてのフィールド (id, email, username) が提供されていることを確認してください
- トークンの有効期限: セキュアな SSO トークンにはタイムスタンプが含まれ、期限切れになる可能性があります。必要に応じて新しいトークンを生成してください。
SSL/TLS エラー
SSL/TLS エラーが発生した場合:
- アプリの Info.plist が fastcomments.com への HTTPS 接続を許可していることを確認してください
- 接続をブロックする可能性のある App Transport Security の例外を使用していないか確認してください
注意事項 
ブロードキャストID
いくつかの API 呼び出しで broadcastId を渡す必要があることがわかるでしょう。イベントを受信すると、この ID が返されます。クライアント側で楽観的に変更を適用するつもりなら(これは最良の体験を提供するため、おそらくそうするでしょう)、そのイベントを無視すべきかどうかがわかります。ここには UUID を渡してください。ID はセッション内で二度出現しない程度に十分一意である必要があります。
let broadcastId = UUID().uuidString
集計 
ドキュメントをグループ化(groupBy が指定されている場合)して複数の操作を適用することでドキュメントを集計します。異なる操作(例: sum、countDistinct、avg など)に対応しています。
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| parentTenantId | string | query | いいえ | |
| includeStats | boolean | query | いいえ |
レスポンス
返却値: AggregationResponse
例

監査ログを取得 
パラメータ
| 名前 | 型 | 位置 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| limit | number | query | いいえ | |
| skip | number | query | いいえ | |
| order | string | query | いいえ | |
| after | number | query | いいえ | |
| before | number | query | いいえ |
レスポンス
例

コメントからブロック(公開) 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: BlockFromCommentPublic200Response
例

コメントのブロック解除(公開) 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: UnBlockCommentPublic200Response
例

ブロック済みのコメントをチェック 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| commentIds | string | クエリ | はい | カンマ区切りのコメントIDの一覧。 |
| sso | string | クエリ | いいえ |
レスポンス
戻り値: CheckedCommentsForBlocked200Response
例

コメントからユーザーをブロック 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
レスポンス
戻り値: BlockFromCommentPublic200Response
例

コメント作成(公開) 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| broadcastId | string | query | はい | |
| sessionId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: CreateCommentPublic200Response
例

コメントを削除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| contextUserId | string | query | いいえ | |
| isLive | boolean | query | いいえ |
レスポンス
例

コメント削除(公開) 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | はい | |
| editKey | string | query | いいえ | |
| sso | string | query | いいえ |
Response
戻り値: DeleteCommentPublic200Response
例

コメントの投票を削除 
パラメータ
| 名前 | 型 | 位置 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| voteId | string | path | はい | |
| urlId | string | query | はい | |
| broadcastId | string | query | はい | |
| editKey | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: DeleteCommentVote200Response
例

コメントを通報 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| userId | string | query | いいえ | |
| anonUserId | string | query | いいえ |
レスポンス
例

コメントを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
例

コメント一覧を取得 
パラメータ
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| page | integer | query | いいえ | |
| limit | integer | query | いいえ | |
| skip | integer | query | いいえ | |
| asTree | boolean | query | いいえ | |
| skipChildren | integer | query | いいえ | |
| limitChildren | integer | query | いいえ | |
| maxTreeDepth | integer | query | いいえ | |
| urlId | string | query | いいえ | |
| userId | string | query | いいえ | |
| anonUserId | string | query | いいえ | |
| contextUserId | string | query | いいえ | |
| hashTag | string | query | いいえ | |
| parentId | string | query | いいえ | |
| direction | string | query | いいえ |
レスポンス
例

コメント一覧を取得(公開) 
req tenantId urlId
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| page | integer | query | いいえ | |
| direction | string | query | いいえ | |
| sso | string | query | いいえ | |
| skip | integer | query | いいえ | |
| skipChildren | integer | query | いいえ | |
| limit | integer | query | いいえ | |
| limitChildren | integer | query | いいえ | |
| countChildren | boolean | query | いいえ | |
| fetchPageForCommentId | string | query | いいえ | |
| includeConfig | boolean | query | いいえ | |
| countAll | boolean | query | いいえ | |
| includei10n | boolean | query | いいえ | |
| locale | string | query | いいえ | |
| modules | string | query | いいえ | |
| isCrawler | boolean | query | いいえ | |
| includeNotificationCount | boolean | query | いいえ | |
| asTree | boolean | query | いいえ | |
| maxTreeDepth | integer | query | いいえ | |
| useFullTranslationIds | boolean | query | いいえ | |
| parentId | string | query | いいえ | |
| searchText | string | query | いいえ | |
| hashTags | array | query | いいえ | |
| userId | string | query | いいえ | |
| customConfigStr | string | query | いいえ | |
| afterCommentId | string | query | いいえ | |
| beforeCommentId | string | query | いいえ |
レスポンス
返却値: GetCommentsPublic200Response
例

コメント本文を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
レスポンス
返却値: GetCommentText200Response
例

コメントに投票したユーザー名を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| dir | integer | query | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: GetCommentVoteUserNames200Response
例

コメントをロック 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
例

コメントをピン留め 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
例

コメントを保存 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| isLive | boolean | query | いいえ | |
| doSpamCheck | boolean | query | いいえ | |
| sendEmails | boolean | query | いいえ | |
| populateNotifications | boolean | query | いいえ |
レスポンス
例

コメントを一括保存 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| isLive | boolean | query | いいえ | |
| doSpamCheck | boolean | query | いいえ | |
| sendEmails | boolean | query | いいえ | |
| populateNotifications | boolean | query | いいえ |
レスポンス
例

コメント本文を設定 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | はい | |
| editKey | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: SetCommentText200Response
例

コメントのユーザーのブロック解除 
パラメータ
| 名称 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| userId | string | query | いいえ | |
| anonUserId | string | query | いいえ |
レスポンス
戻り値: UnBlockCommentPublic200Response
例

コメントの通報を取り消す 
パラメーター
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| userId | string | query | いいえ | |
| anonUserId | string | query | いいえ |
レスポンス
例

コメントのロック解除 
パラメーター
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
例

コメントのピン留めを解除 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
例

コメントを更新 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| doSpamCheck | boolean | query | No | |
| isLive | boolean | query | No |
レスポンス
戻り値: FlagCommentPublic200Response
例

コメントに投票 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| urlId | string | query | はい | |
| broadcastId | string | query | はい | |
| sessionId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
例

ドメイン設定を追加 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: AddDomainConfig200Response
例

ドメイン設定を削除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| domain | string | path | はい |
レスポンス
戻り値: DeleteDomainConfig200Response
例

ドメイン設定を取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| domain | string | path | はい |
レスポンス
戻り値: GetDomainConfig200Response
例

ドメイン設定一覧を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | クエリ | はい |
レスポンス
戻り値: GetDomainConfigs200Response
例

ドメイン設定を部分更新 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| domainToUpdate | string | path | はい |
レスポンス
戻り値: GetDomainConfig200Response
例

ドメイン設定を置換 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| domainToUpdate | string | path | はい |
レスポンス
返却: GetDomainConfig200Response
例

メールテンプレートを作成 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: CreateEmailTemplate200Response
例

メールテンプレートを削除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: FlagCommentPublic200Response
例

メールテンプレートのレンダリングエラーを削除 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| errorId | string | path | はい |
レスポンス
戻り値: FlagCommentPublic200Response
例

メールテンプレートを取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: GetEmailTemplate200Response
例

メールテンプレート定義を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: GetEmailTemplateDefinitions200Response
例

メールテンプレートのレンダリングエラーを取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| skip | number | query | No |
レスポンス
戻り値: GetEmailTemplateRenderErrors200Response
例

メールテンプレート一覧を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
レスポンス
戻り値: GetEmailTemplates200Response
例

メールテンプレートをレンダリング 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| locale | string | query | いいえ |
レスポンス
戻り値: RenderEmailTemplate200Response
例

メールテンプレートを更新 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: FlagCommentPublic200Response
例

イベントログを取得 
req tenantId urlId userIdWS
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| userIdWS | string | query | Yes | |
| startTime | integer | query | Yes | |
| endTime | integer | query | Yes |
レスポンス
例

グローバルイベントログを取得 
req tenantId urlId userIdWS
パラメータ
| Name | Type | Location | 必須 | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| userIdWS | string | query | はい | |
| startTime | integer | query | はい | |
| endTime | integer | query | はい |
レスポンス
例

フィード投稿を作成 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| broadcastId | string | query | いいえ | |
| isLive | boolean | query | いいえ | |
| doSpamCheck | boolean | query | いいえ | |
| skipDupCheck | boolean | query | いいえ |
レスポンス
戻り値: CreateFeedPost200Response
例

フィード投稿を作成(公開) 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
レスポンス
戻り値: CreateFeedPostPublic200Response
例

フィード投稿を削除(公開) 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| postId | string | path | はい | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
返却: DeleteFeedPostPublic200Response
例

フィード投稿一覧を取得 
req tenantId afterId
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| afterId | string | query | いいえ | |
| limit | integer | query | いいえ | |
| tags | array | query | いいえ |
レスポンス
例

フィード投稿一覧を取得(公開) 
req tenantId afterId
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| afterId | string | query | いいえ | |
| limit | integer | query | いいえ | |
| tags | array | query | いいえ | |
| sso | string | query | いいえ | |
| isCrawler | boolean | query | いいえ | |
| includeUserInfo | boolean | query | いいえ |
レスポンス
戻り値: GetFeedPostsPublic200Response
例

フィード投稿の統計を取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| postIds | array | query | はい | |
| sso | string | query | いいえ |
レスポンス
返却: GetFeedPostsStats200Response
例

ユーザーのリアクションを取得(公開) 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| postIds | array | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: GetUserReactsPublic200Response
例

フィード投稿にリアクション(公開) 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| postId | string | path | はい | |
| isUndo | boolean | query | いいえ | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
Response
戻り値: ReactFeedPostPublic200Response
例

フィード投稿を更新 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: FlagCommentPublic200Response
例

フィード投稿を更新(公開) 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| postId | string | path | はい | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: CreateFeedPostPublic200Response
例

コメントを通報(公開) 
パラメータ
| Name | Type | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| isFlagged | boolean | query | はい | |
| sso | string | query | いいえ |
レスポンス
返却: FlagCommentPublic200Response
例

ハッシュタグを追加 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | いいえ |
レスポンス
例

ハッシュタグを一括追加 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | いいえ |
レスポンス
戻り値: AddHashTagsBulk200Response
例

ハッシュタグを削除 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tag | string | path | はい | |
| tenantId | string | query | いいえ |
レスポンス
返却: FlagCommentPublic200Response
例

ハッシュタグ一覧を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| page | number | query | いいえ |
レスポンス
例

ハッシュタグを部分更新 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tag | string | path | はい | |
| tenantId | string | query | いいえ |
レスポンス
例

モデレーターを作成 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
返却値: CreateModerator200Response
例

モデレーターを削除 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| sendEmail | string | query | いいえ |
レスポンス
戻り値: FlagCommentPublic200Response
例

モデレーターを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
例

モデレーター一覧を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | number | query | いいえ |
レスポンス
例

招待を送信 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| fromName | string | query | はい |
レスポンス
戻り値: FlagCommentPublic200Response
例

モデレーターを更新 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: FlagCommentPublic200Response
例

通知カウントを削除 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: FlagCommentPublic200Response
例

キャッシュされた通知カウントを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: GetCachedNotificationCount200Response
例

通知カウントを取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | いいえ | |
| urlId | string | query | いいえ | |
| fromCommentId | string | query | いいえ | |
| viewed | boolean | query | いいえ | |
| type | string | query | いいえ |
レスポンス
戻り値: GetNotificationCount200Response
例

通知一覧を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | いいえ | |
| urlId | string | query | いいえ | |
| fromCommentId | string | query | いいえ | |
| viewed | boolean | query | いいえ | |
| type | string | query | いいえ | |
| skip | number | query | いいえ |
レスポンス
返却値: GetNotifications200Response
例

通知を更新 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| id | string | パス | はい | |
| userId | string | クエリ | いいえ |
レスポンス
戻り値: FlagCommentPublic200Response
例

ページを追加 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: AddPageAPIResponse
例

ページを削除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
例

URL IDでページを取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlId | string | query | はい |
レスポンス
戻り値: GetPageByURLIdAPIResponse
例

ページ一覧を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: GetPagesAPIResponse
例

ページを部分更新 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: PatchPageAPIResponse
例

保留中のWebhookイベントを削除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| id | string | パス | はい |
レスポンス
戻り値: FlagCommentPublic200Response
例

保留中のWebhookイベント数を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | query | いいえ | |
| externalId | string | query | いいえ | |
| eventType | string | query | いいえ | |
| type | string | query | いいえ | |
| domain | string | query | いいえ | |
| attemptCountGT | number | query | いいえ |
レスポンス
戻り値: GetPendingWebhookEventCount200Response
例

保留中のWebhookイベント一覧を取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | query | いいえ | |
| externalId | string | query | いいえ | |
| eventType | string | query | いいえ | |
| type | string | query | いいえ | |
| domain | string | query | いいえ | |
| attemptCountGT | number | query | いいえ | |
| skip | number | query | いいえ |
レスポンス
戻り値: GetPendingWebhookEvents200Response
例

質問設定を作成 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
返却値: CreateQuestionConfig200Response
例

質問設定を削除 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: FlagCommentPublic200Response
例

質問設定を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: GetQuestionConfig200Response
例

質問設定一覧を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | number | query | いいえ |
レスポンス
返却値: GetQuestionConfigs200Response
例

質問設定を更新 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: FlagCommentPublic200Response
例

質問結果を作成 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: CreateQuestionResult200Response
例

質問結果を削除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
返却: FlagCommentPublic200Response
例

質問結果を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: GetQuestionResult200Response
例

質問結果一覧を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlId | string | query | いいえ | |
| userId | string | query | いいえ | |
| startDate | string | query | いいえ | |
| questionId | string | query | いいえ | |
| questionIds | string | query | いいえ | |
| skip | number | query | いいえ |
レスポンス
戻り値: GetQuestionResults200Response
例

質問結果を更新 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
返却: FlagCommentPublic200Response
例

質問結果を集計 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| questionId | string | query | いいえ | |
| questionIds | array | query | いいえ | |
| urlId | string | query | いいえ | |
| timeBucket | string | query | いいえ | |
| startDate | string | query | いいえ | |
| forceRecalculate | boolean | query | いいえ |
レスポンス
戻り値: AggregateQuestionResults200Response
例

質問結果を一括集計 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| forceRecalculate | boolean | query | いいえ |
レスポンス
戻り値: BulkAggregateQuestionResults200Response
例

コメントと質問結果を結合 
パラメーター
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| questionId | string | query | いいえ | |
| questionIds | array | query | いいえ | |
| urlId | string | query | いいえ | |
| startDate | string | query | いいえ | |
| forceRecalculate | boolean | query | いいえ | |
| minValue | number | query | いいえ | |
| maxValue | number | query | いいえ | |
| limit | number | query | いいえ |
レスポンス
返却: CombineCommentsWithQuestionResults200Response
例

SSOユーザーを追加 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
例

SSOユーザーを削除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| deleteComments | boolean | query | いいえ | |
| commentDeleteMode | string | query | いいえ |
レスポンス
例

メールでSSOユーザーを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| string | path | はい |
レスポンス
戻り値: GetSSOUserByEmailAPIResponse
例

IDでSSOユーザーを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: GetSSOUserByIdAPIResponse
例

SSOユーザー一覧を取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | integer | query | いいえ |
レスポンス
例

SSOユーザーを部分更新 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| updateComments | boolean | query | いいえ |
レスポンス
例

SSOユーザーを置換 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| updateComments | boolean | query | いいえ |
レスポンス
例

サブスクリプションを作成 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: CreateSubscriptionAPIResponse
例

サブスクリプションを削除 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| userId | string | query | いいえ |
レスポンス
戻り値: DeleteSubscriptionAPIResponse
例

サブスクリプション一覧を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | いいえ |
レスポンス
戻り値: GetSubscriptionsAPIResponse
例

テナントの日次使用量を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| yearNumber | number | query | いいえ | |
| monthNumber | number | query | いいえ | |
| dayNumber | number | query | いいえ | |
| skip | number | query | いいえ |
レスポンス
戻り値: GetTenantDailyUsages200Response
例

テナントパッケージを作成 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: CreateTenantPackage200Response
例

テナントパッケージを削除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: FlagCommentPublic200Response
例

テナントパッケージを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: GetTenantPackage200Response
例

テナントパッケージ一覧を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | number | query | いいえ |
レスポンス
戻り値: GetTenantPackages200Response
例

テナントパッケージを置換 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: FlagCommentPublic200Response
例

テナントパッケージを更新 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: FlagCommentPublic200Response
例

テナントユーザーを作成 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
返却値: CreateTenantUser200Response
例

テナントユーザーを削除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| deleteComments | string | query | いいえ | |
| commentDeleteMode | string | query | いいえ |
レスポンス
戻り値: FlagCommentPublic200Response
例

テナントユーザーを取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
例

テナントユーザー一覧を取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | number | query | いいえ |
レスポンス
戻り値: GetTenantUsers200Response
例

テナントユーザーを置換 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| updateComments | string | query | いいえ |
レスポンス
戻り値: FlagCommentPublic200Response
例

ログインリンクを送信 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| redirectURL | string | query | いいえ |
レスポンス
戻り値: FlagCommentPublic200Response
例

テナントユーザーを更新 
パラメータ
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| updateComments | string | query | いいえ |
レスポンス
戻り値: FlagCommentPublic200Response
例

テナントを作成 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
例

テナントを削除 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| sure | string | query | いいえ |
レスポンス
戻り値: FlagCommentPublic200Response
例

テナントを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: GetTenant200Response
例

テナント一覧を取得 
パラメーター
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| meta | string | query | いいえ | |
| skip | number | query | いいえ |
レスポンス
例

テナントを更新 
パラメータ
| 名前 | 型 | 配置 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: FlagCommentPublic200Response
例

画像をアップロード 
画像をアップロードしてリサイズする
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| sizePreset | string | query | いいえ | サイズプリセット: "Default" (1000x1000px) または "CrossPlatform" (一般的なデバイス向けのサイズを作成します) |
| urlId | string | query | いいえ | アップロード元のページID(設定用) |
レスポンス
戻り値: UploadImageResponse
例

IDでユーザーバッジ進捗を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
返却値: GetUserBadgeProgressById200Response
例

ユーザーIDでユーザーバッジ進捗を取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | path | はい |
レスポンス
戻り値: GetUserBadgeProgressById200Response
例

ユーザーバッジ進捗一覧を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
レスポンス
戻り値: GetUserBadgeProgressList200Response
例

ユーザーバッジを作成 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes |
レスポンス
戻り値: CreateUserBadge200Response
例

ユーザーバッジを削除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: UpdateUserBadge200Response
例

ユーザーバッジを取得 
パラメータ
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
例

ユーザーバッジ一覧を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | いいえ | |
| badgeId | string | query | いいえ | |
| type | number | query | いいえ | |
| displayedOnComments | boolean | query | いいえ | |
| limit | number | query | いいえ | |
| skip | number | query | いいえ |
戻り値
Returns: GetUserBadges200Response
例

ユーザーバッジを更新 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: UpdateUserBadge200Response
例

ユーザーの通知数を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
返却値: GetUserNotificationCount200Response
例

ユーザーの通知一覧を取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| pageSize | integer | query | いいえ | |
| afterId | string | query | いいえ | |
| includeContext | boolean | query | いいえ | |
| afterCreatedAt | integer | query | いいえ | |
| unreadOnly | boolean | query | いいえ | |
| dmOnly | boolean | query | いいえ | |
| noDm | boolean | query | いいえ | |
| includeTranslations | boolean | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: GetUserNotifications200Response
例

ユーザーの通知数をリセット 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
返却: ResetUserNotifications200Response
例

ユーザーの通知をリセット 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| afterId | string | query | いいえ | |
| afterCreatedAt | integer | query | いいえ | |
| unreadOnly | boolean | query | いいえ | |
| dmOnly | boolean | query | いいえ | |
| noDm | boolean | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: ResetUserNotifications200Response
例

ユーザーのコメント通知購読ステータスを更新 
特定のコメントに対する通知を有効または無効にします。
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| notificationId | string | path | はい | |
| optedInOrOut | string | path | はい | |
| commentId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: UpdateUserNotificationStatus200Response
例

ユーザーのページ通知購読ステータスを更新 
ページの通知を有効または無効にします。ユーザーがページを購読している場合、新しいルートコメントに対して通知が作成され、また
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlId | string | query | はい | |
| url | string | query | はい | |
| pageTitle | string | query | はい | |
| subscribedOrUnsubscribed | string | path | はい | |
| sso | string | query | いいえ |
レスポンス
返却: UpdateUserNotificationStatus200Response
例

ユーザー通知のステータスを更新 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| notificationId | string | path | はい | |
| newStatus | string | path | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: UpdateUserNotificationStatus200Response
例

ユーザーのプレゼンスステータスを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlIdWS | string | query | はい | |
| userIds | string | query | はい |
レスポンス
返却: GetUserPresenceStatuses200Response
例

ユーザーを検索 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| usernameStartsWith | string | query | はい | |
| mentionGroupIds | array | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
例

ユーザーを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: GetUser200Response
例

投票を作成 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | query | はい | |
| direction | string | query | はい | |
| userId | string | query | いいえ | |
| anonUserId | string | query | いいえ |
レスポンス
例

投票を削除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| editKey | string | query | いいえ |
レスポンス
返却: DeleteCommentVote200Response
例

投票一覧を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlId | string | query | はい |
レスポンス
戻り値: GetVotes200Response
例

ユーザーの投票を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlId | string | query | はい | |
| userId | string | query | いいえ | |
| anonUserId | string | query | いいえ |
レスポンス
戻り値: GetVotesForUser200Response
例

ヘルプが必要ですか?
Swift SDK に関して問題が発生した場合や質問がある場合は、次のいずれかを行ってください:
貢献
貢献を歓迎します!貢献ガイドラインはGitHubリポジトリをご覧ください。