FastComments Dart SDK

这是 FastComments 官方的 Dart SDK。

在您的 Dart 和 Flutter 应用程序中管理评论、用户、单点登录（SSO）和审核。

仓库

布局

fastcomments-dart/
  client/        generated dart client (do not edit by hand)
  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();

聚合

聚合文档，通过对其进行分组（如果提供了 groupBy）并应用多个操作来实现。支持不同的操作（例如 sum、countDistinct、avg 等）。

参数

名称	类型	位置	必填
tenantId	string	query	是
parentTenantId	string	query	否
includeStats	boolean	query	否

返回： AggregateResponse

示例

聚合示例

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

响应

返回：UnblockSuccess

示例

unBlockCommentPublic 示例

Copy

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

检查已屏蔽评论

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
commentIds	string	query	是	以逗号分隔的评论 ID 列表。
sso	string	query	否

响应

Returns: CheckBlockedCommentsResponse

示例

checkedCommentsForBlocked 示例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final commentIds = commentIds_example; // String | 以逗号分隔的评论 ID 列表。
final sso = sso_example; // String | 
try {
    final result = api_instance.checkedCommentsForBlocked(tenantId, commentIds, sso);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->checkedCommentsForBlocked: $e\n');
}

屏蔽用户评论

参数

名称	类型	位置	必填
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No
anonUserId	string	query	No

响应

返回: BlockSuccess

示例

blockUserFromComment 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下内容以在需要时为 API 密钥设置前缀（例如 Bearer）
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final blockFromCommentParams = BlockFromCommentParams(); // BlockFromCommentParams | 
final userId = userId_example; // String | 
final anonUserId = anonUserId_example; // String | 
try {
    final result = api_instance.blockUserFromComment(tenantId, id, blockFromCommentParams, BlockUserFromCommentOptions(userId: userId, anonUserId: anonUserId));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->blockUserFromComment: $e\n');
}

创建公共评论

参数

名称	类型	位置	必需
tenantId	string	path	是
urlId	string	query	是
broadcastId	string	query	是
sessionId	string	query	否
sso	string	query	否

响应

返回： SaveCommentsResponseWithPresence

示例

createCommentPublic 示例

Copy

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

删除评论

参数

名称	类型	位置	必需
tenantId	string	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	是
commentId	string	path	是
broadcastId	string	query	是
editKey	string	query	否
sso	string	query	否

响应

返回：PublicAPIDeleteCommentResponse

示例

deleteCommentPublic 示例

Copy

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

删除评论投票

参数

名称	类型	位置	必填
tenantId	string	path	是
commentId	string	path	是
voteId	string	path	是
urlId	string	query	是
broadcastId	string	query	是
editKey	string	query	否
sso	string	query	否

响应

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

示例

获取评论示例

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 page = 56; // int | 
final limit = 56; // int | 
final skip = 56; // int | 
final asTree = true; // bool | 
final skipChildren = 56; // int | 
final limitChildren = 56; // int | 
final maxTreeDepth = 56; // int | 
final urlId = urlId_example; // String | 
final userId = userId_example; // String | 
final anonUserId = anonUserId_example; // String | 
final contextUserId = contextUserId_example; // String | 
final hashTag = hashTag_example; // String | 
final parentId = parentId_example; // String | 
final direction = ; // SortDirections | 
final fromDate = 789; // int | 
final toDate = 789; // int | 
try {
    final result = api_instance.getComments(tenantId, GetCommentsOptions(page: page, limit: limit, skip: skip, asTree: asTree, skipChildren: skipChildren, limitChildren: limitChildren, maxTreeDepth: maxTreeDepth, urlId: urlId, userId: userId, anonUserId: anonUserId, contextUserId: contextUserId, hashTag: hashTag, parentId: parentId, direction: direction, fromDate: fromDate, toDate: toDate));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getComments: $e\n');
}

获取公共评论

req
tenantId
urlId

参数

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

响应

返回：GetCommentsResponseWithPresencePublicComment

示例

getCommentsPublic 示例

Copy

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

获取评论文本

参数

名称	类型	位置	必需
tenantId	string	path	是
commentId	string	path	是
editKey	string	query	否
sso	string	query	否

响应

返回: PublicAPIGetCommentTextResponse

示例

getCommentText 示例

Copy

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

获取评论投票用户名

参数

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

锁定评论

参数

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

响应

返回: APIEmptyResponse

示例

lockComment 示例

Copy

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

置顶评论

参数

名称	类型	位置	必填
tenantId	string	path	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
sso	string	query	No

响应

返回：ChangeCommentPinStatusResponse

示例

pinComment 示例

Copy

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

保存评论

参数

名称	类型	位置	必填
tenantId	string	query	是
isLive	boolean	query	否
doSpamCheck	boolean	query	否
sendEmails	boolean	query	否
populateNotifications	boolean	query	否

响应

返回： APISaveCommentResponse

示例

saveComment 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下代码以设置前缀（例如 Bearer），如果需要
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createCommentParams = CreateCommentParams(); // CreateCommentParams | 
final isLive = true; // bool | 
final doSpamCheck = true; // bool | 
final sendEmails = true; // bool | 
final populateNotifications = true; // bool | 
try {
    final result = api_instance.saveComment(tenantId, createCommentParams, SaveCommentOptions(isLive: isLive, doSpamCheck: doSpamCheck, sendEmails: sendEmails, populateNotifications: populateNotifications));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->saveComment: $e\n');
}

批量保存评论

参数

名称	类型	位置	必需
tenantId	string	query	Yes
isLive	boolean	query	No
doSpamCheck	boolean	query	No
sendEmails	boolean	query	No
populateNotifications	boolean	query	No

响应

