FastComments Dart SDK

這是 FastComments 的官方 Dart SDK。

在您的 Dart 和 Flutter 應用程式中管理評論、使用者、單一登入（SSO）以及審核。

Repository

佈局

fastcomments-dart/
  client/        generated dart client (請勿手動編輯)
  sso/           hand-written SSO token helpers
  openapi.json   committed copy of the spec used for generation
  config.json    openapi-generator config
  update.py      regenerate the client from the spec

使用

dependencies:
  fastcomments_dart: ^3.0.0

SSO 輔助工具已包含在套件中（package:fastcomments_dart/sso/...）。

客戶端提供三個 API 類別：

DefaultApi - 透過 API 金鑰驗證的伺服器端使用方法。
PublicApi - 無需 API 金鑰的公開方法，適用於瀏覽器和行動客戶端。
ModerationApi - 包含大量即時且快速的審核 API。每個 ModerationApi 方法都接受 sso 參數，並可透過 SSO 或 FastComments.com 的會話 Cookie 進行驗證。

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'),
);

單點登入

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.
不同的操作（例如 sum、countDistinct、avg 等）受支援。

Parameters

名稱	類型	位置	必填
tenantId	string	查詢	是
parentTenantId	string	查詢	否
includeStats	boolean	查詢	否

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');
}

取得審計日誌

參數

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

回應

返回: GetAuditLogsResponse

範例

getAuditLogs 範例

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 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	是
commentId	string	path	是
sso	string	query	否

回應

返回： 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	Yes
commentIds	string	query	Yes	逗號分隔的評論 ID 列表。
sso	string	query	No

回應

返回： 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');
}

從評論封鎖使用者

參數

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

回應

返回： 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');
}

創建評論（公開）

參數

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

回應

Returns: 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');
}

刪除評論

參數

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

回應

返回：DeleteCommentResult

範例

deleteComment 範例

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

回應

返回: 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');
}

刪除評論投票

參數

Name	Type	Location	Required
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	是
id	string	path	是
userId	string	query	否
anonUserId	string	query	否

回應

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

範例

取得評論範例

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 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	是
page	integer	query	否
limit	integer	query	否
skip	integer	query	否
asTree	boolean	query	否
skipChildren	integer	query	否
limitChildren	integer	query	否
maxTreeDepth	integer	query	否
urlId	string	query	否
userId	string	query	否
anonUserId	string	query	否
contextUserId	string	query	否
hashTag	string	query	否
parentId	string	query	否
direction	string	query	否
fromDate	integer	query	否
toDate	integer	query	否

回應

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

參數

Name	Type	Location	Required
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	Yes
commentId	string	path	Yes
editKey	string	query	No
sso	string	query	No

回應

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

回應

返回：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	是
commentId	string	path	是
broadcastId	string	query	是
sso	string	query	否

回應

返回: 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	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
sso	string	query	No

回應

Returns: ChangeCommentPinStatusResponse

範例

pinComment 範例

Copy

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

保存評論

參數

名稱	類型	位置	必填
tenantId	string	查詢	是
isLive	boolean	查詢	否
doSpamCheck	boolean	查詢	否
sendEmails	boolean	查詢	否
populateNotifications	boolean	查詢	否

回應

返回： APISaveCommentResponse

範例

saveComment 範例

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 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	是
isLive	boolean	query	否
doSpamCheck	boolean	query	否
sendEmails	boolean	query	否
populateNotifications	boolean	query	否

回應

Returns: 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	是
commentId	string	path	是
broadcastId	string	query	是
editKey	string	query	否
sso	string	query	否

回應

返回： 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');
}

解除使用者評論封鎖

參數

名稱	類型	位置	必填
tenantId	string	query	是
id	string	path	是
userId	string	query	否
anonUserId	string	query	否

回應

返回：UnblockSuccess

範例

unBlockUserFromComment 範例

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 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';
// 取消註解以下以設定前綴 (例如 Bearer) 給 API 金鑰，如有需要
//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	是
commentId	string	path	是
broadcastId	string	query	是
sso	string	query	否

回應

