FastComments Dart SDK

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

Dart および Flutter アプリケーションからコメント、ユーザー、SSO、モデレーションを管理します。

リポジトリ

AI コーディングエージェント

コーディングエージェントに FastComments のコンテキスト（ウィジェット、設定、Secure SSO、REST API、SDK）を提供します:

npx skills add fastcomments/skills

Claude Code、Codex、Cursor、Copilot、Gemini、そして他のすべてのエージェントで、skills CLI がサポートされています。

レイアウト

fastcomments-dart/
  client/        生成された dart クライアント (手で編集しないでください)
  sso/           手書きの SSO トークンヘルパー
  openapi.json   生成に使用された仕様のコミットされたコピー
  config.json    openapi-generator 設定
  update.py      仕様からクライアントを再生成する

使用

dependencies:
  fastcomments_dart: ^3.0.0

SSOヘルパーはパッケージ（package:fastcomments_dart/sso/...）に含まれています。

クライアントは3つのAPIクラスを公開します:

DefaultApi - サーバーサイドでの使用を想定した、APIキーで認証されたメソッド。
PublicApi - APIキーが不要な公開メソッドで、ブラウザやモバイルクライアントでも安全に使用できます。
ModerationApi - 大規模なライブ・高速モデレーションAPIのスイートです。すべてのModerationApiメソッドはssoパラメータを取り、SSOまたはFastComments.comのセッションクッキーで認証できます。

import 'package:fastcomments_dart/api.dart';

final api = PublicApi(ApiClient(basePath: 'https://fastcomments.com'));
final comments = await api.getCommentsPublic('YOUR_TENANT_ID', 'YOUR_URL_ID');

import 'package:fastcomments_dart/api.dart';

final publicApi = PublicApi(ApiClient(basePath: 'https://fastcomments.com'));
final feedPosts = await publicApi.getFeedPostsPublic('YOUR_TENANT_ID');

import 'package:fastcomments_dart/api.dart';

final moderation = ModerationApi(ApiClient(basePath: 'https://fastcomments.com'));
final result = await moderation.getApiComments(
  GetApiCommentsOptions(sso: 'SSO_TOKEN'),
);

SSO

import 'package:fastcomments_dart/sso/fastcomments_sso.dart';
import 'package:fastcomments_dart/sso/secure_sso_user_data.dart';

final sso = FastCommentsSSO.secure(
  apiKey: 'YOUR_API_SECRET',
  user: SecureSSOUserData(
    id: 'user-123',
    email: 'jane@example.com',
    username: 'jane',
    avatar: 'https://example.com/jane.png',
  ),
);
final token = sso.prepareToSend();

集計

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

Parameters

Name	Type	Location	Required
tenantId	string	query	Yes
parentTenantId	string	query	No
includeStats	boolean	query	No

Response

返却: AggregateResponse

Example

集計例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final aggregationRequest = AggregationRequest(); // AggregationRequest | 
final parentTenantId = parentTenantId_example; // String | 
final includeStats = true; // bool | 
try {
    final result = api_instance.aggregate(tenantId, aggregationRequest, AggregateOptions(parentTenantId: parentTenantId, includeStats: includeStats));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->aggregate: $e\n');
}

監査ログ取得

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
limit	number	query	いいえ
skip	number	query	いいえ
order	string	query	いいえ
after	number	query	いいえ
before	number	query	いいえ

レスポンス

Returns: GetAuditLogsResponse

例

getAuditLogs の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて API キーのプレフィックス (例: Bearer) を設定するには、以下のコメントを外してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final limit = 1.2; // double | 
final skip = 1.2; // double | 
final order = ; // SORTDIR | 
final after = 1.2; // double | 
final before = 1.2; // double | 
try {
    final result = api_instance.getAuditLogs(tenantId, GetAuditLogsOptions(limit: limit, skip: skip, order: order, after: after, before: before));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAuditLogs: $e\n');
}

公開ログアウト

レスポンス

返却: APIEmptyResponse

例

logoutPublic の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
try {
    final result = api_instance.logoutPublic();
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->logoutPublic: $e\n');
}

コメントからブロック（公開）

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

応答

戻り値: BlockSuccess

例

blockFromCommentPublic 例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final publicBlockFromCommentParams = PublicBlockFromCommentParams(); // PublicBlockFromCommentParams | 
final sso = sso_example; // String | 
try {
    final result = api_instance.blockFromCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->blockFromCommentPublic: $e\n');
}

コメントブロック解除（公開）

パラメータ

名前	種類	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

レスポンス

戻り値: UnblockSuccess

例

unBlockCommentPublic の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final publicBlockFromCommentParams = PublicBlockFromCommentParams(); // PublicBlockFromCommentParams | 
final sso = sso_example; // String | 
try {
    final result = api_instance.unBlockCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->unBlockCommentPublic: $e\n');
}

ブロックされたコメントの確認

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
commentIds	string	query	はい	コメントIDのカンマ区切りリスト
sso	string	query	いいえ

応答

戻り値: CheckBlockedCommentsResponse

例

checkedCommentsForBlocked の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final commentIds = commentIds_example; // String | コメントIDのカンマ区切りリスト
final sso = sso_example; // String | 
try {
    final result = api_instance.checkedCommentsForBlocked(tenantId, commentIds, sso);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->checkedCommentsForBlocked: $e\n');
}

コメントからユーザーをブロック

パラメータ

名前	型	ロケーション	必須
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No
anonUserId	string	query	No

レスポンス

Returns: BlockSuccess

例

blockUserFromComment 例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントアウトを解除して、APIキーのプレフィックス（例: Bearer）を設定します（必要な場合）
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final blockFromCommentParams = BlockFromCommentParams(); // BlockFromCommentParams | 
final userId = userId_example; // String | 
final anonUserId = anonUserId_example; // String | 
try {
    final result = api_instance.blockUserFromComment(tenantId, id, blockFromCommentParams, BlockUserFromCommentOptions(userId: userId, anonUserId: anonUserId));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->blockUserFromComment: $e\n');
}

コメント作成（公開）

パラメータ

名前	型	場所	必須
tenantId	string	path	はい
urlId	string	query	はい
broadcastId	string	query	はい
sessionId	string	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: SaveCommentsResponseWithPresence

例

createCommentPublic の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final urlId = urlId_example; // String | 
final broadcastId = broadcastId_example; // String | 
final commentData = CommentData(); // CommentData | 
final sessionId = sessionId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.createCommentPublic(tenantId, urlId, broadcastId, commentData, CreateCommentPublicOptions(sessionId: sessionId, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->createCommentPublic: $e\n');
}

コメント削除

パラメータ

名前	型	場所	必須
tenantId	string	クエリ	はい
id	string	パス	はい
contextUserId	string	クエリ	いいえ
isLive	boolean	クエリ	いいえ

レスポンス

戻り値: DeleteCommentResult

例

deleteComment の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 下記のコメントアウトを解除して、必要に応じて API キーのプレフィックス (例: Bearer) を設定
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final contextUserId = contextUserId_example; // String | 
final isLive = true; // bool | 
try {
    final result = api_instance.deleteComment(tenantId, id, DeleteCommentOptions(contextUserId: contextUserId, isLive: isLive));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteComment: $e\n');
}

コメント削除（公開）

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
editKey	string	query	No
sso	string	query	No

応答

Returns: PublicAPIDeleteCommentResponse

例

deleteCommentPublic の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final broadcastId = broadcastId_example; // String | 
final editKey = editKey_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.deleteCommentPublic(tenantId, commentId, broadcastId, DeleteCommentPublicOptions(editKey: editKey, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->deleteCommentPublic: $e\n');
}

コメント投票削除

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
commentId	string	path	Yes
voteId	string	path	Yes
urlId	string	query	Yes
broadcastId	string	query	Yes
editKey	string	query	No
sso	string	query	No

レスポンス

返却: VoteDeleteResponse

例

deleteCommentVote の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final voteId = voteId_example; // String | 
final urlId = urlId_example; // String | 
final broadcastId = broadcastId_example; // String | 
final editKey = editKey_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.deleteCommentVote(tenantId, commentId, voteId, urlId, broadcastId, DeleteCommentVoteOptions(editKey: editKey, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->deleteCommentVote: $e\n');
}

コメントフラグ設定

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No
anonUserId	string	query	No

レスポンス

返却: FlagCommentResponse

例

flagComment の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントアウトを解除して、必要に応じてAPIキーのプレフィックス（例: Bearer）を設定
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final userId = userId_example; // String | 
final anonUserId = anonUserId_example; // String | 
try {
    final result = api_instance.flagComment(tenantId, id, FlagCommentOptions(userId: userId, anonUserId: anonUserId));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->flagComment: $e\n');
}

コメント取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIGetCommentResponse

例

getComment 例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定する: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するためのコメントアウトを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.getComment(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getComment: $e\n');
}

コメント一覧取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
page	integer	query	No
limit	integer	query	No
skip	integer	query	No
asTree	boolean	query	No
skipChildren	integer	query	No
limitChildren	integer	query	No
maxTreeDepth	integer	query	No
urlId	string	query	No
userId	string	query	No
anonUserId	string	query	No
contextUserId	string	query	No
hashTag	string	query	No
parentId	string	query	No
direction	string	query	No
fromDate	integer	query	No
toDate	integer	query	No

応答

戻り値: APIGetCommentsResponse

例

getComments の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を構成してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final page = 56; // int | 
final limit = 56; // int | 
final skip = 56; // int | 
final asTree = true; // bool | 
final skipChildren = 56; // int | 
final limitChildren = 56; // int | 
final maxTreeDepth = 56; // int | 
final urlId = urlId_example; // String | 
final userId = userId_example; // String | 
final anonUserId = anonUserId_example; // String | 
final contextUserId = contextUserId_example; // String | 
final hashTag = hashTag_example; // String | 
final parentId = parentId_example; // String | 
final direction = ; // SortDirections | 
final fromDate = 789; // int | 
final toDate = 789; // int | 
try {
    final result = api_instance.getComments(tenantId, 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));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getComments: $e\n');
}

コメント一覧取得（公開）

req tenantId urlId

パラメーター

名前	型	場所	必須
tenantId	string	path	Yes
urlId	string	query	Yes
page	integer	query	No
direction	string	query	No
sso	string	query	No
skip	integer	query	No
skipChildren	integer	query	No
limit	integer	query	No
limitChildren	integer	query	No
countChildren	boolean	query	No
fetchPageForCommentId	string	query	No
includeConfig	boolean	query	No
countAll	boolean	query	No
includei10n	boolean	query	No
locale	string	query	No
modules	string	query	No
isCrawler	boolean	query	No
includeNotificationCount	boolean	query	No
asTree	boolean	query	No
maxTreeDepth	integer	query	No
useFullTranslationIds	boolean	query	No
parentId	string	query	No
searchText	string	query	No
hashTags	array	query	No
userId	string	query	No
customConfigStr	string	query	No
afterCommentId	string	query	No
beforeCommentId	string	query	No

レスポンス

返却: GetCommentsResponseWithPresencePublicComment

例

getCommentsPublic の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final urlId = urlId_example; // String | 
final page = 56; // int | 
final direction = ; // SortDirections | 
final sso = sso_example; // String | 
final skip = 56; // int | 
final skipChildren = 56; // int | 
final limit = 56; // int | 
final limitChildren = 56; // int | 
final countChildren = true; // bool | 
final fetchPageForCommentId = fetchPageForCommentId_example; // String | 
final includeConfig = true; // bool | 
final countAll = true; // bool | 
final includei10n = true; // bool | 
final locale = locale_example; // String | 
final modules = modules_example; // String | 
final isCrawler = true; // bool | 
final includeNotificationCount = true; // bool | 
final asTree = true; // bool | 
final maxTreeDepth = 56; // int | 
final useFullTranslationIds = true; // bool | 
final parentId = parentId_example; // String | 
final searchText = searchText_example; // String | 
final hashTags = []; // List<String> | 
final userId = userId_example; // String | 
final customConfigStr = customConfigStr_example; // String | 
final afterCommentId = afterCommentId_example; // String | 
final beforeCommentId = beforeCommentId_example; // String | 
try {
    final result = api_instance.getCommentsPublic(tenantId, urlId, 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));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getCommentsPublic: $e\n');
}

コメントテキスト取得

パラメータ

名前	型	場所	必須
tenantId	string	path	はい
commentId	string	path	はい
editKey	string	query	いいえ
sso	string	query	いいえ

応答

返却: PublicAPIGetCommentTextResponse

例

getCommentText の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final editKey = editKey_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getCommentText(tenantId, commentId, GetCommentTextOptions(editKey: editKey, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getCommentText: $e\n');
}

コメント投票ユーザー名取得

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
commentId	string	path	Yes
dir	integer	query	Yes
sso	string	query	No

レスポンス

Returns: GetCommentVoteUserNamesSuccessResponse

例

getCommentVoteUserNames の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final dir = 56; // int | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getCommentVoteUserNames(tenantId, commentId, dir, sso);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getCommentVoteUserNames: $e\n');
}

コメントロック

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
sso	string	query	No

応答

返り値: APIEmptyResponse

例

lockComment の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final broadcastId = broadcastId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.lockComment(tenantId, commentId, broadcastId, sso);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->lockComment: $e\n');
}

コメントピン留め

パラメータ