返回: SaveCommentsBulkResponse

示例

saveCommentsBulk 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下内容以设置前缀（例如 Bearer）用于 API 密钥，如有需要
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createCommentParams = [List<CreateCommentParams>()]; // List<CreateCommentParams> | 
final isLive = true; // bool | 
final doSpamCheck = true; // bool | 
final sendEmails = true; // bool | 
final populateNotifications = true; // bool | 
try {
    final result = api_instance.saveCommentsBulk(tenantId, createCommentParams, SaveCommentsBulkOptions(isLive: isLive, doSpamCheck: doSpamCheck, sendEmails: sendEmails, populateNotifications: populateNotifications));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->saveCommentsBulk: $e\n');
}

设置评论文本

参数

名称	类型	位置	必需
tenantId	string	path	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
editKey	string	query	No
sso	string	query	No

响应

返回： PublicAPISetCommentTextResponse

示例

setCommentText 示例

Copy

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

取消用户评论屏蔽

参数

名称	类型	位置	必填
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No
anonUserId	string	query	No

响应

返回：UnblockSuccess

示例

unBlockUserFromComment 示例

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

响应

Returns: FlagCommentResponse

示例

unFlagComment 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下代码以为 API 密钥设置前缀（例如 Bearer），如果需要
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final userId = userId_example; // String | 
final anonUserId = anonUserId_example; // String | 
try {
    final result = api_instance.unFlagComment(tenantId, id, UnFlagCommentOptions(userId: userId, anonUserId: anonUserId));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->unFlagComment: $e\n');
}

解除锁定评论

参数

名称	类型	位置	必需
tenantId	string	path	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
sso	string	query	No

响应

返回： APIEmptyResponse

示例

unLockComment 示例

Copy

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

取消置顶评论

参数

名称	类型	位置	必需
tenantId	string	path	是
commentId	string	path	是
broadcastId	string	query	是
sso	string	query	否

响应

返回： 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	查询	是
id	string	路径	是
contextUserId	string	查询	否
doSpamCheck	boolean	查询	否
isLive	boolean	查询	否

响应

返回：APIEmptyResponse

示例

updateComment 示例

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

响应

返回: VoteResponse

示例

voteComment 示例

Copy

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

获取用户的评论

参数

名称	类型	位置	必填
userId	string	query	否
direction	string	query	否
repliesToUserId	string	query	否
page	number	query	否
includei10n	boolean	query	否
locale	string	query	否
isCrawler	boolean	query	否

响应

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

响应

返回: AddDomainConfigResponse

示例

addDomainConfig 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下内容以为 API 密钥设置前缀（例如 Bearer），如果需要
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final addDomainConfigParams = AddDomainConfigParams(); // AddDomainConfigParams | 
try {
    final result = api_instance.addDomainConfig(tenantId, addDomainConfigParams);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addDomainConfig: $e\n');
}

删除域配置

参数

名称	类型	位置	必填	描述
tenantId	string	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	Yes
domain	string	path	Yes

响应

返回: GetDomainConfigResponse

示例

getDomainConfig 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 解开下面的注释以设置前缀（例如 Bearer），如果需要的话
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final domain = domain_example; // String | 
try {
    final result = api_instance.getDomainConfig(tenantId, domain);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getDomainConfig: $e\n');
}

获取域配置列表

参数

名称	类型	位置	必填	描述
tenantId	string	query	是

响应

返回: GetDomainConfigsResponse

示例

getDomainConfigs 示例

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

更新域配置（PATCH）

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
domainToUpdate	string	path	是

响应

Returns: PatchDomainConfigResponse

示例

patchDomainConfig 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下内容以为 API 密钥设置前缀（例如 Bearer），如果需要
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final domainToUpdate = domainToUpdate_example; // String | 
final patchDomainConfigParams = PatchDomainConfigParams(); // PatchDomainConfigParams | 
try {
    final result = api_instance.patchDomainConfig(tenantId, domainToUpdate, patchDomainConfigParams);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->patchDomainConfig: $e\n');
}

替换域配置（PUT）

参数

名称	类型	位置	必填	描述
tenantId	string	query	Yes
domainToUpdate	string	path	Yes

响应

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

删除邮件模板

参数

Name	Type	Location	Required	Description
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	Yes
id	string	path	Yes
errorId	string	path	Yes

响应

返回： APIEmptyResponse

示例

deleteEmailTemplateRenderError 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权：api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下内容以设置 API 密钥的前缀（例如 Bearer），如果需要
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final errorId = errorId_example; // String | 
try {
    final result = api_instance.deleteEmailTemplateRenderError(tenantId, id, errorId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteEmailTemplateRenderError: $e\n');
}

获取邮件模板

参数

名称	类型	位置	必填	描述
tenantId	string	query	Yes
id	string	path	Yes

响应

返回： GetEmailTemplateResponse

示例

getEmailTemplate 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下内容，以在需要时为 API 密钥设置前缀 (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 | 
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	Yes
id	string	path	Yes
skip	number	query	No

响应

返回: GetEmailTemplateRenderErrorsResponse

示例

getEmailTemplateRenderErrors 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释下面以设置前缀（例如 Bearer）用于 API 密钥（如果需要）
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final skip = 1.2; // double | 
try {
    final result = api_instance.getEmailTemplateRenderErrors(tenantId, id, skip);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getEmailTemplateRenderErrors: $e\n');
}

获取邮件模板列表

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
skip	number	query	否

响应

返回： GetEmailTemplatesResponse

示例

getEmailTemplates 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释下面以设置前缀（例如 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	query	Yes
id	string	path	Yes

响应

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

响应

返回: GetEventLogResponse

示例

getEventLog 示例

Copy

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

获取全局事件日志

请求 tenantId urlId userIdWS

参数

名称	类型	位置	必需
tenantId	string	路径	是
urlId	string	查询	是
userIdWS	string	查询	是
startTime	integer	查询	是
endTime	integer	查询	否

响应

返回: 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	是
broadcastId	string	query	否
isLive	boolean	query	否
doSpamCheck	boolean	query	否
skipDupCheck	boolean	query	否

响应

返回: CreateFeedPostResponse

示例

createFeedPost 示例

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

创建公共信息流帖子

参数

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

删除公共信息流帖子

参数

名称	类型	位置	必填
tenantId	string	path	Yes
postId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

响应

Returns: 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';
// 取消注释以下代码以为 API 密钥设置前缀（例如 Bearer），如果需要的话
//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');
}

获取公共信息流帖子

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

获取信息流帖子统计

参数

名称	类型	位置	必填
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	是
postId	string	path	是
isUndo	boolean	query	否
broadcastId	string	query	否
sso	string	query	否

响应

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

响应

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

响应

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

标记公共评论

参数

Name	Type	Location	Required
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('Exception when calling PublicApi->flagCommentPublic: $e\n');
}