返回： 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	Yes
id	string	path	Yes
contextUserId	string	query	No
doSpamCheck	boolean	query	No
isLive	boolean	query	No

回應

Returns: 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('Exception when calling DefaultApi->updateComment: $e\n');
}

為評論投票

參數

名稱	類型	位置	必填
tenantId	string	path	是
commentId	string	path	是
urlId	string	query	是
broadcastId	string	query	是
sessionId	string	query	否
sso	string	query	否

回應

返回： 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';
// 取消註解以下行以設置前綴（例如 Bearer）給 API 金鑰，如有需要
//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	query	是
domain	string	path	是

回應

返回： 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	是
domain	string	path	是

回應

Returns: GetDomainConfigResponse

範例

getDomainConfig 範例

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 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	是

回應

回傳： 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');
}

更新域名設定（Patch）

參數

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

回應

Returns: PatchDomainConfigResponse

範例

patchDomainConfig 範例

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 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');
}

設置域名設定（Put）

參數

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

回應

Returns: PutDomainConfigResponse

範例

putDomainConfig 範例

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 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	是

回應

返回: CreateEmailTemplateResponse

範例

createEmailTemplate 範例

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 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	是

回應

Returns: APIEmptyResponse

範例

deleteEmailTemplateRenderError 範例

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 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');
}

獲取郵件範本

Parameters

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

Response

返回： GetEmailTemplateResponse

範例

getEmailTemplate 範例

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 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';
// 取消註解以下以設置前綴 (例如 Bearer) 給 API 金鑰，如有需要
//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	是
id	string	path	是
skip	number	query	否

回應

返回： 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	Yes
skip	number	query	No

回應

返回： GetEmailTemplatesResponse

範例

getEmailTemplates 範例

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 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	是
locale	string	query	否

回應

返回：RenderEmailTemplateResponse

示例

renderEmailTemplate 範例

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 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	查詢	是
id	string	路徑	是

回應

返回：APIEmptyResponse

範例

updateEmailTemplate 範例

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 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	否

回應

Returns: GetEventLogResponse

範例

getEventLog 範例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // 字串 | 
final urlId = urlId_example; // 字串 | 
final userIdWS = userIdWS_example; // 字串 | 
final startTime = 789; // 整數 | 
final endTime = 789; // 整數 | 
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

參數

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

回應

Returns: CreateFeedPostResponse

範例

createFeedPostPublic 範例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final createFeedPostParams = CreateFeedPostParams(); // CreateFeedPostParams | 
final broadcastId = broadcastId_example; // String | 
final sso = sso_example; // String | 
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');
}

刪除資訊流貼文（公開）

參數

Name	Type	Location	Required
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');
}

獲取資訊流貼文

req tenantId afterId

參數

名稱	類型	位置	必填
tenantId	string	query	是
afterId	string	query	否
limit	integer	query	否
tags	array	query	否

回應

返回: GetFeedPostsResponse

範例

getFeedPosts 範例

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 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	否

回應

返回： 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: sno, isCrawler: isCrawler, includeUserInfo: includeUserInfo));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getFeedPostsPublic: $e\n');
}

獲取資訊流貼文統計

參數

Name	Type	Location	Required
tenantId	string	path	是
postIds	array	query	是
sso	string	query	否

回應

返回： 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	是
postIds	array	query	否
sso	string	query	否

回應

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

回應

返回: 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');
}

更新資訊流貼文

參數

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

回應

返回: APIEmptyResponse

範例

updateFeedPost 範例

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 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');
}

更新資訊流貼文（公開）

參數

名稱	類型	位置	必填
tenantId	string	path	是
postId	string	path	是
broadcastId	string	query	否
sso	string	query	否

回應

返回： CreateFeedPostResponse

範例

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	Yes
commentId	string	path	Yes
isFlagged	boolean	query	Yes
sso	string	query	No

回應

Returns: 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('呼叫 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	path	是
search	string	query	是
locale	string	query	否
rating	string	query	否
page	number	query	否

回應

返回: 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');
}

參數

名稱	類型	位置	必填
tenantId	string	path	是
locale	string	query	否
rating	string	query	否
page	number	query	否