名前	型	場所	必須
tenantId	string	path	はい
commentId	string	path	はい
broadcastId	string	query	はい
sso	string	query	いいえ

レスポンス

返り値: ChangeCommentPinStatusResponse

例

pinComment の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final broadcastId = broadcastId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.pinComment(tenantId, commentId, broadcastId, sso);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->pinComment: $e\n');
}

コメント保存

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
isLive	boolean	query	いいえ
doSpamCheck	boolean	query	いいえ
sendEmails	boolean	query	いいえ
populateNotifications	boolean	query	いいえ

レスポンス

返却: APISaveCommentResponse

例

saveComment の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createCommentParams = CreateCommentParams(); // CreateCommentParams | 
final isLive = true; // bool | 
final doSpamCheck = true; // bool | 
final sendEmails = true; // bool | 
final populateNotifications = true; // bool | 
try {
    final result = api_instance.saveComment(tenantId, createCommentParams, SaveCommentOptions(isLive: isLive, doSpamCheck: doSpamCheck, sendEmails: sendEmails, populateNotifications: populateNotifications));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->saveComment: $e\n');
}

コメント一括保存

パラメータ

名称	種類	場所	必須
tenantId	string	query	Yes
isLive	boolean	query	No
doSpamCheck	boolean	query	No
sendEmails	boolean	query	No
populateNotifications	boolean	query	No

レスポンス

戻り値: SaveCommentsBulkResponse

例

saveCommentsBulk の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じてAPIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createCommentParams = [List<CreateCommentParams>()]; // List<CreateCommentParams> | 
final isLive = true; // bool | 
final doSpamCheck = true; // bool | 
final sendEmails = true; // bool | 
final populateNotifications = true; // bool | 
try {
    final result = api_instance.saveCommentsBulk(tenantId, createCommentParams, SaveCommentsBulkOptions(isLive: isLive, doSpamCheck: doSpamCheck, sendEmails: sendEmails, populateNotifications: populateNotifications));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->saveCommentsBulk: $e\n');
}

コメントテキスト設定

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
editKey	string	query	No
sso	string	query	No

応答

返却: PublicAPISetCommentTextResponse

例

setCommentText の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final broadcastId = broadcastId_example; // String | 
final commentTextUpdateRequest = CommentTextUpdateRequest(); // CommentTextUpdateRequest | 
final editKey = editKey_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.setCommentText(tenantId, commentId, broadcastId, commentTextUpdateRequest, SetCommentTextOptions(editKey: editKey, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->setCommentText: $e\n');
}

コメントからユーザーのブロック解除

Parameters

名前	型	場所	必須
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No
anonUserId	string	query	No

Response

戻り値: UnblockSuccess

Example

unBlockUserFromComment の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// アンコメントすると、必要に応じてAPIキーのプレフィックス（例: Bearer）を設定できます
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final unBlockFromCommentParams = UnBlockFromCommentParams(); // UnBlockFromCommentParams | 
final userId = userId_example; // String | 
final anonUserId = anonUserId_example; // String | 
try {
    final result = api_instance.unBlockUserFromComment(tenantId, id, unBlockFromCommentParams, UnBlockUserFromCommentOptions(userId: userId, anonUserId: anonUserId));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->unBlockUserFromComment: $e\n');
}

コメントフラグ解除

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No
anonUserId	string	query	No

レスポンス

戻り値: FlagCommentResponse

例

unFlagComment の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final userId = userId_example; // String | 
final anonUserId = anonUserId_example; // String | 
try {
    final result = api_instance.unFlagComment(tenantId, id, UnFlagCommentOptions(userId: userId, anonUserId: anonUserId));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->unFlagComment: $e\n');
}

コメントロック解除

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
sso	string	query	No

応答

戻り値: APIEmptyResponse

例

unLockComment の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final broadcastId = broadcastId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.unLockComment(tenantId, commentId, broadcastId, sso);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->unLockComment: $e\n');
}

コメントピン留め解除

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
sso	string	query	No

レスポンス

戻り値: ChangeCommentPinStatusResponse

例

unPinComment の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final broadcastId = broadcastId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.unPinComment(tenantId, commentId, broadcastId, sso);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->unPinComment: $e\n');
}

コメント更新

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
contextUserId	string	query	いいえ
doSpamCheck	boolean	query	いいえ
isLive	boolean	query	いいえ

レスポンス

返却: APIEmptyResponse

例

updateComment 例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updatableCommentParams = UpdatableCommentParams(); // UpdatableCommentParams | 
final contextUserId = contextUserId_example; // String | 
final doSpamCheck = true; // bool | 
final isLive = true; // bool | 
try {
    final result = api_instance.updateComment(tenantId, id, updatableCommentParams, UpdateCommentOptions(contextUserId: contextUserId, doSpamCheck: doSpamCheck, isLive: isLive));
    print(result);
} catch (e) {
    print('DefaultApi->updateComment 呼び出し時の例外: $e\n');
}

コメント投票

パラメータ

名前	タイプ	場所	必須
tenantId	string	path	Yes
commentId	string	path	Yes
urlId	string	query	Yes
broadcastId	string	query	Yes
sessionId	string	query	No
sso	string	query	No

応答

返却: VoteResponse

例