获取大尺寸GIF

参数

名称	类型	位置	必填	描述
tenantId	string	path	Yes
largeInternalURLSanitized	string	query	Yes

响应

返回: 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	Yes
search	string	query	Yes
locale	string	query	No
rating	string	query	No
page	number	query	No

响应

返回: GetGifsSearchResponse

示例

getGifsSearch 示例

Copy

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

获取热门GIF

参数

名称	类型	位置	必填
tenantId	string	path	是
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	是

响应

Returns: CreateHashTagResponse

示例

addHashTag 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下内容以为 API 密钥设置前缀（例如 Bearer），如果需要
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createHashTagBody = CreateHashTagBody(); // CreateHashTagBody | 
try {
    final result = api_instance.addHashTag(tenantId, createHashTagBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addHashTag: $e\n');
}

批量添加标签

参数

名称	类型	位置	必需	描述
tenantId	string	query	是

响应

返回：BulkCreateHashTagsResponse

示例

addHashTagsBulk 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权：api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下行以为 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';
// 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 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	是
tag	string	path	是

响应

返回: UpdateHashTagResponse

示例

patchHashTag 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权：api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下代码以设置前缀（例如 Bearer），如果需要的话
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final tag = tag_example; // String | 
final updateHashTagBody = UpdateHashTagBody(); // UpdateHashTagBody | 
try {
    final result = api_instance.patchHashTag(tenantId, tag, updateHashTagBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->patchHashTag: $e\n');
}

删除审核投票

参数

名称	类型	位置	必需
tenantId	string	query	Yes
commentId	string	path	Yes
voteId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

响应

返回: VoteDeleteResponse

示例

deleteModerationVote 示例

Copy

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

获取API评论

参数

名称	类型	位置	必填
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	是
batchJobId	string	query	否
sso	string	query	否

响应

返回： ModerationExportStatusResponse

示例

getApiExportStatus 示例

Copy

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

获取API ID

参数

名称	类型	位置	必填
tenantId	string	query	是
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	Yes
commentId	string	path	Yes
sso	string	query	No

响应

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

响应

返回: GetCommentBanStatusResponse

示例

getCommentBanStatus 示例

Copy

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

获取子评论

参数

名称	类型	位置	必需
tenantId	string	query	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; // 字符串 | 
final sso = sso_example; // 字符串 | 
try {
    final result = api_instance.getCounts(tenantId, sso);
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->getCounts: $e\n');
}

获取日志

参数

名称	类型	位置	必需
tenantId	string	query	是
commentId	string	path	是
sso	string	query	否

响应

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

响应

返回： GetTenantManualBadgesResponse

示例

getManualBadges 示例

Copy

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

获取用户手动徽章

参数

名称	类型	位置	必填
tenantId	string	query	Yes
badgesUserId	string	query	No
commentId	string	query	No
sso	string	query	No

响应

返回: GetUserManualBadgesResponse

示例

getManualBadgesForUser 示例

Copy

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

获取审核评论

参数

名称	类型	位置	必填
tenantId	string	query	是
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');
}

获取审核评论文本

参数

名称	类型	位置	必填
tenantId	string	query	是
commentId	string	path	是
sso	string	query	否

响应

返回：GetCommentTextResponse

示例

getModerationCommentText 示例

Copy

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

获取预封禁摘要

参数

名称	类型	位置	必需
tenantId	string	query	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');
}

获取搜索评论摘要

参数

名称	类型	位置	必填
tenantId	string	query	是
value	string	query	否
filters	string	query	否
searchFilters	string	query	否
sso	string	query	否

响应

返回: ModerationCommentSearchResponse

示例

getSearchCommentsSummary 示例

Copy

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

获取搜索页面

参数

名称	类型	位置	必需
tenantId	string	query	Yes
value	string	query	No
sso	string	query	No

响应

返回: ModerationPageSearchResponse

示例

getSearchPages 示例

Copy

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

获取搜索站点

参数

名称	类型	位置	必需
tenantId	string	query	是
value	string	query	否
sso	string	query	否

响应

返回： ModerationSiteSearchResponse

示例

getSearchSites 示例

Copy

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

获取搜索建议

参数

名称	类型	位置	必需
tenantId	string	query	是
text-search	string	query	否
sso	string	query	否

响应

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

响应

返回： GetUserTrustFactorResponse

示例

获取信任因子示例

Copy

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

获取用户封禁偏好

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
sso	string	query	否

响应

返回： APIModerateGetUserBanPreferencesResponse

示例

getUserBanPreference 示例

Copy

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

获取用户内部资料