回應

返回： 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');
}

新增標籤

參數

Name	Type	Location	Required	Description
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';
// 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 createHashTagBody = CreateHashTagBody(); // CreateHashTagBody | 
try {
    final result = api_instance.addHashTag(tenantId, createHashTagBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addHashTag: $e\n');
}

批量新增標籤

參數

Name	Type	Location	Required	Description
tenantId	string	query	Yes

回應

Returns: BulkCreateHashTagsResponse

範例

addHashTagsBulk 範例

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 bulkCreateHashTagsBody = BulkCreateHashTagsBody(); // BulkCreateHashTagsBody | 
try {
    final result = api_instance.addHashTagsBulk(tenantId, bulkCreateHashTagsBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addHashTagsBulk: $e\n');
}

刪除標籤

參數

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

回應

返回：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	是
page	number	query	否

回應

回傳: 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');
}

更新標籤（Patch）

參數

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

回應

回傳：UpdateHashTagResponse

範例

patchHashTag 範例

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 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	字串	查詢	是
commentId	字串	路徑	是
voteId	字串	路徑	是
broadcastId	字串	查詢	否
sso	字串	查詢	否

回應

返回： 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 評論

參數

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

參數

Name	Type	Location	Required
tenantId	string	query	是
text-search	string	query	否
byIPFromComment	string	query	否
filters	string	query	否
searchFilters	string	query	否
afterId	string	query	否
demo	boolean	query	否
sso	string	query	否

回應

Returns: 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');
}

獲取評論子項

參數

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

回應

返回： 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');
}

獲取計數

參數

名稱	類型	位置	必要
tenantId	string	query	是
text-search	string	query	否
byIPFromComment	string	query	否
filter	string	query	否
searchFilters	string	query	否
demo	boolean	query	否
sso	string	query	否

回應

回傳： 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');
}

獲取手動徽章

參數

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

範例

取得使用者手動徽章範例

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	是
commentId	string	path	是
includeEmail	boolean	query	否
includeIP	boolean	query	否
sso	string	query	否

回應

返回：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');
}

獲取審核評論文字

Parameters

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

Response

Returns: GetCommentTextResponse

Example

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	Yes
commentId	string	path	Yes
includeByUserIdAndEmail	boolean	query	No
includeByIP	boolean	query	No
includeByEmailDomain	boolean	query	No
sso	string	query	No

回應

返回： 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');
}

獲取搜尋評論摘要

Parameters

名稱	類型	位置	必填
tenantId	string	query	Yes
value	string	query	No
filters	string	query	No
searchFilters	string	query	No
sso	string	query	No

Response

Returns: ModerationCommentSearchResponse

Example

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');
}

獲取搜尋頁面

參數

名稱	類型	位置	必填
tenantId	string	query	是
value	string	query	否
sso	string	query	否

回應

Returns: 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	Yes
value	string	query	No
sso	string	query	No

回應

Returns: 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');
}

獲取搜尋建議

參數

Name	Type	Location	Required
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; // String | 
final textSearch = textSearch_example; // String | 
final sso = sso_example; // String | 
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	是
value	string	query	否
sso	string	query	否

回應

返回： 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');
}

獲取信任因子

參數

名稱	類型	位置	必填
tenantId	string	query	Yes
userId	string	query	No
sso	string	query	No

回應

返回： GetUserTrustFactorResponse

範例

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	Yes
commentId	string	query	No
sso	string	query	No

回應

返回： 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');
}

調整評論投票

Parameters

名稱	型別	位置	必填
tenantId	string	query	是
commentId	string	path	是
broadcastId	string	query	否
sso	string	query	否

Response

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

參數

Name	Type	Location	Required
tenantId	string	query	是
text-search	string	query	否
byIPFromComment	string	query	否
filters	string	query	否
searchFilters	string	query	否
sorts	string	query	否
sso	string	query	否

回應

返回： ModerationExportResponse