voteComment の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final urlId = urlId_example; // String | 
final broadcastId = broadcastId_example; // String | 
final voteBodyParams = VoteBodyParams(); // VoteBodyParams | 
final sessionId = sessionId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.voteComment(tenantId, commentId, urlId, broadcastId, voteBodyParams, VoteCommentOptions(sessionId: sessionId, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->voteComment: $e\n');
}

ユーザーのコメント取得

パラメータ

名前	タイプ	場所	必須
userId	string	query	No
direction	string	query	No
repliesToUserId	string	query	No
page	number	query	No
includei10n	boolean	query	No
locale	string	query	No
isCrawler	boolean	query	No

レスポンス

返却: GetCommentsForUserResponse

例

getCommentsForUser の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final userId = userId_example; // String | 
final direction = ; // SortDirections | 
final repliesToUserId = repliesToUserId_example; // String | 
final page = 1.2; // double | 
final includei10n = true; // bool | 
final locale = locale_example; // String | 
final isCrawler = true; // bool | 
try {
    final result = api_instance.getCommentsForUser(GetCommentsForUserOptions(userId: userId, direction: direction, repliesToUserId: repliesToUserId, page: page, includei10n: includei10n, locale: locale, isCrawler: isCrawler));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getCommentsForUser: $e\n');
}

ドメイン設定追加

パラメータ

名前	タイプ	ロケーション	必須	説明
tenantId	string	query	はい

応答

返り値: AddDomainConfigResponse

例

addDomainConfig の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントアウトを解除して、APIキーのプレフィックス (例: Bearer) を設定してください（必要な場合）
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final addDomainConfigParams = AddDomainConfigParams(); // AddDomainConfigParams | 
try {
    final result = api_instance.addDomainConfig(tenantId, addDomainConfigParams);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addDomainConfig: $e\n');
}

ドメイン設定削除

パラメータ

名前	型	場所	必須	説明
tenantId	string	クエリ	はい
domain	string	パス	はい

レスポンス

戻り値: DeleteDomainConfigResponse

例

deleteDomainConfig の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 下記のコメントを解除して、APIキーのプレフィックス（例: Bearer）を設定してください（必要な場合）
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final domain = domain_example; // String | 
try {
    final result = api_instance.deleteDomainConfig(tenantId, domain);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteDomainConfig: $e\n');
}

ドメイン設定取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
domain	string	path	Yes

レスポンス

返却: GetDomainConfigResponse

例

getDomainConfig の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final domain = domain_example; // String | 
try {
    final result = api_instance.getDomainConfig(tenantId, domain);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getDomainConfig: $e\n');
}

ドメイン設定一覧取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes

レスポンス

戻り値: GetDomainConfigsResponse

例

getDomainConfigs の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定する: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// コメント解除して以下を設定し、APIキーのプレフィックス（例: Bearer）を設定します（必要な場合）
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
try {
    final result = api_instance.getDomainConfigs(tenantId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getDomainConfigs: $e\n');
}

ドメイン設定パッチ

パラメータ

名前	タイプ	場所	必須	説明
tenantId	string	query	はい
domainToUpdate	string	path	はい

レスポンス

返却: PatchDomainConfigResponse

例

patchDomainConfig 例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例：Bearer）を設定するために以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final domainToUpdate = domainToUpdate_example; // String | 
final patchDomainConfigParams = PatchDomainConfigParams(); // PatchDomainConfigParams | 
try {
    final result = api_instance.patchDomainConfig(tenantId, domainToUpdate, patchDomainConfigParams);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->patchDomainConfig: $e\n');
}

ドメイン設定置換

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
domainToUpdate	string	path	はい

応答

戻り値: PutDomainConfigResponse

例

putDomainConfig の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final domainToUpdate = domainToUpdate_example; // String | 
final updateDomainConfigParams = UpdateDomainConfigParams(); // UpdateDomainConfigParams | 
try {
    final result = api_instance.putDomainConfig(tenantId, domainToUpdate, updateDomainConfigParams);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->putDomainConfig: $e\n');
}

メールテンプレート作成

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes

レスポンス

Returns: CreateEmailTemplateResponse

例

createEmailTemplate の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントアウトを解除して、APIキーのプレフィックス（例: Bearer）を設定（必要な場合）
 //defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createEmailTemplateBody = CreateEmailTemplateBody(); // CreateEmailTemplateBody | 
try {
    final result = api_instance.createEmailTemplate(tenantId, createEmailTemplateBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createEmailTemplate: $e\n');
}

メールテンプレート削除

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
id	string	path	Yes

レスポンス

戻り値: APIEmptyResponse

例

deleteEmailTemplate の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例：Bearer）を設定するには、以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.deleteEmailTemplate(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteEmailTemplate: $e\n');
}

メールテンプレートレンダリングエラー削除

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
errorId	string	path	はい

応答

返却: APIEmptyResponse

例

deleteEmailTemplateRenderError 例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じてAPIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final errorId = errorId_example; // String | 
try {
    final result = api_instance.deleteEmailTemplateRenderError(tenantId, id, errorId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteEmailTemplateRenderError: $e\n');
}

メールテンプレート取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: GetEmailTemplateResponse

例

getEmailTemplate の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO: APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するために以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.getEmailTemplate(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getEmailTemplate: $e\n');
}

メールテンプレート定義取得

パラメータ

名前	タイプ	場所	必須	説明
tenantId	string	query	はい

レスポンス

戻り値: GetEmailTemplateDefinitionsResponse

例

getEmailTemplateDefinitions の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証の設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
try {
    final result = api_instance.getEmailTemplateDefinitions(tenantId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getEmailTemplateDefinitions: $e\n');
}

メールテンプレートレンダリングエラー取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
id	string	path	Yes
skip	number	query	No

レスポンス

戻り値: GetEmailTemplateRenderErrorsResponse

例

getEmailTemplateRenderErrors の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、以下のコメントを解除して API キーのプレフィックス（例: Bearer）を設定してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final skip = 1.2; // double | 
try {
    final result = api_instance.getEmailTemplateRenderErrors(tenantId, id, skip);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getEmailTemplateRenderErrors: $e\n');
}

メールテンプレート一覧取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
skip	number	query	いいえ

レスポンス

返却: GetEmailTemplatesResponse

例

getEmailTemplates の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス (例: Bearer) を設定するには、以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final skip = 1.2; // double | 
try {
    final result = api_instance.getEmailTemplates(tenantId, skip);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getEmailTemplates: $e\n');
}

メールテンプレートレンダリング

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
locale	string	query	No

レスポンス

返却: RenderEmailTemplateResponse

例

renderEmailTemplate の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントアウトを解除して、APIキーのプレフィックス（例: Bearer）を設定します
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final renderEmailTemplateBody = RenderEmailTemplateBody(); // RenderEmailTemplateBody | 
final locale = locale_example; // String | 
try {
    final result = api_instance.renderEmailTemplate(tenantId, renderEmailTemplateBody, locale);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->renderEmailTemplate: $e\n');
}

メールテンプレート更新

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

応答

返却: APIEmptyResponse

例

updateEmailTemplate 例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateEmailTemplateBody = UpdateEmailTemplateBody(); // UpdateEmailTemplateBody | 
try {
    final result = api_instance.updateEmailTemplate(tenantId, id, updateEmailTemplateBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateEmailTemplate: $e\n');
}

イベントログ取得

req
tenantId
urlId
userIdWS

パラメータ

名前	型	場所	必須
tenantId	string	path	はい
urlId	string	query	はい
userIdWS	string	query	はい
startTime	integer	query	はい
endTime	integer	query	いいえ

レスポンス

返却: GetEventLogResponse

例

getEventLog の例

Copy

  
import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final urlId = urlId_example; // String | 
final userIdWS = userIdWS_example; // String | 
final startTime = 789; // int | 
final endTime = 789; // int | 
try {
    final result = api_instance.getEventLog(tenantId, urlId, userIdWS, startTime, endTime);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getEventLog: $e\n');
}

全体イベントログ取得

req
tenantId
urlId
userIdWS

パラメータ

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

応答

戻り値: GetEventLogResponse

例

getGlobalEventLog の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final urlId = urlId_example; // String | 
final userIdWS = userIdWS_example; // String | 
final startTime = 789; // int | 
final endTime = 789; // int | 
try {
    final result = api_instance.getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getGlobalEventLog: $e\n');
}

フィード投稿作成

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
broadcastId	string	query	No
isLive	boolean	query	No
doSpamCheck	boolean	query	No
skipDupCheck	boolean	query	No

応答

戻り値: CreateFeedPostsResponse

例

createFeedPost の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createFeedPostParams = CreateFeedPostParams(); // CreateFeedPostParams | 
final broadcastId = broadcastId_example; // String | 
final isLive = true; // bool | 
final doSpamCheck = true; // bool | 
final skipDupCheck = true; // bool | 
try {
    final result = api_instance.createFeedPost(tenantId, createFeedPostParams, CreateFeedPostOptions(broadcastId: broadcastId, isLive: isLive, doSpamCheck: doSpamCheck, skipDupCheck: skipDupCheck));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createFeedPost: $e\n');
}

フィード投稿作成（公開）

パラメータ

名前	タイプ	場所	必須
tenantId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

レスポンス

戻り値: CreateFeedPostResponse

例

createFeedPostPublic の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // 文字列 | 
final createFeedPostParams = CreateFeedPostParams(); // CreateFeedPostParams | 
final broadcastId = broadcastId_example; // 文字列 | 
final sso = sso_example; // 文字列 | 
try {
    final result = api_instance.createFeedPostPublic(tenantId, createFeedPostParams, CreateFeedPostPublicOptions(broadcastId: broadcastId, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->createFeedPostPublic: $e\n');
}

フィード投稿削除（公開）

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
postId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

応答

戻り値: DeleteFeedPostPublicResponse

例

deleteFeedPostPublic 例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final postId = postId_example; // String | 
final broadcastId = broadcastId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.deleteFeedPostPublic(tenantId, postId, DeleteFeedPostPublicOptions(broadcastId: broadcastId, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->deleteFeedPostPublic: $e\n');
}

フィード投稿取得

リクエスト tenantId afterId

パラメータ

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

レスポンス

戻り値: GetFeedPostsResponse

例

getFeedPosts の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final afterId = afterId_example; // String | 
final limit = 56; // int | 
final tags = []; // List<String> | 
try {
    final result = api_instance.getFeedPosts(tenantId, GetFeedPostsOptions(afterId: afterId, limit: limit, tags: tags));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFeedPosts: $e\n');
}

フィード投稿取得（公開）

req tenantId afterId

パラメータ

名前	型	場所	必須
tenantId	string	path	はい
afterId	string	query	いいえ
limit	integer	query	いいえ
tags	array	query	いいえ
sso	string	query	いいえ
isCrawler	boolean	query	いいえ
includeUserInfo	boolean	query	いいえ

レスポンス

Returns: PublicFeedPostsResponse

例

getFeedPostsPublic の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final afterId = afterId_example; // String | 
final limit = 56; // int | 
final tags = []; // List<String> | 
final sso = sso_example; // String | 
final isCrawler = true; // bool | 
final includeUserInfo = true; // bool | 
try {
    final result = api_instance.getFeedPostsPublic(tenantId, GetFeedPostsPublicOptions(afterId: afterId, limit: limit, tags: tags, sso: sso, isCrawler: isCrawler, includeUserInfo: includeUserInfo));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getFeedPostsPublic: $e\n');
}

フィード投稿統計取得

Parameters

名前	型	場所	必須
tenantId	string	path	はい
postIds	array	query	はい
sso	string	query	いいえ

Response

戻り値: FeedPostsStatsResponse

例

getFeedPostsStats の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final postIds = []; // List<String> | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getFeedPostsStats(tenantId, postIds, sso);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getFeedPostsStats: $e\n');
}

ユーザーリアクション取得（公開）

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
postIds	array	query	No
sso	string	query	No

レスポンス

戻り値: UserReactsResponse

例

getUserReactsPublic の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final postIds = []; // List<String> | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getUserReactsPublic(tenantId, GetUserReactsPublicOptions(postIds: postIds, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getUserReactsPublic: $e\n');
}

フィード投稿リアクション（公開）

パラメータ

名前	タイプ	場所	必須
tenantId	string	path	Yes
postId	string	path	Yes
isUndo	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

レスポンス

Returns: ReactFeedPostResponse

例

reactFeedPostPublic の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final postId = postId_example; // String | 
final reactBodyParams = ReactBodyParams(); // ReactBodyParams | 
final isUndo = true; // bool | 
final broadcastId = broadcastId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.reactFeedPostPublic(tenantId, postId, reactBodyParams, ReactFeedPostPublicOptions(isUndo: isUndo, broadcastId: broadcastId, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->reactFeedPostPublic: $e\n');
}

フィード投稿更新

Parameters

名前	型	場所	必要	説明
tenantId	string	query	はい
id	string	path	はい

Response

戻り値: APIEmptyResponse

Example

updateFeedPost 例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを外してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final feedPost = FeedPost(); // FeedPost | 
try {
    final result = api_instance.updateFeedPost(tenantId, id, feedPost);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateFeedPost: $e\n');
}

フィード投稿更新（公開）

Parameters

名前	型	場所	必須
tenantId	string	パス	はい
postId	string	パス	はい
broadcastId	string	クエリ	いいえ
sso	string	クエリ	いいえ

Response

戻り値: CreateFeedPostResponse

Example

updateFeedPostPublic の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final postId = postId_example; // String | 
final updateFeedPostParams = UpdateFeedPostParams(); // UpdateFeedPostParams | 
final broadcastId = broadcastId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.updateFeedPostPublic(tenantId, postId, updateFeedPostParams, UpdateFeedPostPublicOptions(broadcastId: broadcastId, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->updateFeedPostPublic: $e\n');
}

コメントフラグ設定（公開）

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
isFlagged	boolean	query	はい
sso	string	query	いいえ

レスポンス

戻り値: APIEmptyResponse

例

flagCommentPublic 例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final isFlagged = true; // bool | 
final sso = sso_example; // String | 
try {
    final result = api_instance.flagCommentPublic(tenantId, commentId, isFlagged, sso);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->flagCommentPublic: $e\n');
}

大きいGIF取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	path	はい
largeInternalURLSanitized	string	query	はい

応答

返却: GifGetLargeResponse

例

getGifLarge の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final largeInternalURLSanitized = largeInternalURLSanitized_example; // String | 
try {
    final result = api_instance.getGifLarge(tenantId, largeInternalURLSanitized);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getGifLarge: $e\n');
}

GIF検索取得

パラメータ

名前	型	場所	必須
tenantId	string	パス	はい
search	string	クエリ	はい
locale	string	クエリ	いいえ
rating	string	クエリ	いいえ
page	number	クエリ	いいえ

レスポンス

戻り値: GetGifsSearchResponse

例

getGifsSearch の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final search = search_example; // String | 
final locale = locale_example; // String | 
final rating = rating_example; // String | 
final page = 1.2; // double | 
try {
    final result = api_instance.getGifsSearch(tenantId, search, GetGifsSearchOptions(locale: locale, rating: rating, page: page));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getGifsSearch: $e\n');
}

トレンドGIF取得

パラメータ

名前	タイプ	ロケーション	必須
tenantId	string	path	Yes
locale	string	query	No
rating	string	query	No
page	number	query	No

レスポンス

戻り値: GetGifsTrendingResponse

例

getGifsTrending の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final locale = locale_example; // String | 
final rating = rating_example; // String | 
final page = 1.2; // double | 
try {
    final result = api_instance.getGifsTrending(tenantId, GetGifsTrendingOptions(locale: locale, rating: rating, page: page));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getGifsTrending: $e\n');
}

ハッシュタグ追加

パラメータ

名前	タイプ	場所	必須	説明
tenantId	string	query	はい

レスポンス

戻り値: CreateHashTagResponse

例

addHashTag の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントアウトを解除して、APIキーのプレフィックス（例: Bearer）を設定してください（必要な場合）
 //defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createHashTagBody = CreateHashTagBody(); // CreateHashTagBody | 
try {
    final result = api_instance.addHashTag(tenantId, createHashTagBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addHashTag: $e\n');
}

ハッシュタグ一括追加

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい

応答

戻り値: BulkCreateHashTagsResponse

例

addHashTagsBulk 例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントを外してプレフィックスを設定 (例: Bearer) APIキー用、必要な場合
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final bulkCreateHashTagsBody = BulkCreateHashTagsBody(); // BulkCreateHashTagsBody | 
try {
    final result = api_instance.addHashTagsBulk(tenantId, bulkCreateHashTagsBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addHashTagsBulk: $e\n');
}

ハッシュタグ削除

Parameters

名前	型	場所	必須	説明
tenantId	string	query	Yes
tag	string	path	Yes

Response

返却: APIEmptyResponse

例

deleteHashTag の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントを解除して、必要に応じてAPIキーのプレフィックス（例: Bearer）を設定してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final tag = tag_example; // String | 
final deleteHashTagRequestBody = DeleteHashTagRequestBody(); // DeleteHashTagRequestBody | 
try {
    final result = api_instance.deleteHashTag(tenantId, tag, deleteHashTagRequestBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteHashTag: $e\n');
}

ハッシュタグ取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
page	number	query	No

レスポンス

戻り値: GetHashTagsResponse

例

getHashTags の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントアウトを外して、APIキーのプレフィックス（例: Bearer）を設定する場合
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final page = 1.2; // double | 
try {
    final result = api_instance.getHashTags(tenantId, page);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getHashTags: $e\n');
}

ハッシュタグパッチ

Parameters

名前	型	場所	必須	説明
tenantId	string	query	はい
tag	string	path	はい

レスポンス

戻り値: UpdateHashTagResponse

例

patchHashTag 例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、以下のコメントを外してAPIキーのプレフィックス（例: Bearer）を設定してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final tag = tag_example; // String | 
final updateHashTagBody = UpdateHashTagBody(); // UpdateHashTagBody | 
try {
    final result = api_instance.patchHashTag(tenantId, tag, updateHashTagBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->patchHashTag: $e\n');
}

モデレーション投票削除

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
voteId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

応答

戻り値: VoteDeleteResponse

例

deleteModerationVote の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final voteId = voteId_example; // String | 
final broadcastId = broadcastId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.deleteModerationVote(tenantId, commentId, voteId, DeleteModerationVoteOptions(broadcastId: broadcastId, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->deleteModerationVote: $e\n');
}

APIコメント取得

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
page	number	query	No
count	number	query	No
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
sorts	string	query	No
demo	boolean	query	No
sso	string	query	No

レスポンス

戻り値: ModerationAPIGetCommentsResponse

例

getApiComments 例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final page = 1.2; // double | 
final count = 1.2; // double | 
final textSearch = textSearch_example; // String | 
final byIPFromComment = byIPFromComment_example; // String | 
final filters = filters_example; // String | 
final searchFilters = searchFilters_example; // String | 
final sorts = sorts_example; // String | 
final demo = true; // bool | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getApiComments(tenantId, GetApiCommentsOptions(page: page, count: count, textSearch: textSearch, byIPFromComment: byIPFromComment, filters: filters, searchFilters: searchFilters, sorts: sorts, demo: demo, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->getApiComments: $e\n');
}

APIエクスポートステータス取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
batchJobId	string	query	No
sso	string	query	No

応答

返却: ModerationExportStatusResponse

例

getApiExportStatus の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final batchJobId = batchJobId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getApiExportStatus(tenantId, GetApiExportStatusOptions(batchJobId: batchJobId, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->getApiExportStatus: $e\n');
}

API ID取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
afterId	string	query	No
demo	boolean	query	No
sso	string	query	No

レスポンス

戻り値: ModerationAPIGetCommentIdsResponse

例

getApiIds の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final textSearch = textSearch_example; // String | 
final byIPFromComment = byIPFromComment_example; // String | 
final filters = filters_example; // String | 
final searchFilters = searchFilters_example; // String | 
final afterId = afterId_example; // String | 
final demo = true; // bool | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getApiIds(tenantId, GetApiIdsOptions(textSearch: textSearch, byIPFromComment: byIPFromComment, filters: filters, searchFilters: searchFilters, afterId: afterId, demo: demo, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->getApiIds: $e\n');
}

コメントからユーザーのバン取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
sso	string	query	いいえ

レスポンス

戻り値: GetBannedUsersFromCommentResponse

例

getBanUsersFromComment の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getBanUsersFromComment(tenantId, commentId, sso);
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->getBanUsersFromComment: $e\n');
}

コメントバンステータス取得

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

レスポンス

返り値: GetCommentBanStatusResponse

例

getCommentBanStatus の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getCommentBanStatus(tenantId, commentId, sso);
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->getCommentBanStatus: $e\n');
}

コメント子取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
sso	string	query	いいえ

応答

返り値: ModerationAPIChildCommentsResponse

例

getCommentChildren の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getCommentChildren(tenantId, commentId, sso);
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->getCommentChildren: $e\n');
}

カウント取得

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
text-search	string	query	No
byIPFromComment	string	query	No
filter	string	query	No
searchFilters	string	query	No
demo	boolean	query	No
sso	string	query	No

レスポンス

戻り値: ModerationAPICountCommentsResponse

例

getCount の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final textSearch = textSearch_example; // String | 
final byIPFromComment = byIPFromComment_example; // String | 
final filter = filter_example; // String | 
final searchFilters = searchFilters_example; // String | 
final demo = true; // bool | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getCount(tenantId, GetCountOptions(textSearch: textSearch, byIPFromComment: byIPFromComment, filter: filter, searchFilters: searchFilters, demo: demo, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->getCount: $e\n');
}

カウント一覧取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
sso	string	query	いいえ

レスポンス

戻り値: GetBannedUsersCountResponse

例

getCounts の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getCounts(tenantId, sso);
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->getCounts: $e\n');
}

ログ取得

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

レスポンス

Returns: ModerationAPIGetLogsResponse

例

getLogs の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getLogs(tenantId, commentId, sso);
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->getLogs: $e\n');
}

手動バッジ取得

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	Yes
sso	string	query	No

応答

戻り値: GetTenantManualBadgesResponse

例

getManualBadges の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getManualBadges(tenantId, sso);
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->getManualBadges: $e\n');
}

ユーザーの手動バッジ取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
badgesUserId	string	query	No
commentId	string	query	No
sso	string	query	No

レスポンス

返却: GetUserManualBadgesResponse

例

getManualBadgesForUser の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final badgesUserId = badgesUserId_example; // String | 
final commentId = commentId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getManualBadgesForUser(tenantId, GetManualBadgesForUserOptions(badgesUserId: badgesUserId, commentId: commentId, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->getManualBadgesForUser: $e\n');
}

モデレーションコメント取得

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
includeEmail	boolean	query	No
includeIP	boolean	query	No
sso	string	query	No

応答

Returns: ModerationAPICommentResponse

例

getModerationComment の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final includeEmail = true; // bool | 
final includeIP = true; // bool | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getModerationComment(tenantId, commentId, GetModerationCommentOptions(includeEmail: includeEmail, includeIP: includeIP, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->getModerationComment: $e\n');
}

モデレーションコメントテキスト取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
sso	string	query	いいえ

レスポンス

戻り値: GetCommentTextResponse

例

getModerationCommentText の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getModerationCommentText(tenantId, commentId, sso);
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->getModerationCommentText: $e\n');
}

事前バンサマリー取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
includeByUserIdAndEmail	boolean	query	いいえ
includeByIP	boolean	query	いいえ
includeByEmailDomain	boolean	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: PreBanSummary

例

getPreBanSummary の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final includeByUserIdAndEmail = true; // bool | 
final includeByIP = true; // bool | 
final includeByEmailDomain = true; // bool | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getPreBanSummary(tenantId, commentId, GetPreBanSummaryOptions(includeByUserIdAndEmail: includeByUserIdAndEmail, includeByIP: includeByIP, includeByEmailDomain: includeByEmailDomain, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->getPreBanSummary: $e\n');
}

コメント検索サマリー取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
value	string	query	いいえ
filters	string	query	いいえ
searchFilters	string	query	いいえ
sso	string	query	いいえ

応答

戻り値: ModerationCommentSearchResponse

例

getSearchCommentsSummary の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final value = value_example; // String | 
final filters = filters_example; // String | 
final searchFilters = searchFilters_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getSearchCommentsSummary(tenantId, GetSearchCommentsSummaryOptions(value: value, filters: filters, searchFilters: searchFilters, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->getSearchCommentsSummary: $e\n');
}

検索ページ取得

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
value	string	query	いいえ
sso	string	query	いいえ

レスポンス

返り値: ModerationPageSearchResponse

例

getSearchPages の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final value = value_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getSearchPages(tenantId, GetSearchPagesOptions(value: value, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->getSearchPages: $e\n');
}

検索サイト取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
value	string	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: ModerationSiteSearchResponse

例

getSearchSites の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final value = value_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getSearchSites(tenantId, GetSearchSitesOptions(value: value, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->getSearchSites: $e\n');
}

検索サジェスト取得

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	Yes
text-search	string	query	No
sso	string	query	No

応答

戻り値: ModerationSuggestResponse

例

getSearchSuggest の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // 文字列 | 
final textSearch = textSearch_example; // 文字列 | 
final sso = sso_example; // 文字列 | 
try {
    final result = api_instance.getSearchSuggest(tenantId, GetSearchSuggestOptions(textSearch: textSearch, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->getSearchSuggest: $e\n');
}

ユーザー検索取得

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	Yes
value	string	query	No
sso	string	query	No

レスポンス

返却: ModerationUserSearchResponse

例

getSearchUsers 例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final value = value_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getSearchUsers(tenantId, GetSearchUsersOptions(value: value, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->getSearchUsers: $e\n');
}

信頼度取得

Parameters

名前	型	場所	必須
tenantId	string	query	Yes
userId	string	query	No
sso	string	query	No

レスポンス

返却: GetUserTrustFactorResponse

Example

getTrustFactor の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final userId = userId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getTrustFactor(tenantId, GetTrustFactorOptions(userId: userId, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->getTrustFactor: $e\n');
}

ユーザーバン設定取得

パラメータ

名前	タイプ	ロケーション	必須	説明
tenantId	string	query	はい
sso	string	query	いいえ

レスポンス

戻り値: APIModerateGetUserBanPreferencesResponse

例

getUserBanPreference の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getUserBanPreference(tenantId, sso);
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->getUserBanPreference: $e\n');
}

内部プロファイル取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: GetUserInternalProfileResponse

例

getUserInternalProfile の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getUserInternalProfile(tenantId, GetUserInternalProfileOptions(commentId: commentId, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->getUserInternalProfile: $e\n');
}

コメント投票調整

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

レスポンス

戻り値: AdjustVotesResponse

例

postAdjustCommentVotes の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final adjustCommentVotesParams = AdjustCommentVotesParams(); // AdjustCommentVotesParams | 
final broadcastId = broadcastId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.postAdjustCommentVotes(tenantId, commentId, adjustCommentVotesParams, PostAdjustCommentVotesOptions(broadcastId: broadcastId, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->postAdjustCommentVotes: $e\n');
}

APIエクスポート実行

Parameters

Name	Type	Location	Required
tenantId	string	クエリ	はい
text-search	string	クエリ	いいえ
byIPFromComment	string	クエリ	いいえ
filters	string	クエリ	いいえ
searchFilters	string	クエリ	いいえ
sorts	string	クエリ	いいえ
sso	string	クエリ	いいえ

Response

Returns: ModerationExportResponse

Example

postApiExport 例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final textSearch = textSearch_example; // String | 
final byIPFromComment = byIPFromComment_example; // String | 
final filters = filters_example; // String | 
final searchFilters = searchFilters_example; // String | 
final sorts = sorts_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.postApiExport(tenantId, PostApiExportOptions(textSearch: textSearch, byIPFromComment: byIPFromComment, filters: filters, searchFilters: searchFilters, sorts: sorts, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->postApiExport: $e\n');
}

コメントからユーザーをバン

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
banEmail	boolean	query	いいえ
banEmailDomain	boolean	query	いいえ
banIP	boolean	query	いいえ
deleteAllUsersComments	boolean	query	いいえ
bannedUntil	string	query	いいえ
isShadowBan	boolean	query	いいえ
updateId	string	query	いいえ
banReason	string	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: BanUserFromCommentResult

例

postBanUserFromComment の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final banEmail = true; // bool | 
final banEmailDomain = true; // bool | 
final banIP = true; // bool | 
final deleteAllUsersComments = true; // bool | 
final bannedUntil = bannedUntil_example; // String | 
final isShadowBan = true; // bool | 
final updateId = updateId_example; // String | 
final banReason = banReason_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.postBanUserFromComment(tenantId, commentId, PostBanUserFromCommentOptions(banEmail: banEmail, banEmailDomain: banEmailDomain, banIP: banIP, deleteAllUsersComments: deleteAllUsersComments, bannedUntil: bannedUntil, isShadowBan: isShadowBan, updateId: updateId, banReason: banReason, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->postBanUserFromComment: $e\n');
}

バン取り消し

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
sso	string	query	いいえ

レスポンス

返却: APIEmptyResponse

例

postBanUserUndo の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final banUserUndoParams = BanUserUndoParams(); // BanUserUndoParams | 
final sso = sso_example; // String | 
try {
    final result = api_instance.postBanUserUndo(tenantId, banUserUndoParams, sso);
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->postBanUserUndo: $e\n');
}

事前バンサマリー一括取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
includeByUserIdAndEmail	boolean	query	No
includeByIP	boolean	query	No
includeByEmailDomain	boolean	query	No
sso	string	query	No

応答

戻り値: BulkPreBanSummary

例

postBulkPreBanSummary の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final bulkPreBanParams = BulkPreBanParams(); // BulkPreBanParams | 
final includeByUserIdAndEmail = true; // bool | 
final includeByIP = true; // bool | 
final includeByEmailDomain = true; // bool | 
final sso = sso_example; // String | 
try {
    final result = api_instance.postBulkPreBanSummary(tenantId, bulkPreBanParams, PostBulkPreBanSummaryOptions(includeByUserIdAndEmail: includeByUserIdAndEmail, includeByIP: includeByIP, includeByEmailDomain: includeByEmailDomain, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->postBulkPreBanSummary: $e\n');
}

IDでコメント取得

パラメータ

名前	型	場所	必要	説明
tenantId	string	query	はい
sso	string	query	いいえ

応答

戻り値: ModerationAPIChildCommentsResponse

例

postCommentsByIds 例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final commentsByIdsParams = CommentsByIdsParams(); // CommentsByIdsParams | 
final sso = sso_example; // String | 
try {
    final result = api_instance.postCommentsByIds(tenantId, commentsByIdsParams, sso);
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->postCommentsByIds: $e\n');
}

コメントフラグ設定

パラメータ

名前	型	場所	必須
tenantId	string	クエリ	はい
commentId	string	パス	はい
broadcastId	string	クエリ	いいえ
sso	string	クエリ	いいえ

応答

戻り値: APIEmptyResponse

例

postFlagComment の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final broadcastId = broadcastId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.postFlagComment(tenantId, commentId, PostFlagCommentOptions(broadcastId: broadcastId, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->postFlagComment: $e\n');
}

コメント削除

パラメータ

名前	タイプ	場所	必須
tenantId	string	クエリ	はい
commentId	string	パス	はい
broadcastId	string	クエリ	いいえ
sso	string	クエリ	いいえ

レスポンス

返却: PostRemoveCommentApiResponse

例

postRemoveComment の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final broadcastId = broadcastId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.postRemoveComment(tenantId, commentId, PostRemoveCommentOptions(broadcastId: broadcastId, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->postRemoveComment: $e\n');
}

削除されたコメント復元

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
broadcastId	string	query	いいえ
sso	string	query	いいえ

応答

Returns: APIEmptyResponse

例

postRestoreDeletedComment の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final broadcastId = broadcastId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.postRestoreDeletedComment(tenantId, commentId, PostRestoreDeletedCommentOptions(broadcastId: broadcastId, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->postRestoreDeletedComment: $e\n');
}

コメント承認ステータス設定

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
approved	boolean	query	いいえ
broadcastId	string	query	いいえ
sso	string	query	いいえ

レスポンス

返却: SetCommentApprovedResponse

例

postSetCommentApprovalStatus の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final approved = true; // bool | 
final broadcastId = broadcastId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.postSetCommentApprovalStatus(tenantId, commentId, PostSetCommentApprovalStatusOptions(approved: approved, broadcastId: broadcastId, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->postSetCommentApprovalStatus: $e\n');
}

コメントレビュー状態設定

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
reviewed	boolean	query	いいえ
broadcastId	string	query	いいえ
sso	string	query	いいえ

レスポンス

返却: APIEmptyResponse

例

postSetCommentReviewStatus 例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final reviewed = true; // bool | 
final broadcastId = broadcastId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.postSetCommentReviewStatus(tenantId, commentId, PostSetCommentReviewStatusOptions(reviewed: reviewed, broadcastId: broadcastId, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->postSetCommentReviewStatus: $e\n');
}

コメントスパム状態設定

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
spam	boolean	query	No
permNotSpam	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

応答

返却: APIEmptyResponse

例

postSetCommentSpamStatus の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final spam = true; // bool | 
final permNotSpam = true; // bool | 
final broadcastId = broadcastId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.postSetCommentSpamStatus(tenantId, commentId, PostSetCommentSpamStatusOptions(spam: spam, permNotSpam: permNotSpam, broadcastId: broadcastId, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->postSetCommentSpamStatus: $e\n');
}

コメントテキスト設定

パラメータ

名前	型	ロケーション	必須
tenantId	string	query	はい
commentId	string	path	はい
broadcastId	string	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: SetCommentTextResponse

例

postSetCommentText 例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // 文字列 | 
final commentId = commentId_example; // 文字列 | 
final setCommentTextParams = SetCommentTextParams(); // SetCommentTextParams | 
final broadcastId = broadcastId_example; // 文字列 | 
final sso = sso_example; // 文字列 | 
try {
    final result = api_instance.postSetCommentText(tenantId, commentId, setCommentTextParams, PostSetCommentTextOptions(broadcastId: broadcastId, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->postSetCommentText: $e\n');
}

コメントフラグ解除

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
broadcastId	string	query	いいえ
sso	string	query	いいえ

レスポンス

返却: APIEmptyResponse

例

postUnFlagComment の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final broadcastId = broadcastId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.postUnFlagComment(tenantId, commentId, PostUnFlagCommentOptions(broadcastId: broadcastId, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->postUnFlagComment: $e\n');
}

投票実行

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
direction	string	query	No
broadcastId	string	query	No
sso	string	query	No

レスポンス

返却: VoteResponse

例

postVote の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final direction = direction_example; // String | 
final broadcastId = broadcastId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.postVote(tenantId, commentId, PostVoteOptions(direction: direction, broadcastId: broadcastId, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->postVote: $e\n');
}

バッジ付与

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	Yes
badgeId	string	query	Yes
userId	string	query	No
commentId	string	query	No
broadcastId	string	query	No
sso	string	query	No

レスポンス

戻り値: AwardUserBadgeResponse

例

putAwardBadge 例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final badgeId = badgeId_example; // String | 
final userId = userId_example; // String | 
final commentId = commentId_example; // String | 
final broadcastId = broadcastId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.putAwardBadge(tenantId, badgeId, PutAwardBadgeOptions(userId: userId, commentId: commentId, broadcastId: broadcastId, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->putAwardBadge: $e\n');
}

スレッドクローズ

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	はい
urlId	string	query	はい
sso	string	query	いいえ

レスポンス

戻り値: APIEmptyResponse

例

putCloseThread の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final urlId = urlId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.putCloseThread(tenantId, urlId, sso);
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->putCloseThread: $e\n');
}

バッジ削除

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
badgeId	string	query	Yes
userId	string	query	No
commentId	string	query	No
broadcastId	string	query	No
sso	string	query	No

レスポンス

Returns: RemoveUserBadgeResponse

例

putRemoveBadge の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final badgeId = badgeId_example; // String | 
final userId = userId_example; // String | 
final commentId = commentId_example; // String | 
final broadcastId = broadcastId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.putRemoveBadge(tenantId, badgeId, PutRemoveBadgeOptions(userId: userId, commentId: commentId, broadcastId: broadcastId, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->putRemoveBadge: $e\n');
}

スレッド再オープン

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
urlId	string	query	はい
sso	string	query	いいえ

レスポンス

戻り値: APIEmptyResponse

例

putReopenThread 例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final urlId = urlId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.putReopenThread(tenantId, urlId, sso);
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->putReopenThread: $e\n');
}

信頼度設定

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
userId	string	query	No
trustFactor	string	query	No
sso	string	query	No

レスポンス

返却: SetUserTrustFactorResponse

例

setTrustFactor の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = ModerationApi();
final tenantId = tenantId_example; // String | 
final userId = userId_example; // String | 
final trustFactor = trustFactor_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.setTrustFactor(tenantId, SetTrustFactorOptions(userId: userId, trustFactor: trustFactor, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->setTrustFactor: $e\n');
}

モデレーター作成

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい

レスポンス

戻り値: CreateModeratorResponse

例

createModerator の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、以下のコメントを外して API キーのプレフィックス（例: Bearer）を設定してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createModeratorBody = CreateModeratorBody(); // CreateModeratorBody | 
try {
    final result = api_instance.createModerator(tenantId, createModeratorBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createModerator: $e\n');
}

モデレーター削除

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
id	string	path	Yes
sendEmail	string	query	No

レスポンス

返り値: APIEmptyResponse

例

deleteModerator の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントアウトを解除して、APIキーのプレフィックス（例: Bearer）を設定してください（必要な場合）
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final sendEmail = sendEmail_example; // String | 
try {
    final result = api_instance.deleteModerator(tenantId, id, sendEmail);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteModerator: $e\n');
}

モデレーター取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: GetModeratorResponse

例

getModerator の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.getModerator(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getModerator: $e\n');
}

モデレーター一覧取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
skip	number	query	いいえ

レスポンス

返却: GetModeratorsResponse

例

getModerators の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final skip = 1.2; // double | 
try {
    final result = api_instance.getModerators(tenantId, skip);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getModerators: $e\n');
}

招待送信

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
fromName	string	query	はい

応答

返却: APIEmptyResponse

例

sendInvite の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントアウトを解除して、APIキーのプレフィックス（例: Bearer）を設定、必要な場合
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final fromName = fromName_example; // String | 
try {
    final result = api_instance.sendInvite(tenantId, id, fromName);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->sendInvite: $e\n');
}

モデレーター更新

Parameters

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

Response

戻り値: APIEmptyResponse

Example

updateModerator の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントを解除して、APIキーのプレフィックス（例: Bearer）を設定します（必要な場合）
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateModeratorBody = UpdateModeratorBody(); // UpdateModeratorBody | 
try {
    final result = api_instance.updateModerator(tenantId, id, updateModeratorBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateModerator: $e\n');
}

通知数削除

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
id	string	path	Yes

レスポンス

返却: APIEmptyResponse

例

deleteNotificationCount の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO: API キー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントアウトを外して、必要に応じて API キーのプレフィックス（例: Bearer）を設定してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.deleteNotificationCount(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteNotificationCount: $e\n');
}

キャッシュされた通知数取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: GetCachedNotificationCountResponse

例

getCachedNotificationCount の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、以下のコメントを外してAPIキーのプレフィックス（例: Bearer）を設定してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.getCachedNotificationCount(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCachedNotificationCount: $e\n');
}

通知数取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
userId	string	query	いいえ
urlId	string	query	いいえ
fromCommentId	string	query	いいえ
viewed	boolean	query	いいえ
type	string	query	いいえ

レスポンス

戻り値: GetNotificationCountResponse

例

getNotificationCount の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を構成: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 下記のコメントアウトを解除して、APIキーのプレフィックス（例: Bearer）を設定してください（必要な場合）
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final userId = userId_example; // String | 
final urlId = urlId_example; // String | 
final fromCommentId = fromCommentId_example; // String | 
final viewed = true; // bool | 
final type = type_example; // String | 
try {
    final result = api_instance.getNotificationCount(tenantId, GetNotificationCountOptions(userId: userId, urlId: urlId, fromCommentId: fromCommentId, viewed: viewed, type: type));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getNotificationCount: $e\n');
}

通知取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
userId	string	query	No
urlId	string	query	No
fromCommentId	string	query	No
viewed	boolean	query	No
type	string	query	No
skip	number	query	No

レスポンス

返却: GetNotificationsResponse

例

getNotifications 例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を構成: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final userId = userId_example; // String | 
final urlId = urlId_example; // String | 
final fromCommentId = fromCommentId_example; // String | 
final viewed = true; // bool | 
final type = type_example; // String | 
final skip = 1.2; // double | 
try {
    final result = api_instance.getNotifications(tenantId, GetNotificationsOptions(userId: userId, urlId: urlId, fromCommentId: fromCommentId, viewed: viewed, type: type, skip: skip));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getNotifications: $e\n');
}

通知更新

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No

レスポンス

戻り値: APIEmptyResponse

例

updateNotification の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO: APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 下のコメントアウトを解除して、必要に応じてAPIキーのプレフィックス（例: Bearer）を設定してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateNotificationBody = UpdateNotificationBody(); // UpdateNotificationBody | 
final userId = userId_example; // String | 
try {
    final result = api_instance.updateNotification(tenantId, id, updateNotificationBody, userId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateNotification: $e\n');
}

ページリアクト作成（V1）

パラメータ

名前	型	場所	必須
tenantId	string	path	はい
urlId	string	query	はい
title	string	query	いいえ

レスポンス

返り値: CreateV1PageReact

例

createV1PageReact の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final urlId = urlId_example; // String | 
final title = title_example; // String | 
try {
    final result = api_instance.createV1PageReact(tenantId, urlId, title);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->createV1PageReact: $e\n');
}

ページリアクト作成（V2）

パラメータ

名前	型	場所	必須
tenantId	string	path	はい
urlId	string	query	はい
id	string	query	はい
title	string	query	いいえ

レスポンス

戻り値: CreateV1PageReact

例

createV2PageReact の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final urlId = urlId_example; // String | 
final id = id_example; // String | 
final title = title_example; // String | 
try {
    final result = api_instance.createV2PageReact(tenantId, urlId, id, title);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->createV2PageReact: $e\n');
}

ページリアクト削除（V1）

パラメータ

名前	タイプ	ロケーション	必須	説明
tenantId	string	path	Yes
urlId	string	query	Yes

応答

返却: CreateV1PageReact

例

deleteV1PageReact の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final urlId = urlId_example; // String | 
try {
    final result = api_instance.deleteV1PageReact(tenantId, urlId);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->deleteV1PageReact: $e\n');
}

ページリアクト削除（V2）

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
urlId	string	query	Yes
id	string	query	Yes

応答

返却: CreateV1PageReact

例

deleteV2PageReact の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final urlId = urlId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.deleteV2PageReact(tenantId, urlId, id);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->deleteV2PageReact: $e\n');
}

ページいいね取得（V1）

パラメータ

名前	型	場所	必須	説明
tenantId	string	path	Yes
urlId	string	query	Yes

レスポンス

戻り値: GetV1PageLikes

例

getV1PageLikes の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final urlId = urlId_example; // String | 
try {
    final result = api_instance.getV1PageLikes(tenantId, urlId);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getV1PageLikes: $e\n');
}

ページリアクション取得（V2）

パラメータ

名前	タイプ	場所	必須	説明
tenantId	string	path	Yes
urlId	string	query	Yes

レスポンス

返却: GetV2PageReacts

例

getV2PageReacts の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final urlId = urlId_example; // String | 
try {
    final result = api_instance.getV2PageReacts(tenantId, urlId);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getV2PageReacts: $e\n');
}

ページリアクションユーザー取得（V2）

パラメータ

名前	種類	場所	必須
tenantId	string	path	Yes
urlId	string	query	Yes
id	string	query	Yes

レスポンス

返り値: GetV2PageReactUsersResponse

例

getV2PageReactUsers の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final urlId = urlId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.getV2PageReactUsers(tenantId, urlId, id);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getV2PageReactUsers: $e\n');
}

ページ追加

パラメータ

名前	種類	場所	必須	説明
tenantId	string	query	Yes

レスポンス

戻り値: AddPageAPIResponse

例

addPage の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを外してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createAPIPageData = CreateAPIPageData(); // CreateAPIPageData | 
try {
    final result = api_instance.addPage(tenantId, createAPIPageData);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addPage: $e\n');
}

ページ削除

Parameters

Name	Type	Location	Required	Description
tenantId	string	query	はい
id	string	path	はい

Response

Returns: DeletePageAPIResponse

Example

deletePage の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.deletePage(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deletePage: $e\n');
}

オフラインユーザー取得

ページ上の過去のコメント投稿者で、現在オンラインではないもの。displayName でソートされます。
/users/online をすべて使用した後に、「Members」セクションを表示するために使用します。
commenterName に対するカーソルページング: サーバーは部分的な {tenantId, urlId, commenterName} インデックスを afterName から $gt を使用して前方に走査し、$skip コストはかかりません。

パラメータ

Name	Type	Location	Required	Description
tenantId	string	path	Yes
urlId	string	query	Yes	ページ URL 識別子（サーバー側でクリーンアップ）。
afterName	string	query	No	カーソル: 前回のレスポンスから `nextAfterName` を渡す。
afterUserId	string	query	No	カーソルのタイブレーカ: 前回のレスポンスから `nextAfterUserId` を渡す。`afterName` が設定されている場合に必要で、名前が同じでエントリが落ちないようにする。

レスポンス

Returns: PageUsersOfflineResponse

例

getOfflineUsers の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final urlId = urlId_example; // String | ページ URL 識別子（サーバー側でクリーンアップ）。
final afterName = afterName_example; // String | カーソル: 前回のレスポンスから nextAfterName を渡す。
final afterUserId = afterUserId_example; // String | カーソルのタイブレーカ: 前回のレスポンスから nextAfterUserId を渡す。afterName が設定されている場合に必要で、名前が同じでエントリが落ちないようにする。
try {
    final result = api_instance.getOfflineUsers(tenantId, urlId, GetOfflineUsersOptions(afterName: afterName, afterUserId: afterUserId));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getOfflineUsers: $e\n');
}

オンラインユーザー取得

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

Name	Type	Location	Required	Description
tenantId	string	path	Yes
urlId	string	query	Yes	ページ URL 識別子（サーバー側でクリーンアップ済み）。
afterName	string	query	No	カーソル: 前回のレスポンスから nextAfterName を渡します。
afterUserId	string	query	No	カーソルのタイブレーカー: 前回のレスポンスから nextAfterUserId を渡します。afterName が設定されている場合、名前のタイがエントリを除外しないように必須です。

Response

返却: PageUsersOnlineResponse

Example

getOnlineUsers の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String |
final urlId = urlId_example; // String | ページ URL 識別子（サーバー側でクリーンアップ済み）。
final afterName = afterName_example; // String | カーソル: 前回のレスポンスから nextAfterName を渡します。
final afterUserId = afterUserId_example; // String | カーソルのタイブレーカー: 前回のレスポンスから nextAfterUserId を渡します。afterName が設定されている場合、名前のタイがエントリを除外しないように必須です。
try {
    final result = api_instance.getOnlineUsers(tenantId, urlId, GetOnlineUsersOptions(afterName: afterName, afterUserId: afterUserId));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getOnlineUsers: $e\n');
}

URL IDでページ取得

パラメータ

名前	種類	場所	必須	説明
tenantId	string	query	Yes
urlId	string	query	Yes

レスポンス

戻り値: GetPageByURLIdAPIResponse

例

getPageByURLId の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証の設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 下記のコメントを解除して、APIキーのプレフィックス（例: Bearer）を設定してください（必要な場合）
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final urlId = urlId_example; // String | 
try {
    final result = api_instance.getPageByURLId(tenantId, urlId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPageByURLId: $e\n');
}

ページ一覧取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい

応答

返却: GetPagesAPIResponse

例

getPages 例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // 文字列 | 
try {
    final result = api_instance.getPages(tenantId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPages: $e\n');
}

ページ一覧取得（公開）

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

名前	型	ロケーション	必須	説明
tenantId	string	path	Yes
cursor	string	query	No	前回のリクエストで `nextCursor` として返された不透明なページネーションカーソル。同じ `sortBy` に紐付く。
limit	integer	query	No	1..200, default 50
q	string	query	No	オプションの大文字小文字を区別しないタイトルプレフィックスフィルタ。
sortBy	string	query	No	ソート順。`updatedAt`（デフォルト、最新が最初）、`commentCount`（コメント数が多い順）、または `title`（アルファベット順）。
hasComments	boolean	query	No	true の場合、少なくとも1つのコメントがあるページのみを返す。

Response

Returns: GetPublicPagesResponse

Example

getPagesPublic の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final cursor = cursor_example; // String | 前回のリクエストで `nextCursor` として返された不透明なページネーションカーソル。同じ `sortBy` に紐付く。
final limit = 56; // int | 1..200, default 50
final q = q_example; // String | オプションの大文字小文字を区別しないタイトルプレフィックスフィルタ。
final sortBy = ; // PagesSortBy | ソート順。`updatedAt`（デフォルト、最新が最初）、`commentCount`（コメント数が多い順）、または `title`（アルファベット順）。
final hasComments = true; // bool | true の場合、少なくとも1つのコメントがあるページのみを返す。
try {
    final result = api_instance.getPagesPublic(tenantId, GetPagesPublicOptions(cursor: cursor, limit: limit, q: q, sortBy: sortBy, hasComments: hasComments));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getPagesPublic: $e\n');
}

ユーザー情報取得

テナント向けの大量ユーザー情報です。userIds が指定された場合、User / SSOUser から表示情報を返します。コメントウィジェットが、プレゼンスイベントで新たに出現したユーザーを豊かにするために使用されます。ページコンテキストがない場合: プライバシーは一様に適用され（プライベートプロフィールはマスクされます）。

Parameters

名前	型	場所	必須	説明
tenantId	string	path	Yes
ids	string	query	Yes	カンマ区切りの userIds。

Response

Returns: PageUsersInfoResponse

Example

getUsersInfo の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final ids = ids_example; // String | Comma-delimited userIds.
try {
    final result = api_instance.getUsersInfo(tenantId, ids);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getUsersInfo: $e\n');
}

ページ更新

パラメータ

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

レスポンス

返却: PatchPageAPIResponse

例

patchPage の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントを解除して、APIキーのプレフィックス（例: Bearer）を設定してください（必要な場合）
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateAPIPageData = UpdateAPIPageData(); // UpdateAPIPageData | 
try {
    final result = api_instance.patchPage(tenantId, id, updateAPIPageData);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->patchPage: $e\n');
}

保留中Webhookイベント削除

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

返り値: APIEmptyResponse

例

deletePendingWebhookEvent 例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 下のコメントを解除して、APIキーのプレフィックス（例: Bearer）を設定してください（必要な場合）
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.deletePendingWebhookEvent(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deletePendingWebhookEvent: $e\n');
}

保留中Webhookイベント数取得

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
commentId	string	query	No
externalId	string	query	No
eventType	string	query	No
type	string	query	No
domain	string	query	No
attemptCountGT	number	query	No

応答

戻り値: GetPendingWebhookEventCountResponse

例

getPendingWebhookEventCount の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final externalId = externalId_example; // String | 
final eventType = eventType_example; // String | 
final type = type_example; // String | 
final domain = domain_example; // String | 
final attemptCountGT = 1.2; // double | 
try {
    final result = api_instance.getPendingWebhookEventCount(tenantId, GetPendingWebhookEventCountOptions(commentId: commentId, externalId: externalId, eventType: eventType, type: type, domain: domain, attemptCountGT: attemptCountGT));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPendingWebhookEventCount: $e\n');
}

保留中Webhookイベント取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	query	いいえ
externalId	string	query	いいえ
eventType	string	query	いいえ
type	string	query	いいえ
domain	string	query	いいえ
attemptCountGT	number	query	いいえ
skip	number	query	いいえ

レスポンス

戻り値: GetPendingWebhookEventsResponse

例

getPendingWebhookEvents の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を構成: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス (例: Bearer) を設定するには、以下のコメントを外してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final externalId = externalId_example; // String | 
final eventType = eventType_example; // String | 
final type = type_example; // String | 
final domain = domain_example; // String | 
final attemptCountGT = 1.2; // double | 
final skip = 1.2; // double | 
try {
    final result = api_instance.getPendingWebhookEvents(tenantId, GetPendingWebhookEventsOptions(commentId: commentId, externalId: externalId, eventType: eventType, type: type, domain: domain, attemptCountGT: attemptCountGT, skip: skip));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPendingWebhookEvents: $e\n');
}

質問設定作成

パラメータ

名前	型	場所	必須	説明
tenantId	string	クエリ	はい

レスポンス

戻り値: CreateQuestionConfigResponse

例

createQuestionConfig の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO API キー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、API キーのプレフィックス (例: Bearer) を設定するには、以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createQuestionConfigBody = CreateQuestionConfigBody(); // CreateQuestionConfigBody | 
try {
    final result = api_instance.createQuestionConfig(tenantId, createQuestionConfigBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createQuestionConfig: $e\n');
}

質問設定削除

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

deleteQuestionConfig の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO API キー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントを外して、必要に応じて API キーのプレフィックス（例: Bearer）を設定してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.deleteQuestionConfig(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteQuestionConfig: $e\n');
}

質問設定取得

パラメータ

名前	タイプ	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: GetQuestionConfigResponse

例

getQuestionConfig 例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// コメントアウトを解除して、必要に応じて API キーのプレフィックス (例: Bearer) を設定してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.getQuestionConfig(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getQuestionConfig: $e\n');
}

質問設定一覧取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
skip	number	query	いいえ

レスポンス

戻り値: GetQuestionConfigsResponse

例

getQuestionConfigs の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO API キー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、API キーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final skip = 1.2; // double | 
try {
    final result = api_instance.getQuestionConfigs(tenantId, skip);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getQuestionConfigs: $e\n');
}

質問設定更新

パラメータ

名前	型	位置	必須	説明
tenantId	string	query	Yes
id	string	path	Yes

応答

返却: APIEmptyResponse

例

updateQuestionConfig の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を構成してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 下記のコメントを解除して、APIキーのプレフィックス (例: Bearer) を設定します（必要な場合）
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateQuestionConfigBody = UpdateQuestionConfigBody(); // UpdateQuestionConfigBody | 
try {
    final result = api_instance.updateQuestionConfig(tenantId, id, updateQuestionConfigBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateQuestionConfig: $e\n');
}

質問結果作成

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい

レスポンス

Returns: CreateQuestionResultResponse

例

createQuestionResult の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 下記のコメントを解除して、必要に応じて API キーのプレフィックス（例: Bearer）を設定してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createQuestionResultBody = CreateQuestionResultBody(); // CreateQuestionResultBody | 
try {
    final result = api_instance.createQuestionResult(tenantId, createQuestionResultBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createQuestionResult: $e\n');
}

質問結果削除

パラメータ

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

レスポンス

戻り値: APIEmptyResponse

例

deleteQuestionResult の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するためのコメントアウトを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.deleteQuestionResult(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteQuestionResult: $e\n');
}

質問結果取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
id	string	path	Yes

レスポンス

戻り値: GetQuestionResultResponse

例

getQuestionResult 例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO: APIキー認証を設定する: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.getQuestionResult(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getQuestionResult: $e\n');
}

質問結果一覧取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
urlId	string	query	いいえ
userId	string	query	いいえ
startDate	string	query	いいえ
questionId	string	query	いいえ
questionIds	string	query	いいえ
skip	number	query	いいえ

レスポンス

戻り値: GetQuestionResultsResponse

例

getQuestionResults の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を構成する: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて API キーのプレフィックス (例: Bearer) を設定するため、以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final urlId = urlId_example; // String | 
final userId = userId_example; // String | 
final startDate = startDate_example; // String | 
final questionId = questionId_example; // String | 
final questionIds = questionIds_example; // String | 
final skip = 1.2; // double | 
try {
    final result = api_instance.getQuestionResults(tenantId, GetQuestionResultsOptions(urlId: urlId, userId: userId, startDate: startDate, questionId: questionId, questionIds: questionIds, skip: skip));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getQuestionResults: $e\n');
}

質問結果更新

パラメータ

名前	タイプ	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

updateQuestionResult の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するためのコメントを外す
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateQuestionResultBody = UpdateQuestionResultBody(); // UpdateQuestionResultBody | 
try {
    final result = api_instance.updateQuestionResult(tenantId, id, updateQuestionResultBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateQuestionResult: $e\n');
}

質問結果集計

Parameters

名前	タイプ	ロケーション	必須
tenantId	string	query	Yes
questionId	string	query	No
questionIds	array	query	No
urlId	string	query	No
timeBucket	string	query	No
startDate	string	query	No
forceRecalculate	boolean	query	No

Response

返却: AggregateQuestionResultsResponse

Example

aggregateQuestionResults の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final questionId = questionId_example; // String | 
final questionIds = []; // List<String> | 
final urlId = urlId_example; // String | 
final timeBucket = ; // AggregateTimeBucket | 
final startDate = 2013-10-20T19:20:30+01:00; // DateTime | 
final forceRecalculate = true; // bool | 
try {
    final result = api_instance.aggregateQuestionResults(tenantId, AggregateQuestionResultsOptions(questionId: questionId, questionIds: questionIds, urlId: urlId, timeBucket: timeBucket, startDate: startDate, forceRecalculate: forceRecalculate));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->aggregateQuestionResults: $e\n');
}

質問結果一括集計

パラメータ

名前	種類	場所	必須	説明
tenantId	string	query	はい
forceRecalculate	boolean	query	いいえ

応答

戻り値: BulkAggregateQuestionResultsResponse

例

bulkAggregateQuestionResults の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO API キー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントを外して、API キーのプレフィックス（例: Bearer）を設定してください（必要な場合）
 //defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final bulkAggregateQuestionResultsRequest = BulkAggregateQuestionResultsRequest(); // BulkAggregateQuestionResultsRequest | 
final forceRecalculate = true; // bool | 
try {
    final result = api_instance.bulkAggregateQuestionResults(tenantId, bulkAggregateQuestionResultsRequest, forceRecalculate);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->bulkAggregateQuestionResults: $e\n');
}

コメントと質問結果の結合

パラメータ

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

レスポンス

戻り値: CombineQuestionResultsWithCommentsResponse

例

combineCommentsWithQuestionResults の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO: APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを外してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final questionId = questionId_example; // String | 
final questionIds = []; // List<String> | 
final urlId = urlId_example; // String | 
final startDate = 2013-10-20T19:20:30+01:00; // DateTime | 
final forceRecalculate = true; // bool | 
final minValue = 1.2; // double | 
final maxValue = 1.2; // double | 
final limit = 1.2; // double | 
try {
    final result = api_instance.combineCommentsWithQuestionResults(tenantId, CombineCommentsWithQuestionResultsOptions(questionId: questionId, questionIds: questionIds, urlId: urlId, startDate: startDate, forceRecalculate: forceRecalculate, minValue: minValue, maxValue: maxValue, limit: limit));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->combineCommentsWithQuestionResults: $e\n');
}

SSOユーザー追加

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes

レスポンス

戻り値: AddSSOUserAPIResponse

例

addSSOUser の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// APIキーのプレフィックス (例: Bearer) を設定するには、以下のコメントを外してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createAPISSOUserData = CreateAPISSOUserData(); // CreateAPISSOUserData | 
try {
    final result = api_instance.addSSOUser(tenantId, createAPISSOUserData);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addSSOUser: $e\n');
}

SSOユーザー削除

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
deleteComments	boolean	query	いいえ
commentDeleteMode	string	query	いいえ

レスポンス

戻り値: DeleteSSOUserAPIResponse

例

deleteSSOUser の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントを外して、必要に応じてAPIキーのプレフィックス（例: Bearer）を設定してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final deleteComments = true; // bool | 
final commentDeleteMode = commentDeleteMode_example; // String | 
try {
    final result = api_instance.deleteSSOUser(tenantId, id, DeleteSSOUserOptions(deleteComments: deleteComments, commentDeleteMode: commentDeleteMode));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteSSOUser: $e\n');
}

メールアドレスでSSOユーザー取得

Parameters

Name	Type	Location	Required	Description
tenantId	string	query	はい
email	string	path	はい

Response

返却: GetSSOUserByEmailAPIResponse

Example

getSSOUserByEmail の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントを解除して、必要に応じてAPIキーのプレフィックス（例: Bearer）を設定
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final email = email_example; // String | 
try {
    final result = api_instance.getSSOUserByEmail(tenantId, email);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSSOUserByEmail: $e\n');
}

IDでSSOユーザー取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

応答

返り値: GetSSOUserByIdAPIResponse

例

getSSOUserById の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントアウトを解除して、必要に応じて API キーのプレフィックス (例: Bearer) を設定
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.getSSOUserById(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSSOUserById: $e\n');
}

SSOユーザー一覧取得

パラメータ

名前	タイプ	場所	必須	説明
tenantId	string	query	Yes
skip	integer	query	No

レスポンス

戻り値: GetSSOUsersResponse

例

getSSOUsersの例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO API キー認証を構成する: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、API キーのプレフィックス (例: Bearer) を設定するには以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final skip = 56; // int | 
try {
    final result = api_instance.getSSOUsers(tenantId, skip);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSSOUsers: $e\n');
}

SSOユーザー更新（パッチ）

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
id	string	path	Yes
updateComments	boolean	query	No

応答

戻り値: PatchSSOUserAPIResponse

例

patchSSOUser の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateAPISSOUserData = UpdateAPISSOUserData(); // UpdateAPISSOUserData | 
final updateComments = true; // bool | 
try {
    final result = api_instance.patchSSOUser(tenantId, id, updateAPISSOUserData, updateComments);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->patchSSOUser: $e\n');
}

SSOユーザー置換

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
id	string	path	Yes
updateComments	boolean	query	No

レスポンス

返却: PutSSOUserAPIResponse

例

putSSOUser の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントを解除して、APIキーのプレフィックス（例: Bearer）を設定する場合は必要です
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateAPISSOUserData = UpdateAPISSOUserData(); // UpdateAPISSOUserData | 
final updateComments = true; // bool | 
try {
    final result = api_instance.putSSOUser(tenantId, id, updateAPISSOUserData, updateComments);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->putSSOUser: $e\n');
}

サブスクリプション作成

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes

応答

戻り値: CreateSubscriptionAPIResponse

例

createSubscription 例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 下記のコメントアウトを外して、APIキーのプレフィックス（例: Bearer）を設定します（必要な場合）
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createAPIUserSubscriptionData = CreateAPIUserSubscriptionData(); // CreateAPIUserSubscriptionData | 
try {
    final result = api_instance.createSubscription(tenantId, createAPIUserSubscriptionData);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createSubscription: $e\n');
}

サブスクリプション削除

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No

応答

返却: DeleteSubscriptionAPIResponse

例

deleteSubscription の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントを外して、APIキーのプレフィックス（例: Bearer）を設定、必要な場合
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final userId = userId_example; // String | 
try {
    final result = api_instance.deleteSubscription(tenantId, id, userId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteSubscription: $e\n');
}

サブスクリプション取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
userId	string	query	No

レスポンス

返却: GetSubscriptionsAPIResponse

例

getSubscriptions の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証の設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final userId = userId_example; // String | 
try {
    final result = api_instance.getSubscriptions(tenantId, userId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSubscriptions: $e\n');
}

サブスクリプション更新

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No

レスポンス

戻り値: UpdateSubscriptionAPIResponse

例

updateSubscription の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateAPIUserSubscriptionData = UpdateAPIUserSubscriptionData(); // UpdateAPIUserSubscriptionData | 
final userId = userId_example; // String | 
try {
    final result = api_instance.updateSubscription(tenantId, id, updateAPIUserSubscriptionData, userId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateSubscription: $e\n');
}

テナント日次使用量取得

Parameters

名前	型	場所	必須
tenantId	string	query	Yes
yearNumber	number	query	No
monthNumber	number	query	No
dayNumber	number	query	No
skip	number	query	No

Response

Returns: GetTenantDailyUsagesResponse

Example

getTenantDailyUsages の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントを解除して、APIキーのプレフィックス（例: Bearer）を設定してください（必要な場合）
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final yearNumber = 1.2; // double | 
final monthNumber = 1.2; // double | 
final dayNumber = 1.2; // double | 
final skip = 1.2; // double | 
try {
    final result = api_instance.getTenantDailyUsages(tenantId, GetTenantDailyUsagesOptions(yearNumber: yearNumber, monthNumber: monthNumber, dayNumber: dayNumber, skip: skip));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTenantDailyUsages: $e\n');
}

テナントパッケージ作成

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい

応答

戻り値: CreateTenantPackageResponse

例

createTenantPackage 例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキーの認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントを外して、APIキーのプレフィックス（例: Bearer）を設定（必要に応じて）
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createTenantPackageBody = CreateTenantPackageBody(); // CreateTenantPackageBody | 
try {
    final result = api_instance.createTenantPackage(tenantId, createTenantPackageBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createTenantPackage: $e\n');
}

テナントパッケージ削除

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

返却: APIEmptyResponse

例

deleteTenantPackage の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するために以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.deleteTenantPackage(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteTenantPackage: $e\n');
}

テナントパッケージ取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
id	string	path	Yes

レスポンス

返却: GetTenantPackageResponse

例

getTenantPackage 例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例：Bearer）を設定するには、以下のコメントアウトを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.getTenantPackage(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTenantPackage: $e\n');
}

テナントパッケージ一覧取得

パラメーター

名前	型	場所	必須	説明
tenantId	string	query	はい
skip	number	query	いいえ

レスポンス

戻り値: GetTenantPackagesResponse

例

getTenantPackages の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO API キー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final skip = 1.2; // double | 
try {
    final result = api_instance.getTenantPackages(tenantId, skip);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTenantPackages: $e\n');
}

テナントパッケージ置換

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

応答

返却: APIEmptyResponse

例

replaceTenantPackage の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証の設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要であれば、APIキー用にプレフィックス（例: Bearer）を設定するために下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final replaceTenantPackageBody = ReplaceTenantPackageBody(); // ReplaceTenantPackageBody | 
try {
    final result = api_instance.replaceTenantPackage(tenantId, id, replaceTenantPackageBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->replaceTenantPackage: $e\n');
}

テナントパッケージ更新

Parameters

名前	タイプ	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

返却: APIEmptyResponse

例

updateTenantPackage の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを外してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateTenantPackageBody = UpdateTenantPackageBody(); // UpdateTenantPackageBody | 
try {
    final result = api_instance.updateTenantPackage(tenantId, id, updateTenantPackageBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateTenantPackage: $e\n');
}

テナントユーザー作成

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい

レスポンス

返却値: CreateTenantUserResponse

例

createTenantUser の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 下記のコメントを解除して、APIキーのプレフィックス（例: Bearer）を設定します（必要な場合）
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createTenantUserBody = CreateTenantUserBody(); // CreateTenantUserBody | 
try {
    final result = api_instance.createTenantUser(tenantId, createTenantUserBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createTenantUser: $e\n');
}

テナントユーザー削除

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	Yes
id	string	path	Yes
deleteComments	string	query	No
commentDeleteMode	string	query	No

レスポンス

戻り値: APIEmptyResponse

例

deleteTenantUser の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメント解除でAPIキーのプレフィックス（例: Bearer）を設定できます、必要に応じて
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String |
final id = id_example; // String |
final deleteComments = deleteComments_example; // String |
final commentDeleteMode = commentDeleteMode_example; // String |
try {
    final result = api_instance.deleteTenantUser(tenantId, id, DeleteTenantUserOptions(deleteComments: deleteComments, commentDeleteMode: commentDeleteMode));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteTenantUser: $e\n');
}

テナントユーザー取得

パラメータ

名前	型	場所	必要	説明
tenantId	string	query	はい
id	string	path	はい

応答

戻り値: GetTenantUserResponse

例

getTenantUser 例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じてAPIキーのプレフィックス（例: Bearer）を設定するには下のコメントを外してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.getTenantUser(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTenantUser: $e\n');
}

テナントユーザー一覧取得

Parameters

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

Response

返却: GetTenantUsersResponse

Example

getTenantUsers の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントを解除して、必要に応じて API キーのプレフィックス（例: Bearer）を設定してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final skip = 1.2; // double | 
try {
    final result = api_instance.getTenantUsers(tenantId, skip);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTenantUsers: $e\n');
}

テナントユーザー置換

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
id	string	path	Yes
updateComments	string	query	No

応答

返り値: APIEmptyResponse

例

replaceTenantUser の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final replaceTenantUserBody = ReplaceTenantUserBody(); // ReplaceTenantUserBody | 
final updateComments = updateComments_example; // String | 
try {
    final result = api_instance.replaceTenantUser(tenantId, id, replaceTenantUserBody, updateComments);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->replaceTenantUser: $e\n');
}

ログインリンク送信

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
id	string	path	はい
redirectURL	string	query	いいえ

レスポンス

返り値: APIEmptyResponse

例

sendLoginLink の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定する: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final redirectURL = redirectURL_example; // String | 
try {
    final result = api_instance.sendLoginLink(tenantId, id, redirectURL);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->sendLoginLink: $e\n');
}

テナントユーザー更新

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
updateComments	string	query	いいえ

応答

戻り値: APIEmptyResponse

例

updateTenantUser 例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateTenantUserBody = UpdateTenantUserBody(); // UpdateTenantUserBody | 
final updateComments = updateComments_example; // String | 
try {
    final result = api_instance.updateTenantUser(tenantId, id, updateTenantUserBody, updateComments);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateTenantUser: $e\n');
}

テナント作成

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes

応答

Returns: CreateTenantResponse

例

createTenant の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createTenantBody = CreateTenantBody(); // CreateTenantBody | 
try {
    final result = api_instance.createTenant(tenantId, createTenantBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createTenant: $e\n');
}

テナント削除

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
id	string	path	Yes
sure	string	query	No

レスポンス

返却: APIEmptyResponse

例

deleteTenant の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を構成してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するために以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final sure = sure_example; // String | 
try {
    final result = api_instance.deleteTenant(tenantId, id, sure);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteTenant: $e\n');
}

テナント取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
id	string	path	Yes

応答

戻り値: GetTenantResponse

例

getTenant 例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証の設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じてAPIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.getTenant(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTenant: $e\n');
}

テナント一覧取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
meta	string	query	いいえ
skip	number	query	いいえ

レスポンス

返却: GetTenantsResponse

例

getTenants の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントを解除して、APIキーのプレフィックス（例: Bearer）を設定します（必要な場合）
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final meta = meta_example; // String | 
final skip = 1.2; // double | 
try {
    final result = api_instance.getTenants(tenantId, GetTenantsOptions(meta: meta, skip: skip));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTenants: $e\n');
}

テナント更新

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
id	string	path	Yes

レスポンス

返却: APIEmptyResponse

例

updateTenant の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateTenantBody = UpdateTenantBody(); // UpdateTenantBody | 
try {
    final result = api_instance.updateTenant(tenantId, id, updateTenantBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateTenant: $e\n');
}

チケット状態変更

Parameters

名前	種類	場所	必須
tenantId	string	query	はい
userId	string	query	はい
id	string	path	はい

Response

戻り値: ChangeTicketStateResponse

Example

changeTicketState の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final userId = userId_example; // String | 
final id = id_example; // String | 
final changeTicketStateBody = ChangeTicketStateBody(); // ChangeTicketStateBody | 
try {
    final result = api_instance.changeTicketState(tenantId, userId, id, changeTicketStateBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->changeTicketState: $e\n');
}

チケット作成

パラメータ

名前	タイプ	場所	必須	説明
tenantId	string	query	Yes
userId	string	query	Yes

レスポンス

Returns: CreateTicketResponse

例

createTicket の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じてAPIキーのプレフィックス（例: Bearer）を設定する場合は、以下のコメントアウトを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final userId = userId_example; // String | 
final createTicketBody = CreateTicketBody(); // CreateTicketBody | 
try {
    final result = api_instance.createTicket(tenantId, userId, createTicketBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createTicket: $e\n');
}

チケット取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
userId	string	query	いいえ

応答

戻り値: GetTicketResponse

例

getTicket の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントアウトを解除して、APIキーのプレフィックス（例: Bearer）を設定します（必要な場合）
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final userId = userId_example; // String | 
try {
    final result = api_instance.getTicket(tenantId, id, userId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTicket: $e\n');
}

チケット一覧取得

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
userId	string	query	No
state	number	query	No
skip	number	query	No
limit	number	query	No

レスポンス

Returns: GetTicketsResponse

Example

getTickets の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントを解除して、APIキーのプレフィックス（例: Bearer）を設定します（必要な場合）
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final userId = userId_example; // String | 
final state = 1.2; // double | 
final skip = 1.2; // double | 
final limit = 1.2; // double | 
try {
    final result = api_instance.getTickets(tenantId, GetTicketsOptions(userId: userId, state: state, skip: skip, limit: limit));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTickets: $e\n');
}

翻訳取得

パラメータ

名前	型	場所	必須
namespace	string	path	Yes
component	string	path	Yes
locale	string	query	No
useFullTranslationIds	boolean	query	No

レスポンス

返却: GetTranslationsResponse

例

getTranslations の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final namespace = namespace_example; // String | 
final component = component_example; // String | 
final locale = locale_example; // String | 
final useFullTranslationIds = true; // bool | 
try {
    final result = api_instance.getTranslations(namespace, component, GetTranslationsOptions(locale: locale, useFullTranslationIds: useFullTranslationIds));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getTranslations: $e\n');
}

画像アップロード

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

Parameters

Name	Type	Location	Required	Description
tenantId	string	path	Yes
sizePreset	string	query	No	サイズプリセット: "Default" (1000x1000px) または "CrossPlatform" (人気デバイス用にサイズを作成)
urlId	string	query	No	設定用のアップロードが行われているページ ID

Response

返り値: UploadImageResponse

Example

uploadImage 例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final file = BINARY_DATA_HERE; // MultipartFile | 
final sizePreset = ; // SizePreset | サイズプリセット: \"Default\" (1000x1000px) または \"CrossPlatform\" (人気デバイス用にサイズを作成)
final urlId = urlId_example; // String | 設定用のアップロードが行われているページ ID
try {
    final result = api_instance.uploadImage(tenantId, file, UploadImageOptions(sizePreset: sizePreset, urlId: urlId));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->uploadImage: $e\n');
}

ユーザーバッジ進捗取得（ID）

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIGetUserBadgeProgressResponse

例

getUserBadgeProgressById の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス (例: Bearer) を設定するには、以下のコメントアウトを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.getUserBadgeProgressById(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUserBadgeProgressById: $e\n');
}

ユーザーバッジ進捗取得（ユーザーID）

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
userId	string	path	はい

応答

返却: APIGetUserBadgeProgressResponse

例

getUserBadgeProgressByUserId 例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントアウトを解除して、APIキーのプレフィックス（例: Bearer）を設定します（必要な場合）
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final userId = userId_example; // String | 
try {
    final result = api_instance.getUserBadgeProgressByUserId(tenantId, userId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUserBadgeProgressByUserId: $e\n');
}

ユーザーバッジ進捗リスト取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
userId	string	query	No
limit	number	query	No
skip	number	query	No

レスポンス

戻り値: APIGetUserBadgeProgressListResponse

例

getUserBadgeProgressList の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final userId = userId_example; // String | 
final limit = 1.2; // double | 
final skip = 1.2; // double | 
try {
    final result = api_instance.getUserBadgeProgressList(tenantId, GetUserBadgeProgressListOptions(userId: userId, limit: limit, skip: skip));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUserBadgeProgressList: $e\n');
}

ユーザーバッジ作成

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい

レスポンス

返却: APICreateUserBadgeResponse

例

createUserBadge の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createUserBadgeParams = CreateUserBadgeParams(); // CreateUserBadgeParams | 
try {
    final result = api_instance.createUserBadge(tenantId, createUserBadgeParams);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createUserBadge: $e\n');
}

ユーザーバッジ削除

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

返却: APIEmptySuccessResponse

例

deleteUserBadge の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、以下のコメントを外して API キーのプレフィックス（例: Bearer）を設定してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.deleteUserBadge(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteUserBadge: $e\n');
}

ユーザーバッジ取得

Parameters

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

Response

返却: APIGetUserBadgeResponse

Example

getUserBadge の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例：Bearer）を設定するためにコメントアウトを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.getUserBadge(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUserBadge: $e\n');
}

ユーザーバッジ一覧取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
userId	string	query	No
badgeId	string	query	No
type	number	query	No
displayedOnComments	boolean	query	No
limit	number	query	No
skip	number	query	No

レスポンス

戻り値: APIGetUserBadgesResponse

例

getUserBadges の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じてAPIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final userId = userId_example; // String | 
final badgeId = badgeId_example; // String | 
final type = 1.2; // double | 
final displayedOnComments = true; // bool | 
final limit = 1.2; // double | 
final skip = 1.2; // double | 
try {
    final result = api_instance.getUserBadges(tenantId, GetUserBadgesOptions(userId: userId, badgeId: badgeId, type: type, displayedOnComments: displayedOnComments, limit: limit, skip: skip));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUserBadges: $e\n');
}

ユーザーバッジ更新

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
id	string	path	Yes

レスポンス

戻り値: APIEmptySuccessResponse

例

updateUserBadge の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを外してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateUserBadgeParams = UpdateUserBadgeParams(); // UpdateUserBadgeParams | 
try {
    final result = api_instance.updateUserBadge(tenantId, id, updateUserBadgeParams);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateUserBadge: $e\n');
}

ユーザー通知数取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
sso	string	query	いいえ

レスポンス

戻り値: GetUserNotificationCountResponse

例

getUserNotificationCount 例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getUserNotificationCount(tenantId, sso);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getUserNotificationCount: $e\n');
}

ユーザー通知取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
urlId	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	いいえ
includeTenantNotifications	boolean	query	いいえ
sso	string	query	いいえ

応答

返却: GetMyNotificationsResponse

例

getUserNotifications の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final urlId = urlId_example; // String | 現在のページが購読されているかどうかを判定するために使用されます。
final pageSize = 56; // int | 
final afterId = afterId_example; // String | 
final includeContext = true; // bool | 
final afterCreatedAt = 789; // int | 
final unreadOnly = true; // bool | 
final dmOnly = true; // bool | 
final noDm = true; // bool | 
final includeTranslations = true; // bool | 
final includeTenantNotifications = true; // bool | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getUserNotifications(tenantId, GetUserNotificationsOptions(urlId: urlId, pageSize: pageSize, afterId: afterId, includeContext: includeContext, afterCreatedAt: afterCreatedAt, unreadOnly: unreadOnly, dmOnly: dmOnly, noDm: noDm, includeTranslations: includeTranslations, includeTenantNotifications: includeTenantNotifications, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getUserNotifications: $e\n');
}

ユーザー通知数リセット

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
sso	string	query	いいえ

レスポンス

戻り値: ResetUserNotificationsResponse

例

resetUserNotificationCount の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.resetUserNotificationCount(tenantId, sso);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->resetUserNotificationCount: $e\n');
}

ユーザー通知リセット

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
afterId	string	query	いいえ
afterCreatedAt	integer	query	いいえ
unreadOnly	boolean	query	いいえ
dmOnly	boolean	query	いいえ
noDm	boolean	query	いいえ
sso	string	query	いいえ

応答

戻り値: ResetUserNotificationsResponse

例

resetUserNotifications の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final afterId = afterId_example; // String | 
final afterCreatedAt = 789; // int | 
final unreadOnly = true; // bool | 
final dmOnly = true; // bool | 
final noDm = true; // bool | 
final sso = sso_example; // String | 
try {
    final result = api_instance.resetUserNotifications(tenantId, ResetUserNotificationsOptions(afterId: afterId, afterCreatedAt: afterCreatedAt, unreadOnly: unreadOnly, dmOnly: dmOnly, noDm: noDm, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->resetUserNotifications: $e\n');
}

コメント購読ステータス更新（ユーザー通知）

Enable or disable notifications for a specific comment.

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
notificationId	string	path	Yes
optedInOrOut	string	path	Yes
commentId	string	query	Yes
sso	string	query	No

レスポンス

返却: UpdateUserNotificationCommentSubscriptionStatusResponse

例

updateUserNotificationCommentSubscriptionStatus の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final notificationId = notificationId_example; // String | 
final optedInOrOut = optedInOrOut_example; // String | 
final commentId = commentId_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.updateUserNotificationCommentSubscriptionStatus(tenantId, notificationId, optedInOrOut, commentId, sso);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->updateUserNotificationCommentSubscriptionStatus: $e\n');
}

ページ購読ステータス更新（ユーザー通知）

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

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
urlId	string	query	Yes
url	string	query	Yes
pageTitle	string	query	Yes
subscribedOrUnsubscribed	string	path	Yes
sso	string	query	No

レスポンス

返却: UpdateUserNotificationPageSubscriptionStatusResponse

例

updateUserNotificationPageSubscriptionStatus の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final urlId = urlId_example; // String | 
final url = url_example; // String | 
final pageTitle = pageTitle_example; // String | 
final subscribedOrUnsubscribed = subscribedOrUnsubscribed_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.updateUserNotificationPageSubscriptionStatus(tenantId, urlId, url, pageTitle, subscribedOrUnsubscribed, sso);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->updateUserNotificationPageSubscriptionStatus: $e\n');
}

ユーザー通知ステータス更新

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
notificationId	string	path	はい
newStatus	string	path	はい
sso	string	query	いいえ

レスポンス

戻り値: UpdateUserNotificationStatusResponse

例

updateUserNotificationStatus 例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final notificationId = notificationId_example; // String | 
final newStatus = newStatus_example; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.updateUserNotificationStatus(tenantId, notificationId, newStatus, sso);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->updateUserNotificationStatus: $e\n');
}

ユーザー在席状態取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
urlIdWS	string	query	Yes
userIds	string	query	Yes

レスポンス

返却: GetUserPresenceStatusesResponse

例

getUserPresenceStatuses の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final urlIdWS = urlIdWS_example; // String | 
final userIds = userIds_example; // String | 
try {
    final result = api_instance.getUserPresenceStatuses(tenantId, urlIdWS, userIds);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getUserPresenceStatuses: $e\n');
}

ユーザー検索

パラメータ

名前	型	Location	必須
tenantId	string	path	はい
urlId	string	query	はい
usernameStartsWith	string	query	いいえ
mentionGroupIds	array	query	いいえ
sso	string	query	いいえ
searchSection	string	query	いいえ

レスポンス

戻り値: SearchUsersResult

例

searchUsers の例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final urlId = urlId_example; // String | 
final usernameStartsWith = usernameStartsWith_example; // String | 
final mentionGroupIds = []; // List<String> | 
final sso = sso_example; // String | 
final searchSection = searchSection_example; // String | 
try {
    final result = api_instance.searchUsers(tenantId, urlId, SearchUsersOptions(usernameStartsWith: usernameStartsWith, mentionGroupIds: mentionGroupIds, sso: sso, searchSection: searchSection));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->searchUsers: $e\n');
}

ユーザー取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	クエリ	はい
id	string	パス	はい

レスポンス

返却: GetUserResponse

例

getUser 例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 下記のコメントを外して、APIキーのプレフィックス（例: Bearer）を設定してください（必要な場合）
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.getUser(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUser: $e\n');
}

投票作成

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	はい
commentId	string	query	はい
direction	string	query	はい
userId	string	query	いいえ
anonUserId	string	query	いいえ

レスポンス

返却: VoteResponse

例

createVote の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO API キー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、API キーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを外してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final direction = direction_example; // String | 
final userId = userId_example; // String | 
final anonUserId = anonUserId_example; // String | 
try {
    final result = api_instance.createVote(tenantId, commentId, direction, CreateVoteOptions(userId: userId, anonUserId: anonUserId));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createVote: $e\n');
}

投票削除

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
id	string	path	Yes
editKey	string	query	No

レスポンス

返却: VoteDeleteResponse

例

deleteVote の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントアウトを解除して、APIキーのプレフィックス（例: Bearer）を設定してください（必要な場合）
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final editKey = editKey_example; // String | 
try {
    final result = api_instance.deleteVote(tenantId, id, editKey);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteVote: $e\n');
}

投票取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
urlId	string	query	Yes

レスポンス

戻り値: GetVotesResponse

例

getVotesの例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 以下のコメントを解除して、APIキーのプレフィックス（例: Bearer）を設定します（必要な場合）
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final urlId = urlId_example; // String | 
try {
    final result = api_instance.getVotes(tenantId, urlId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getVotes: $e\n');
}

ユーザーの投票取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
urlId	string	query	Yes
userId	string	query	No
anonUserId	string	query	No

応答

戻り値: GetVotesForUserResponse

例

getVotesForUser の例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO APIキー認証を設定してください: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを解除してください
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final urlId = urlId_example; // String | 
final userId = userId_example; // String | 
final anonUserId = anonUserId_example; // String | 
try {
    final result = api_instance.getVotesForUser(tenantId, urlId, GetVotesForUserOptions(userId: userId, anonUserId: anonUserId));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getVotesForUser: $e\n');
}

ヘルプが必要ですか？

Dart SDK に関して問題が発生したり質問がある場合は、以下をご利用ください：

コントリビューション

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

言語 🇯🇵 日本語

ドキュメント

集計

監査ログ

認証

コメントからブロック

ブロックされたコメントの確認

コメント

ユーザーのコメント

ドメイン設定

メールテンプレート

イベントログ

フィード投稿

コメントフラグ

GIF

ハッシュタグ

モデレーション

モデレーター

通知数

通知

ページリアクション

ページ

保留中のWebhookイベント

質問設定

質問結果

質問結果集計

SSOユーザー

サブスクリプション

テナント日次使用量

テナントパッケージ

テナントユーザー

テナント

チケット

翻訳

画像アップロード

ユーザーバッジ進捗

ユーザーバッジ

ユーザー通知

ユーザー在席状態

ユーザー検索

ユーザー

投票

FastComments Dart SDK

リポジトリ

AI コーディングエージェント

レイアウト

使用

SSO

集計

Parameters

Response

Example

監査ログ取得

パラメータ

レスポンス

例

公開ログアウト

レスポンス

例

コメントからブロック（公開）

パラメータ

応答

例

コメントブロック解除（公開）

パラメータ

レスポンス

例

ブロックされたコメントの確認

パラメータ

応答

例

コメントからユーザーをブロック

パラメータ

レスポンス

例

コメント作成（公開）

パラメータ

レスポンス

例

コメント削除