参数

名称	类型	位置	必需
tenantId	string	query	是
commentId	string	query	否
sso	string	query	否

响应

返回： GetUserInternalProfileResponse

示例

getUserInternalProfile 示例

Copy

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

调整评论投票

参数

名称	类型	位置	必填
tenantId	string	query	是
commentId	string	path	是
broadcastId	string	query	否
sso	string	query	否

响应

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

参数

名称	类型	位置	必填
tenantId	string	query	Yes
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
sorts	string	query	No
sso	string	query	No

响应

返回: 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	是
commentId	string	path	是
banEmail	boolean	query	否
banEmailDomain	boolean	query	否
banIP	boolean	query	否
deleteAllUsersComments	boolean	query	否
bannedUntil	string	query	否
isShadowBan	boolean	query	否
updateId	string	query	否
banReason	string	query	否
sso	string	query	否

响应

返回: BanUserFromCommentResult

示例

postBanUserFromComment 示例

Copy

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

撤销用户封禁

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
sso	string	query	否

响应

返回：APIEmptyResponse

示例

postBanUserUndo 示例

Copy

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

批量预封禁摘要

参数

名称	类型	位置	必需
tenantId	string	query	Yes
includeByUserIdAndEmail	boolean	query	No
includeByIP	boolean	query	No
includeByEmailDomain	boolean	query	No
sso	string	query	No

响应

返回: BulkPreBanSummary

示例

postBulkPreBanSummary 示例

Copy

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

按ID获取评论

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
sso	string	query	否

响应

返回： ModerationAPIChildCommentsResponse

示例

postCommentsByIds 示例

Copy

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

标记评论

参数

名称	类型	位置	必填
tenantId	string	query	是
commentId	string	path	是
broadcastId	string	query	否
sso	string	query	否

响应

返回： APIEmptyResponse

示例

postFlagComment 示例

Copy

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

删除评论

参数

名称	类型	位置	必需
tenantId	string	query	是
commentId	string	path	是
broadcastId	string	query	否
sso	string	query	否

响应

返回： PostRemoveCommentApiResponse

示例

postRemoveComment 示例

Copy

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

恢复已删除评论

参数

名称	类型	位置	必填
tenantId	string	query	是
commentId	string	path	是
broadcastId	string	query	否
sso	string	query	否

响应

返回: APIEmptyResponse

示例

postRestoreDeletedComment 示例

Copy

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

设置评论批准状态

参数

名称	类型	位置	必填
tenantId	string	query	是
commentId	string	path	是
approved	boolean	query	否
broadcastId	string	query	否
sso	string	query	否

响应

返回： SetCommentApprovedResponse

示例

postSetCommentApprovalStatus 示例

Copy

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

设置评论审查状态

参数

名称	类型	位置	必填
tenantId	string	query	Yes
commentId	string	path	Yes
reviewed	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

响应

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

响应

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

响应

返回: 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	是
badgeId	string	query	是
userId	string	query	否
commentId	string	query	否
broadcastId	string	query	否
sso	string	query	否

响应

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

响应

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

响应

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

响应

返回： 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';
// 取消注释以下代码以设置前缀（例如 Bearer）用于 API 密钥（如有需要）
//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	Yes
id	string	path	Yes
sendEmail	string	query	No

响应

返回： APIEmptyResponse

示例

deleteModerator 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权：api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下行以设置 API 密钥的前缀（例如 Bearer），如果需要
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final sendEmail = sendEmail_example; // String | 
try {
    final result = api_instance.deleteModerator(tenantId, id, sendEmail);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteModerator: $e\n');
}

获取版主

Parameters

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

Response

返回: GetModeratorResponse

Example

getModerator 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下以设置前缀（例如 Bearer）用于 API 密钥（如果需要）
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.getModerator(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getModerator: $e\n');
}

获取版主列表

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
skip	number	query	否

响应

Returns: GetModeratorsResponse

示例

getModerators 示例

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.getModerators(tenantId, skip);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getModerators: $e\n');
}

发送邀请

参数

名称	类型	位置	必需
tenantId	string	query	是
id	string	path	是
fromName	string	query	是

响应

Returns: APIEmptyResponse

示例

sendInvite 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下行以设置 API 密钥的前缀（例如 Bearer），如果需要
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final fromName = fromName_example; // String | 
try {
    final result = api_instance.sendInvite(tenantId, id, fromName);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->sendInvite: $e\n');
}

更新版主

参数

名称	类型	位置	必需	描述
tenantId	string	query	Yes
id	string	path	Yes

响应

返回： APIEmptyResponse

示例