範例

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	Yes
commentId	string	path	Yes
banEmail	boolean	query	No
banEmailDomain	boolean	query	No
banIP	boolean	query	No
deleteAllUsersComments	boolean	query	No
bannedUntil	string	query	No
isShadowBan	boolean	query	No
updateId	string	query	No
banReason	string	query	No
sso	string	query	No

回應

返回：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	Yes
sso	string	query	No

回應

回傳: 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	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

回應

返回: 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');
}

移除評論

參數

Name	Type	Location	Required
tenantId	string	query	是
commentId	string	path	是
broadcastId	string	query	否
sso	string	query	否

回應

Returns: 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	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

回應

返回: 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	查詢	是
commentId	string	路徑	是
reviewed	boolean	查詢	否
broadcastId	string	查詢	否
sso	string	查詢	否

回應

返回： 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; // String | 
final commentId = commentId_example; // String | 
final setCommentTextParams = SetCommentTextParams(); // SetCommentTextParams | 
final broadcastId = broadcastId_example; // String | 
final sso = sso_example; // String | 
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	Yes
urlId	string	query	Yes
sso	string	query	No

回應

Returns: 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

回應

返回: 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');
}

刪除版主

參數

名稱	類型	位置	必需
tenantId	string	query	是
id	string	path	是
sendEmail	string	query	否

回應

Returns: APIEmptyResponse

範例

deleteModerator 範例

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 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	Yes
id	string	path	Yes

回應

Returns: GetModeratorResponse

範例

getModerator 範例

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 id = id_example; // String | 
try {
    final result = api_instance.getModerator(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getModerator: $e\n');
}

獲取所有版主

參數

Name	Type	Location	Required	Description
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';
// 如有需要，取消註解以下以設定 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.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';
// 取消註解以下以設定前綴（例如 Bearer）給 API 金鑰，如有需要
//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');
}

更新版主

參數

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

回應

返回： APIEmptyResponse

範例

updateModerator 範例

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

回應

Returns: APIEmptyResponse

範例

deleteNotificationCount 範例

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 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	Yes
id	string	path	Yes

回應

返回： GetCachedNotificationCountResponse

範例

取得快取通知計數範例

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 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	Yes
userId	string	query	No
urlId	string	query	No
fromCommentId	string	query	No
viewed	boolean	query	No
type	string	query	No

回應

返回：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	是
id	string	path	是
userId	string	query	否

回應

返回： APIEmptyResponse

範例

updateNotification 範例

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 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 頁面反應

參數

Name	Type	Location	Required
tenantId	string	path	Yes
urlId	string	query	Yes
title	string	query	No

回應

Returns: 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	是
urlId	string	query	是

回應

返回： 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	是
urlId	string	query	是
id	string	query	是

回應

返回: 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	是
urlId	string	query	是

回應

返回： 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 頁面反應

Parameters

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

Response

返回： GetV2PageReacts

Example

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	字串	路徑	是
urlId	字串	查詢	是
id	字串	查詢	是

回應

返回: GetV2PageReactUsersResponse

範例

getV2PageReactUsers 範例

Copy

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

新增頁面

參數

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

回應

返回：AddPageAPIResponse

範例

addPage 範例

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 createAPIPageData = CreateAPIPageData(); // CreateAPIPageData | 
try {
    final result = api_instance.addPage(tenantId, createAPIPageData);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addPage: $e\n');
}

刪除頁面

參數

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

回應

Returns: DeletePageAPIResponse

範例

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');
}

獲取離線使用者

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

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

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

Parameters

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

Returns: PageUsersOfflineResponse

Example

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');
}

獲取在線使用者

目前線上檢視頁面的使用者：指其 websocket 連線目前訂閱該頁面的使用者。回傳 anonCount + totalCount（整個房間的訂閱者數量，包含我們未列舉的匿名檢視者）。

Parameters

名稱	類型	位置	必填	說明
tenantId	string	path	Yes
urlId	string	query	Yes	頁面 URL 識別碼（伺服器端清理後）。
afterName	string	query	No	游標：從先前的回應傳遞 nextAfterName。
afterUserId	string	query	No	游標平局斷點：從先前的回應傳遞 nextAfterUserId。當 afterName 被設定時必填，以免名稱相同的情況導致條目遺失。

Response

Returns: 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 獲取頁面

Parameters

Name	Type	Location	Required	Description
tenantId	string	query	Yes
urlId	string	query	Yes

Response

返回： GetPageByURLIdAPIResponse

Example

getPageByURLId 範例

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 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	Yes

回應

返回： GetPagesAPIResponse

範例

getPages 範例

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 | 
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	是
cursor	string	query	否	先前請求返回的不透明分頁游標，作為 `nextCursor`。與相同的 `sortBy` 相關聯。
limit	integer	query	否	1..200，預設 50
q	string	query	否	可選的大小寫不敏感標題前綴過濾。
sortBy	string	query	否	排序依據。`updatedAt`（預設，最新優先），`commentCount`（評論數最多優先），或 `title`（字母順序）。
hasComments	boolean	query	否	若為 true，僅返回至少有一條評論的頁面。

Response

返回： 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，預設 50
final q = q_example; // String | 可選的大小寫不敏感標題前綴過濾。
final sortBy = ; // PagesSortBy | 排序依據。`updatedAt`（預設，最新優先），`commentCount`（評論數最多優先），或 `title`（字母順序）。
final hasComments = true; // bool | 若為 true，僅返回至少有一條評論的頁面。
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');
}

獲取使用者資訊

Bulk user info for a tenant. Given userIds, return display info from User / SSOUser.
Used by the comment widget to enrich users that just appeared via a presence event.
No page context: privacy is enforced uniformly (private profiles are masked).

Parameters

名稱	型別	位置	必填	說明
tenantId	string	path	Yes
ids	string	query	Yes	以逗號分隔的 userIds。

Response

回傳：PageUsersInfoResponse

Example

getUsersInfo 範例

Copy

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

更新頁面（Patch）

參數

名稱	類型	位置	必要	描述
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';
// 取消註解以下以設定前綴 (例如 Bearer) 給 API 金鑰，如有需要
//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 事件

Parameters

名稱	類型	位置	必須
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
skip	number	query	No

Response

返回: GetPendingWebhookEventsResponse

Example

getPendingWebhookEvents 範例

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 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	query	是

回應

返回： CreateQuestionConfigResponse

範例

createQuestionConfig 範例

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 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';
// 取消註解以下以設定前綴（例如 Bearer）給 API 金鑰，如有需要
//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	Yes
id	string	path	Yes

回應

返回: GetQuestionConfigResponse

範例

getQuestionConfig 範例

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 id = id_example; // String | 
try {
    final result = api_instance.getQuestionConfig(tenantId, id);
    print(result);
} catch (e) {
    // 呼叫 DefaultApi->getQuestionConfig 時的例外: $e\n
    print('Exception when calling DefaultApi->getQuestionConfig: $e\n');
}

---

獲取所有問題配置

參數

名稱	類型	位置	必填	描述
tenantId	string	query	是
skip	number	query	否

回應

返回: GetQuestionConfigsResponse

範例

getQuestionConfigs 範例

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 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';
// 取消註解以下以設定前綴（例如 Bearer）給 API 金鑰，如有需要
//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	是

回應

返回: CreateQuestionResultResponse

範例

createQuestionResult 範例

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

回應

Returns: GetQuestionResultResponse

範例

getQuestionResult 範例

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 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';
// 取消註解以下以設定前綴（例如 Bearer）給 API 金鑰，如有需要
//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');
}

更新問題結果

參數

Name	Type	Location	Required	Description
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';
// 取消註解以下以設定前綴 (例如 Bearer) 給 API 金鑰，如有需要
//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');
}

聚合問題結果

參數

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

回應

返回： AggregateQuestionResultsResponse

範例

aggregateQuestionResults 範例

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 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';
// 取消註解以下以設定前綴（例如 Bearer）給 API 金鑰，如有需要
//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 使用者

Parameters

Name	Type	Location	Required	Description
tenantId	string	query	Yes

Response

Returns: AddSSOUserAPIResponse

Example

addSSOUser 範例

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 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	Yes
id	string	path	Yes
deleteComments	boolean	query	No
commentDeleteMode	string	query	No