updateModerator 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权：api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释下面以为 API 密钥设置前缀（例如 Bearer），如果需要的话
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateModeratorBody = UpdateModeratorBody(); // UpdateModeratorBody | 
try {
    final result = api_instance.updateModerator(tenantId, id, updateModeratorBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateModerator: $e\n');
}

删除通知计数

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
id	string	path	是

响应

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

示例

getCachedNotificationCount 示例

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

响应

Returns: 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页面反应

参数

名称	类型	位置	必需
tenantId	string	path	是
urlId	string	query	是
title	string	query	否

响应

返回：CreateV1PageReact

示例

createV1PageReact 示例

Copy

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

创建V2页面反应

参数

名称	类型	位置	必需
tenantId	string	path	是
urlId	string	query	是
id	string	query	是
title	string	query	否

响应

返回: CreateV1PageReact

示例

createV2PageReact 示例

Copy

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

删除V1页面反应

参数

名称	类型	位置	必填	描述
tenantId	string	path	是
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页面反应

参数

名称	类型	位置	必需	描述
tenantId	string	path	是
urlId	string	query	是

响应

返回： GetV2PageReacts

示例

getV2PageReacts 示例

Copy

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

获取V2页面反应用户

参数

名称	类型	位置	必填
tenantId	string	path	Yes
urlId	string	query	Yes
id	string	query	Yes

响应

返回: GetV2PageReactUsersResponse

示例

getV2PageReactUsers 示例

Copy

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

添加页面

参数

名称	类型	位置	必填	描述
tenantId	string	query	是

响应

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

删除页面

参数

名称	类型	位置	必填	描述
tenantId	string	query	Yes
id	string	path	Yes

响应

返回: 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 向前遍历部分 {tenantId, urlId, commenterName} 索引，使用 $gt，且没有 $skip 成本。

参数

Name	Type	Location	Required	Description
tenantId	string	path	Yes
urlId	string	query	Yes	页面 URL 标识符（服务器端已清理）。
afterName	string	query	No	游标：传递上一次响应中的 nextAfterName。
afterUserId	string	query	No	游标平局破局器：传递上一次响应中的 nextAfterUserId。当设置 afterName 时必须提供，以防止名称平局导致条目被丢弃。

响应

返回：PageUsersOfflineResponse

示例

getOfflineUsers 示例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final urlId = urlId_example; // String | 页面 URL 标识符（服务器端已清理）。
final afterName = afterName_example; // String | 游标：传递上一次响应中的 nextAfterName。
final afterUserId = afterUserId_example; // String | 游标平局破局器：传递上一次响应中的 nextAfterUserId。当设置 afterName 时必须提供，以防止名称平局导致条目被丢弃。
try {
    final result = api_instance.getOfflineUsers(tenantId, urlId, GetOfflineUsersOptions(afterName: afterName, afterUserId: afterUserId));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getOfflineUsers: $e\n');
}

获取在线用户

当前页面的实时在线观众：指其 websocket 会话当前已订阅该页面的用户。
返回 anonCount + totalCount（整个房间的订阅者，包括我们不枚举的匿名观众）。

参数

名称	类型	位置	必需	描述
tenantId	string	path	Yes
urlId	string	query	Yes	页面 URL 标识符（服务器端清理后）。
afterName	string	query	No	游标：传递上一次响应中的 nextAfterName。
afterUserId	string	query	No	游标的平局解决器：传递上一次响应中的 nextAfterUserId。当 afterName 被设置时必须提供，以防止名称平局导致条目丢失。

响应

Returns: PageUsersOnlineResponse

示例

getOnlineUsers 示例

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String |
final urlId = urlId_example; // String | 页面 URL 标识符（服务器端清理后）。
final afterName = afterName_example; // String | 游标：传递上一次响应中的 nextAfterName。
final afterUserId = afterUserId_example; // String | 游标的平局解决器：传递上一次响应中的 nextAfterUserId。当 afterName 被设置时必须提供，以防止名称平局导致条目丢失。
try {
    final result = api_instance.getOnlineUsers(tenantId, urlId, GetOnlineUsersOptions(afterName: afterName, afterUserId: afterUserId));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getOnlineUsers: $e\n');
}

通过URL ID获取页面

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
urlId	string	query	是

响应

返回： GetPageByURLIdAPIResponse

示例

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

获取公共页面

列出租户的页面

用于 FChat 桌面客户端填充其房间列表。
需要在每个页面的解析自定义配置中将 enableFChat 设置为 true。
需要 SSO 的页面会根据请求用户的组访问权限进行过滤。

参数

名称	类型	位置	必需	描述
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，仅返回至少有一条评论的页面。

响应

返回: GetPublicPagesResponse

示例

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

获取用户信息

批量获取租户的用户信息。根据 userIds，返回来自 User / SSOUser 的显示信息。
由评论小部件使用，以在用户通过 Presence 事件刚出现时丰富其信息。
无页面上下文：隐私统一强制执行（私人资料会被遮蔽）。

Parameters

名称	类型	位置	必填	描述
tenantId	string	path	是
ids	string	query	是	逗号分隔的 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';
// 取消注释下方以为 API 密钥设置前缀（例如 Bearer），如有需要
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateAPIPageData = UpdateAPIPageData(); // UpdateAPIPageData | 
try {
    final result = api_instance.patchPage(tenantId, id, updateAPIPageData);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->patchPage: $e\n');
}

删除待处理Webhook事件

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
id	string	path	是

响应

Returns: 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事件计数

参数

名称	类型	位置	必填
tenantId	string	query	Yes
commentId	string	query	No
externalId	string	query	No
eventType	string	query	No
type	string	query	No
domain	string	query	No
attemptCountGT	number	query	No

响应

返回: GetPendingWebhookEventCountResponse

示例

getPendingWebhookEventCount 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下行以为 API 密钥设置前缀（例如 Bearer），如有需要
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final externalId = externalId_example; // String | 
final eventType = eventType_example; // String | 
final type = type_example; // String | 
final domain = domain_example; // String | 
final attemptCountGT = 1.2; // double | 
try {
    final result = api_instance.getPendingWebhookEventCount(tenantId, GetPendingWebhookEventCountOptions(commentId: commentId, externalId: externalId, eventType: eventType, type: type, domain: domain, attemptCountGT: attemptCountGT));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPendingWebhookEventCount: $e\n');
}

获取待处理Webhook事件

参数

名称	类型	位置	必填
tenantId	string	query	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

响应

返回: GetPendingWebhookEventsResponse

示例

获取待处理Webhook事件示例

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	Yes

响应

返回: CreateQuestionConfigResponse

示例

createQuestionConfig 示例

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

删除问题配置

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
id	string	path	是

响应

返回: APIEmptyResponse

示例

deleteQuestionConfig 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下代码以为 API 密钥设置前缀（例如 Bearer），如果需要的话
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.deleteQuestionConfig(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteQuestionConfig: $e\n');
}

获取问题配置

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
id	string	path	是

响应

返回: GetQuestionConfigResponse

示例

getQuestionConfig 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下内容以设置前缀（例如 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) {
    print('Exception when calling DefaultApi->getQuestionConfig: $e\n');
}