回應

回傳： DeleteSSOUserAPIResponse

範例

deleteSSOUser 範例

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

參數

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

回應

返回: GetSSOUserByEmailAPIResponse

範例

getSSOUserByEmail 範例

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 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	Yes
id	string	path	Yes

回應

返回：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 使用者

參數

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

回應

Returns: GetSSOUsersResponse

範例

getSSOUsers 示例

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 skip = 56; // int | 
try {
    final result = api_instance.getSSOUsers(tenantId, skip);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSSOUsers: $e\n');
}

更新 SSO 使用者（Patch）

參數

名稱	類型	位置	必填
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 使用者（Put）

參數

名稱	類型	位置	必要
tenantId	string	query	Yes
id	string	path	Yes
updateComments	boolean	query	No

回應

Returns: 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	是
userId	string	query	否

回應

返回：GetSubscriptionsAPIResponse

範例

取得訂閱範例

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 userId = userId_example; // String | 
try {
    final result = api_instance.getSubscriptions(tenantId, userId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSubscriptions: $e\n');
}

更新訂閱

Parameters

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

Response

返回： UpdateSubscriptionAPIResponse

範例

updateSubscription 範例

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 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');
}

獲取租戶每日使用量

參數

名稱	類型	位置	必填
tenantId	string	query	Yes
yearNumber	number	query	No
monthNumber	number	query	No
dayNumber	number	query	No
skip	number	query	No

回應

返回： GetTenantDailyUsagesResponse

範例

取得租戶每日使用情況範例

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';
// 取消註解以下以設定前綴（例如 Bearer）給 API 金鑰，如有需要
//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');
}

刪除租戶套件

Parameters

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

Response

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

範例

取得租戶套件範例

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	Yes
skip	number	query	No

回應

返回: 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	Yes
id	string	path	Yes

回應

返回：APIEmptyResponse

範例

replaceTenantPackage 範例

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 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');
}

更新租戶套件

參數

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

回應

返回： APIEmptyResponse

範例

updateTenantPackage 範例

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 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	Yes

回應

返回：CreateTenantUserResponse

示例

createTenantUser 範例

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 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';
// 取消註解以下行以設定前置詞（例如 Bearer）給 API 金鑰，如有需要
//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';
// 取消註解以下以設定前綴（例如 Bearer）給 API 金鑰，如有需要
//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');
}

獲取所有租戶使用者

參數

名稱	類型	位置	必填	描述
tenantId	string	query	Yes
skip	number	query	No

回應

返回: GetTenantUsersResponse

範例

getTenantUsers 範例

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
// 取消註解以下以設定前綴（例如 Bearer）給 API 金鑰，如有需要
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

回應

Returns: 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('呼叫 DefaultApi->replaceTenantUser 時發生例外: $e\n');
}

發送登入連結

參數

名稱	類型	位置	必填
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';
// 取消註解以下以設定前綴 (例如 Bearer) 給 API 金鑰，如有需要
//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	Yes
id	string	path	Yes
updateComments	string	query	No

回應

返回： APIEmptyResponse

範例

updateTenantUser 範例

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

回應

返回: CreateTenantResponse

範例

createTenant 範例

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 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';
// 取消註解以下以設定前綴 (例如 Bearer) 給 API 金鑰，如有需要
//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	是
id	string	path	是

回應

Returns: GetTenantResponse

範例

getTenant 範例

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 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	Yes
meta	string	query	No
skip	number	query	No

回應

Returns: GetTenantsResponse

範例

getTenants 範例

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 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';
// 取消註解以下以設定前綴（例如 Bearer）給 API 金鑰，如有需要
//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');
}

更改工單狀態

參數

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

回應

返回：ChangeTicketStateResponse

範例

changeTicketState 範例

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

回應

返回: CreateTicketResponse

範例

createTicket 範例

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 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	Yes
id	string	path	Yes
userId	string	query	No

回應

回傳: GetTicketResponse

範例

取得Ticket 範例

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

回應

返回: GetTicketsResponse

範例