获取问题配置列表

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
skip	number	query	否

响应

Returns: GetQuestionConfigsResponse

示例

getQuestionConfigs 示例

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.getQuestionConfigs(tenantId, skip);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getQuestionConfigs: $e\n');
}

更新问题配置

Parameters

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

Response

Returns: APIEmptyResponse

Example

updateQuestionConfig 示例

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

响应

返回：CreateQuestionResultResponse

示例

createQuestionResult 示例

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

删除问题结果

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
id	string	path	是

响应

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

响应

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

更新问题结果

参数

名称	类型	位置	必填	描述
tenantId	string	query	Yes
id	string	path	Yes

响应

返回：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	Yes
questionId	string	query	No
questionIds	array	query	No
urlId	string	query	No
timeBucket	string	query	No
startDate	string	query	No
forceRecalculate	boolean	query	No

响应

返回： AggregateQuestionResultsResponse

示例

aggregateQuestionResults 示例

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 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	Yes
forceRecalculate	boolean	query	No

响应

返回: BulkAggregateQuestionResultsResponse

示例

bulkAggregateQuestionResults 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下代码以在需要时为 API 密钥设置前缀（例如 Bearer）
#//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final bulkAggregateQuestionResultsRequest = BulkAggregateQuestionResultsRequest(); // BulkAggregateQuestionResultsRequest | 
final forceRecalculate = true; // bool | 
try {
    final result = api_instance.bulkAggregateQuestionResults(tenantId, bulkAggregateQuestionResultsRequest, forceRecalculate);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->bulkAggregateQuestionResults: $e\n');
}

将评论与问题结果组合

参数

名称	类型	位置	必填
tenantId	string	query	是
questionId	string	query	否
questionIds	array	query	否
urlId	string	query	否
startDate	string	query	否
forceRecalculate	boolean	query	否
minValue	number	query	否
maxValue	number	query	否
limit	number	query	否

响应

返回： CombineQuestionResultsWithCommentsResponse

示例

combineCommentsWithQuestionResults 示例

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 questionId = questionId_example; // String | 
final questionIds = []; // List<String> | 
final urlId = urlId_example; // String | 
final startDate = 2013-10-20T19:20:30+01:00; // DateTime | 
final forceRecalculate = true; // bool | 
final minValue = 1.2; // double | 
final maxValue = 1.2; // double | 
final limit = 1.2; // double | 
try {
    final result = api_instance.combineCommentsWithQuestionResults(tenantId, CombineCommentsWithQuestionResultsOptions(questionId: questionId, questionIds: questionIds, urlId: urlId, startDate: startDate, forceRecalculate: forceRecalculate, minValue: minValue, maxValue: maxValue, limit: limit));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->combineCommentsWithQuestionResults: $e\n');
}

添加SSO用户

参数

名称	类型	位置	必需	描述
tenantId	string	query	Yes

响应

返回： AddSSOUserAPIResponse

示例

addSSOUser 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下内容以为 API 密钥设置前缀（例如 Bearer），如有需要
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createAPISSOUserData = CreateAPISSOUserData(); // CreateAPISSOUserData | 
try {
    final result = api_instance.addSSOUser(tenantId, createAPISSOUserData);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addSSOUser: $e\n');
}

删除SSO用户

参数

名称	类型	位置	必填
tenantId	string	query	是
id	string	path	是
deleteComments	boolean	query	否
commentDeleteMode	string	query	否

响应

返回： DeleteSSOUserAPIResponse

示例

deleteSSOUser 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释下面以设置前缀（例如 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用户

参数

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

响应

返回： GetSSOUserByIdAPIResponse

示例

getSSOUserById 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释下面以设置前缀（例如 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.getSSOUserById(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSSOUserById: $e\n');
}

获取SSO用户列表

参数

名称	类型	位置	必需	描述
tenantId	string	query	Yes
skip	integer	query	No

响应

返回: GetSSOUsersResponse

示例

getSSOUsers 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下内容以为 API 密钥设置前缀（例如 Bearer），如果需要的话
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final skip = 56; // int | 
try {
    final result = api_instance.getSSOUsers(tenantId, skip);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSSOUsers: $e\n');
}

更新SSO用户（PATCH）

参数

名称	类型	位置	必填
tenantId	string	query	是
id	string	path	是
updateComments	boolean	query	否

响应

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

响应

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

响应

返回： DeleteSubscriptionAPIResponse

示例