getTickets 範例

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 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');
}

上傳圖片

上傳並調整圖像大小

參數

名稱	類型	位置	必要	描述
tenantId	string	path	Yes
sizePreset	string	query	No	尺寸預設: "Default" (1000x1000像素) 或 "CrossPlatform" (為流行裝置建立尺寸)
urlId	string	query	No	上傳發生的頁面 ID，用於配置

回應

Returns: UploadImageResponse

範例

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" (1000x1000像素) 或 "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	Yes
id	string	path	Yes

回應

返回: APIGetUserBadgeProgressResponse

範例

getUserBadgeProgressById 範例

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 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 獲取徽章進度

參數

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

回應

Returns: APIGetUserBadgeProgressResponse

範例

getUserBadgeProgressByUserId 範例

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

回應

Returns: APIGetUserBadgeProgressListResponse

範例

getUserBadgeProgressList 範例

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 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');
}

建立使用者徽章

Parameters

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

Response

返回: APICreateUserBadgeResponse

Example

createUserBadge 範例

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

Example

deleteUserBadge 範例

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 id = id_example; // String | 
try {
    final result = api_instance.deleteUserBadge(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteUserBadge: $e\n');
}

獲取使用者徽章

參數

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

回應

返回： APIGetUserBadgeResponse

範例

getUserBadge 範例

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 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	是
userId	string	query	否
badgeId	string	query	否
type	number	query	否
displayedOnComments	boolean	query	否
limit	number	query	否
skip	number	query	否

回應

返回： APIGetUserBadgesResponse

範例

getUserBadges 範例

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

回應

Returns: 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	Yes
urlId	string	query	No	用於判斷當前頁面是否已訂閱。
pageSize	integer	query	No
afterId	string	query	No
includeContext	boolean	query	No
afterCreatedAt	integer	query	No
unreadOnly	boolean	query	No
dmOnly	boolean	query	No
noDm	boolean	query	No
includeTranslations	boolean	query	No
includeTenantNotifications	boolean	query	No
sso	string	query	No

回傳

返回: 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');
}

重置使用者通知計數

參數

Name	Type	Location	Required	Description
tenantId	string	query	是
sso	string	query	否

回應

Returns: 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');
}

更新使用者評論訂閱狀態

為特定評論啟用或停用通知。

參數

名稱	類型	位置	必填
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');
}

更新使用者頁面訂閱狀態

Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also

Parameters

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

Response

返回： UpdateUserNotificationPageSubscriptionStatusResponse

Example

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	Yes
notificationId	string	path	Yes
newStatus	string	path	Yes
sso	string	query	No

回應

Returns: 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	是
urlIdWS	string	query	是
userIds	string	query	是

回應

返回： 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');
}

搜尋使用者

Parameters

Name	Type	Location	Required
tenantId	string	path	Yes
urlId	string	query	Yes
usernameStartsWith	string	query	No
mentionGroupIds	array	query	No
sso	string	query	No
searchSection	string	query	No

Response

返回: SearchUsersResult

Example

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');
}

獲取使用者

參數

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

回應

Returns: GetUserResponse

範例

getUser 範例

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 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	Yes
commentId	string	query	Yes
direction	string	query	Yes
userId	string	query	No
anonUserId	string	query	No

回應

返回： VoteResponse

範例

createVote 範例

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 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	是
id	string	path	是
editKey	string	query	否

回應

返回: VoteDeleteResponse

範例

deleteVote 範例

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 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';
// 取消註解以下以設定前綴（例如 Bearer）給 API 金鑰，如有需要
//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';
// 取消註解以下代碼以設定前綴（例如 Bearer）給 API 金鑰，如有需要
//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

Repository

佈局

使用

單點登入

聚合

Parameters

Response

Example

取得審計日誌

參數

回應

範例

登出（公開）

回應

範例

從評論封鎖（公開）

參數

回應

範例

解除評論封鎖（公開）

參數

回應

範例

檢查被封鎖的評論

參數

回應

範例

從評論封鎖使用者

參數

回應

範例

創建評論（公開）

參數

回應

示例

刪除評論

參數