deleteSubscription 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释下面以设置前缀（例如 Bearer），如果需要的话
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String |
final id = id_example; // String |
final userId = userId_example; // String |
try {
    final result = api_instance.deleteSubscription(tenantId, id, userId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteSubscription: $e\n');
}

获取订阅列表

参数

名称	类型	位置	必需	描述
tenantId	string	query	Yes
userId	string	query	No

响应

返回: GetSubscriptionsAPIResponse

示例

获取订阅示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下内容以为 API 密钥设置前缀（例如 Bearer），如果需要
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final userId = userId_example; // String | 
try {
    final result = api_instance.getSubscriptions(tenantId, userId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSubscriptions: $e\n');
}

更新订阅

参数

名称	类型	位置	必需
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No

响应

Returns: UpdateSubscriptionAPIResponse

示例

updateSubscription 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权：api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下以为 API 密钥设置前缀（例如 Bearer），如有需要
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateAPIUserSubscriptionData = UpdateAPIUserSubscriptionData(); // UpdateAPIUserSubscriptionData | 
final userId = userId_example; // String | 
try {
    final result = api_instance.updateSubscription(tenantId, id, updateAPIUserSubscriptionData, userId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateSubscription: $e\n');
}

获取租户每日使用情况

参数

名称	类型	位置	必需
tenantId	string	query	是
yearNumber	number	query	否
monthNumber	number	query	否
dayNumber	number	query	否
skip	number	query	否

响应

返回: GetTenantDailyUsagesResponse

示例

getTenantDailyUsages 示例

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 yearNumber = 1.2; // double | 
final monthNumber = 1.2; // double | 
final dayNumber = 1.2; // double | 
final skip = 1.2; // double | 
try {
    final result = api_instance.getTenantDailyUsages(tenantId, GetTenantDailyUsagesOptions(yearNumber: yearNumber, monthNumber: monthNumber, dayNumber: dayNumber, skip: skip));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTenantDailyUsages: $e\n');
}

创建租户套餐

参数

名称	类型	位置	必需	描述
tenantId	string	query	是

响应

返回: CreateTenantPackageResponse

示例

createTenantPackage 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权：api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下内容以为 API 密钥设置前缀（例如 Bearer），如有需要
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createTenantPackageBody = CreateTenantPackageBody(); // CreateTenantPackageBody | 
try {
    final result = api_instance.createTenantPackage(tenantId, createTenantPackageBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createTenantPackage: $e\n');
}

删除租户套餐

参数

名称	类型	位置	必填	描述
tenantId	string	query	Yes
id	string	path	Yes

响应

返回： APIEmptyResponse

示例

deleteTenantPackage 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权：api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下内容以为 API 密钥设置前缀（例如 Bearer），如果需要
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.deleteTenantPackage(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteTenantPackage: $e\n');
}

获取租户套餐

参数

名称	类型	位置	必需	描述
tenantId	string	query	Yes
id	string	path	Yes

响应

返回： GetTenantPackageResponse

示例

getTenantPackage 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下代码以设置前缀（例如 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.getTenantPackage(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTenantPackage: $e\n');
}

获取租户套餐列表

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
skip	number	query	否

响应

返回：GetTenantPackagesResponse

示例

getTenantPackages 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权：api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下内容以设置前缀（例如 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.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';
// 取消注释下面的行以设置 API 密钥的前缀（例如 Bearer），如果需要
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final replaceTenantPackageBody = ReplaceTenantPackageBody(); // ReplaceTenantPackageBody | 
try {
    final result = api_instance.replaceTenantPackage(tenantId, id, replaceTenantPackageBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->replaceTenantPackage: $e\n');
}

更新租户套餐

参数

名称	类型	位置	必需	描述
tenantId	string	query	Yes
id	string	path	Yes

响应

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

响应

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

响应

Returns: GetTenantUserResponse

示例

getTenantUser 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下内容以为 API 密钥设置前缀（例如 Bearer），如果需要
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.getTenantUser(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTenantUser: $e\n');
}

获取租户用户列表

参数

名称	类型	位置	必填	描述
tenantId	string	query	Yes
skip	number	query	No

响应

Returns: GetTenantUsersResponse

示例

getTenantUsers 示例

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.getTenantUsers(tenantId, skip);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTenantUsers: $e\n');
}

替换租户用户

参数

名称	类型	位置	必需
tenantId	string	query	是
id	string	path	是
updateComments	string	query	否

响应

返回： APIEmptyResponse

示例

replaceTenantUser 示例

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

发送登录链接

参数

名称	类型	位置	必填
tenantId	string	query	是
id	string	path	是
redirectURL	string	query	否

响应

Returns: APIEmptyResponse

示例

sendLoginLink 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下行以设置前缀（例如 Bearer），如果需要的话
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final redirectURL = redirectURL_example; // String | 
try {
    final result = api_instance.sendLoginLink(tenantId, id, redirectURL);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->sendLoginLink: $e\n');
}

更新租户用户

参数

名称	类型	位置	必需
tenantId	string	query	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';
// 取消注释以下内容以为 API 密钥设置前缀（例如 Bearer），如果需要
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateTenantUserBody = UpdateTenantUserBody(); // UpdateTenantUserBody | 
final updateComments = updateComments_example; // String | 
try {
    final result = api_instance.updateTenantUser(tenantId, id, updateTenantUserBody, updateComments);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateTenantUser: $e\n');
}

创建租户

参数

名称	类型	位置	必填	描述
tenantId	string	query	Yes

响应

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

获取租户

参数

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

响应

返回: GetTenantResponse

示例

getTenant 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下代码以设置前缀（例如 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';
// 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 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	是
id	string	path	是

响应

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

响应

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

响应

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

示例

getTicket 示例

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

获取工单列表

Parameters

名称	类型	位置	必填
tenantId	string	query	是
userId	string	query	否
state	number	query	否
skip	number	query	否
limit	number	query	否

Response

返回: GetTicketsResponse

Example

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

响应

Returns: 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" (1000x1000px) 或 "CrossPlatform" (为流行设备创建尺寸)
urlId	string	query	No	页面 ID，上传发生的来源，以进行配置

返回： 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\" (1000x1000px) 或 \"CrossPlatform\" (为流行设备创建尺寸)
final urlId = urlId_example; // String | 页面 ID，上传发生的来源，以进行配置
try {
    final result = api_instance.uploadImage(tenantId, file, UploadImageOptions(sizePreset: sizePreset, urlId: urlId));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->uploadImage: $e\n');
}

通过ID获取用户徽章进度

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
id	string	path	是

响应

返回：APIGetUserBadgeProgressResponse

示例

getUserBadgeProgressById 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权：api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下以设置 API 密钥前缀（例如 Bearer），如果需要
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.getUserBadgeProgressById(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUserBadgeProgressById: $e\n');
}

通过用户ID获取徽章进度

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
userId	string	path	是

响应

返回：APIGetUserBadgeProgressResponse

示例

getUserBadgeProgressByUserId 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下内容以为 API 密钥设置前缀（例如 Bearer），如果需要
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final userId = userId_example; // String | 
try {
    final result = api_instance.getUserBadgeProgressByUserId(tenantId, userId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUserBadgeProgressByUserId: $e\n');
}

获取用户徽章进度列表

参数

名称	类型	位置	必填
tenantId	string	query	Yes
userId	string	query	No
limit	number	query	No
skip	number	query	No

响应

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

创建用户徽章

参数

名称	类型	位置	必填	描述
tenantId	string	query	是

响应

返回： APICreateUserBadgeResponse

示例

createUserBadge 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下代码以设置前缀（例如 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	Yes
id	string	path	Yes

响应

Returns: APIEmptySuccessResponse

示例

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

获取用户徽章列表

参数

Name	Type	Location	Required
tenantId	string	query	Yes
userId	string	query	No
badgeId	string	query	No
type	number	query	No
displayedOnComments	boolean	query	No
limit	number	query	No
skip	number	query	No

响应

返回: APIGetUserBadgesResponse

示例

获取用户徽章示例

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

响应

返回: APIEmptySuccessResponse

示例

updateUserBadge 示例

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

获取用户通知

参数

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

重置用户通知计数

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
sso	string	query	否

响应

返回： ResetUserNotificationsResponse

示例

resetUserNotificationCount 示例

Copy

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

重置用户通知

参数

Name	Type	Location	Required
tenantId	string	query	是
afterId	string	query	否
afterCreatedAt	integer	query	否
unreadOnly	boolean	query	否
dmOnly	boolean	query	否
noDm	boolean	query	否
sso	string	query	否

响应

返回: ResetUserNotificationsResponse

示例

resetUserNotifications 示例

Copy

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

更新用户通知评论订阅状态

Enable or disable notifications for a specific comment.

Parameters

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

Response

返回: UpdateUserNotificationCommentSubscriptionStatusResponse

Example

updateUserNotificationCommentSubscriptionStatus 示例

Copy

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

更新用户通知页面订阅状态

启用或禁用页面的通知。当用户订阅页面时，会为新的根评论创建通知，并且

参数

名称	类型	位置	必填
tenantId	string	query	Yes
urlId	string	query	Yes
url	string	query	Yes
pageTitle	string	query	Yes
subscribedOrUnsubscribed	string	path	Yes
sso	string	query	No

响应

返回：UpdateUserNotificationPageSubscriptionStatusResponse

示例

updateUserNotificationPageSubscriptionStatus 示例

Copy

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

更新用户通知状态

参数

名称	类型	位置	必需
tenantId	string	query	是
notificationId	string	path	是
newStatus	string	path	是
sso	string	query	否

响应

返回: UpdateUserNotificationStatusResponse

示例

updateUserNotificationStatus 示例

Copy

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

获取用户在线状态

参数

名称	类型	位置	必填
tenantId	string	query	Yes
urlIdWS	string	query	Yes
userIds	string	query	Yes

响应

返回: GetUserPresenceStatusesResponse

示例

getUserPresenceStatuses 示例

Copy

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

搜索用户

参数

名称	类型	位置	必需
tenantId	string	path	是
urlId	string	query	是
usernameStartsWith	string	query	否
mentionGroupIds	array	query	否
sso	string	query	否
searchSection	string	query	否

响应

返回: SearchUsersResult

示例

searchUsers 示例

Copy

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

获取用户

参数

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

响应

返回: GetUserResponse

示例

getUser 示例

Copy

import 'package:fastcomments_dart/api.dart';
// TODO 配置 API 密钥授权: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 取消注释以下内容以为 API 密钥设置前缀（例如 Bearer），如有需要
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.getUser(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUser: $e\n');
}

创建投票

参数

名称	类型	位置	必填
tenantId	string	query	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';
// 取消注释以下内容以设置 API 密钥的前缀（例如 Bearer），如果需要
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final direction = direction_example; // String | 
final userId = userId_example; // String | 
final anonUserId = anonUserId_example; // String | 
try {
    final result = api_instance.createVote(tenantId, commentId, direction, CreateVoteOptions(userId: userId, anonUserId: anonUserId));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createVote: $e\n');
}

删除投票

参数

名称	类型	位置	必需
tenantId	string	query	是
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	是
urlId	string	query	是

响应

返回： 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 仓库了解贡献指南。

语言 🇨🇳 简体中文

文档

聚合

审计日志

认证

从评论屏蔽

检查已屏蔽的评论

评论

用户评论

域配置

邮件模板

事件日志

信息流帖子

标记评论

动图

标签

审核

版主

通知计数

通知

页面反应

页面

待处理Webhook事件

问题配置

问题结果

问题结果聚合

SSO用户

订阅

租户每日使用

租户套餐

租户用户

租户

工单

翻译

上传图片

用户徽章进度

用户徽章

用户通知

用户在线状态

用户搜索

用户

投票

FastComments Dart SDK

仓库

布局

使用

单点登录

聚合

参数

返回

示例

获取审计日志

参数

响应

示例

公共登出

响应

示例

公共评论屏蔽

参数

响应

示例

公共取消评论屏蔽

参数

响应

示例

检查已屏蔽评论

参数

响应

示例

屏蔽用户评论

参数

响应

示例

创建公共评论

参数

响应

示例

删除评论

参数