FastComments Dart SDK

זהו ה‑SDK הרשמי של Dart עבור FastComments.

ניהול תגובות, משתמשים, SSO, והמודרציה מתוך אפליקציות Dart ו‑Flutter שלך.

מאגר

פריסה

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 helpers are included in the package (package:fastcomments_dart/sso/...).

הלקוח חושף שלוש מחלקות API:

DefaultApi - שיטות המאומתות במפתח API לשימוש בצד השרת.
PublicApi - שיטות ציבוריות שאין צורך במפתח API, בטוחות לדפדפן ו ללקוחות ניידים.
ModerationApi - חבילה מקיפה של APIיות מודרציה בזמן אמת ומהירות. כל שיטה של ModerationApi מקבלת פרמטר sso ויכולה לאמת באמצעות SSO או באמצעות עוגיית סשן של FastComments.com.

import 'package:fastcomments_dart/api.dart';

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

import 'package:fastcomments_dart/api.dart';

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

import 'package:fastcomments_dart/api.dart';

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

SSO

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

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

צבר

מאגד מסמכים על ידי קיבוץ (אם נמסר groupBy) ויישום של פעולות מרובות. פעולות שונות (למשל sum, countDistinct, avg וכד') נתמכות.

Parameters

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
parentTenantId	string	query	לא
includeStats	boolean	query	לא

Response

מחזיר: AggregateResponse

Example

דוגמת צבירה

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 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	Yes
limit	number	query	No
skip	number	query	No
order	string	query	No
after	number	query	No
before	number	query	No

תגובה

מחזיר: 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	Yes
commentId	string	path	Yes
sso	string	query	No

תגובה

מחזיר: BlockSuccess

דוגמה

blockFromCommentPublic דוגמה

Copy

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

בטל חסימת תגובה ציבורי

פרמטרים

שם	סוג	מיקום	חובה
tenantId	string	query	כן
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, sss);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->unBlockCommentPublic: $e\n');
}

תגובות שנבדקו לחסימה

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
commentIds	string	query	כן	רשימה מופרדת בפסיקים של מזהי תגובות.
sso	string	query	לא

תגובה

מחזיר: CheckBlockedCommentsResponse

דוגמה

דוגמת checkedCommentsForBlocked

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final commentIds = commentIds_example; // String | רשימה מופרדת בפסיקים של מזהי תגובות.
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	כן
id	string	path	כן
userId	string	query	לא
anonUserId	string	query	לא

תגובה

Returns: BlockSuccess

דוגמה

דוגמה של blockUserFromComment

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

צור תגובה ציבורית

Parameters

שם	סוג	מיקום	נדרש
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; // מחרוזת | 
final commentId = commentId_example; // מחרוזת | 
final broadcastId = broadcastId_example; // מחרוזת | 
final editKey = editKey_example; // מחרוזת | 
final sso = sso_example; // מחרוזת | 
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');
}

דגל תגובה

Parameters

שם	סוג	מיקום	נדרש
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No
anonUserId	string	query	No

Response

מחזיר: FlagCommentResponse

Example

דוגמת flagComment

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

קבל תגובה

Parameters

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

Response

Returns: APIGetCommentResponse

Example

דוגמת getComment

Copy

import 'package:fastcomments_dart/api.dart';
// TODO להגדיר הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (לדוגמה Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.getComment(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getComment: $e\n');
}

קבל תגובות

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	Yes
page	integer	query	No
limit	integer	query	No
skip	integer	query	No
asTree	boolean	query	No
skipChildren	integer	query	No
limitChildren	integer	query	No
maxTreeDepth	integer	query	No
urlId	string	query	No
userId	string	query	No
anonUserId	string	query	No
contextUserId	string	query	No
hashTag	string	query	No
parentId	string	query	No
direction	string	query	No
fromDate	integer	query	No
toDate	integer	query	No

תגובה

Returns: APIGetCommentsResponse

דוגמה

דוגמה של getComments

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 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	כן
urlId	string	query	כן
page	integer	query	לא
direction	string	query	לא
sso	string	query	לא
skip	integer	query	לא
skipChildren	integer	query	לא
limit	integer	query	לא
limitChildren	integer	query	לא
countChildren	boolean	query	לא
fetchPageForCommentId	string	query	לא
includeConfig	boolean	query	לא
countAll	boolean	query	לא
includei10n	boolean	query	לא
locale	string	query	לא
modules	string	query	לא
isCrawler	boolean	query	לא
includeNotificationCount	boolean	query	לא
asTree	boolean	query	לא
maxTreeDepth	integer	query	לא
useFullTranslationIds	boolean	query	לא
parentId	string	query	לא
searchText	string	query	לא
hashTags	array	query	לא
userId	string	query	לא
customConfigStr	string	query	לא
afterCommentId	string	query	לא
beforeCommentId	string	query	לא

תגובה

מחזיר: GetCommentsResponseWithPresencePublicComment

דוגמה

getCommentsPublic דוגמה

Copy

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

קבל טקסט תגובה

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	path	כן
commentId	string	path	כן
editKey	string	query	לא
sso	string	query	לא

תגובה

מחזיר: PublicAPIGetCommentTextResponse

דוגמה

דוגמת getCommentText

Copy

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

קבל שמות משתמשים שהצביעו על תגובה

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	path	כן
commentId	string	path	כן
dir	integer	query	כן
sso	string	query	לא

תגובה

מחזיר: GetCommentVoteUserNamesSuccessResponse

דוגמה

getCommentVoteUserNames דוגמה

Copy

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

נעל תגובה

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	path	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
sso	string	query	No

תגובה

מחזיר: APIEmptyResponse

דוגמה

דוגמת lockComment

Copy

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

הצמד תגובה

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	path	כן
commentId	string	path	כן
broadcastId	string	query	כן
sso	string	query	לא

תגובה

מחזיר: ChangeCommentPinStatusResponse

דוגמה

pinComment דוגמה

Copy

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

שמור תגובה

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
isLive	boolean	query	לא
doSpamCheck	boolean	query	לא
sendEmails	boolean	query	לא
populateNotifications	boolean	query	לא

תגובה

מחזיר: APISaveCommentResponse

דוגמה

דוגמת saveComment

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createCommentParams = CreateCommentParams(); // CreateCommentParams | 
final isLive = true; // bool | 
final doSpamCheck = true; // bool | 
final sendEmails = true; // bool | 
final populateNotifications = true; // bool | 
try {
    final result = api_instance.saveComment(tenantId, createCommentParams, SaveCommentOptions(isLive: isLive, doSpamCheck: doSpamCheck, sendEmails: sendEmails, populateNotifications: populateNotifications));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->saveComment: $e\n');
}

שמור תגובות בקבוצה

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	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');
}

בטל חסימת משתמש מהתגובה

Parameters

Name	Type	Location	Required
tenantId	string	query	כן
id	string	path	כן
userId	string	query	לא
anonUserId	string	query	לא

Response

תגובה: 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	Yes
id	string	path	Yes
userId	string	query	No
anonUserId	string	query	No

תגובה

מחזיר: FlagCommentResponse

דוגמה

דוגמת unFlagComment

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קביעת הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// הסירו את ההערה למטה כדי להגדיר קידומת (למשל Bearer) עבור מפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final userId = userId_example; // String | 
final anonUserId = anonUserId_example; // String | 
try {
    final result = api_instance.unFlagComment(tenantId, id, UnFlagCommentOptions(userId: userId, anonUserId: anonUserId));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->unFlagComment: $e\n');
}

בטל נעילת תגובה

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	path	כן
commentId	string	path	כן
broadcastId	string	query	כן
sso	string	query	לא

תגובה

מחזיר: APIEmptyResponse

דוגמה

דוגמה ל-unLockComment

Copy

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

בטל הצמדת תגובה

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	path	כן
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	query	כן
id	string	path	כן
contextUserId	string	query	לא
doSpamCheck	boolean	query	לא
isLive	boolean	query	לא

תגובה

מחזיר: APIEmptyResponse

דוגמה

דוגמת updateComment

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קונפיגורציית הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל 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('חריגה בעת קריאה ל-DefaultApi->updateComment: $e\n');
}

הצביע לתגובה

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	path	Yes
commentId	string	path	Yes
urlId	string	query	Yes
broadcastId	string	query	Yes
sessionId	string	query	No
sso	string	query	No

תגובה

מחזיר: VoteResponse

דוגמה

דוגמה ל‑voteComment

Copy

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

קבל תגובות למשתמש

פרמטרים

שם	סוג	מיקום	נדרש
userId	string	query	No
direction	string	query	No
repliesToUserId	string	query	No
page	number	query	No
includei10n	boolean	query	No
locale	string	query	No
isCrawler	boolean	query	No

תגובה

Returns: GetCommentsForUserResponse

דוגמה

getCommentsForUser דוגמה

Copy

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

הוסף תצורת דומיין

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן

תגובה

מחזיר: AddDomainConfigResponse

דוגמה

addDomainConfig דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קבע אישור מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל השבתת ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח ה-API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final addDomainConfigParams = AddDomainConfigParams(); // AddDomainConfigParams | 
try {
    final result = api_instance.addDomainConfig(tenantId, addDomainConfigParams);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addDomainConfig: $e\n');
}

מחק תצורת דומיין

פרמטרים

שם	סוג	מיקום	דרוש	תיאור
tenantId	string	query	כן
domain	string	path	כן

תשובה

מחזיר: DeleteDomainConfigResponse

דוגמה

deleteDomainConfig דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קביעת הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח ה-API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String |
final domain = domain_example; // String |
try {
    final result = api_instance.deleteDomainConfig(tenantId, domain);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteDomainConfig: $e\n');
}

קבל תצורת דומיין

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
domain	string	path	כן

תגובה

מחזיר: GetDomainConfigResponse

דוגמה

דוגמת getDomainConfig

Copy

import 'package:fastcomments_dart/api.dart';
// TODO לקבוע אימות מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה שלמטה כדי להגדיר קידומת (לדוגמה Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final domain = domain_example; // String | 
try {
    final result = api_instance.getDomainConfig(tenantId, domain);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getDomainConfig: $e\n');
}

קבל תצורות דומיין

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן

תגובה

מחזיר: GetDomainConfigsResponse

דוגמה

דוגמת getDomainConfigs

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קביעת הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// 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');
}

עדכן חלקית תצורת דומיין

Parameters

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	Yes
domainToUpdate	string	path	Yes

תגובה

מחזיר: PatchDomainConfigResponse

דוגמה

patchDomainConfig דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קונפיגורציית הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final domainToUpdate = domainToUpdate_example; // String | 
final patchDomainConfigParams = PatchDomainConfigParams(); // PatchDomainConfigParams | 
try {
    final result = api_instance.patchDomainConfig(tenantId, domainToUpdate, patchDomainConfigParams);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->patchDomainConfig: $e\n');
}

הציב תצורת דומיין

Parameters

Name	Type	Location	Required	תיאור
tenantId	string	query	Yes
domainToUpdate	string	path	Yes

Response

מחזיר: PutDomainConfigResponse

Example

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	Yes

תגובה

מחזיר: CreateEmailTemplateResponse

דוגמה

createEmailTemplate דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קבע הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) עבור מפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createEmailTemplateBody = CreateEmailTemplateBody(); // CreateEmailTemplateBody | 
try {
    final result = api_instance.createEmailTemplate(tenantId, createEmailTemplateBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createEmailTemplate: $e\n');
}

מחק תבנית אימייל

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזירה: APIEmptyResponse

דוגמה

דוגמה ל‑deleteEmailTemplate

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

דוגמה

דוגמה למחיקת שגיאת תבנית אימייל

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר אישור מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// הסר את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final errorId = errorId_example; // String | 
try {
    final result = api_instance.deleteEmailTemplateRenderError(tenantId, id, errorId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteEmailTemplateRenderError: $e\n');
}

קבל תבנית אימייל

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: GetEmailTemplateResponse

דוגמה

getEmailTemplate דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.getEmailTemplate(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getEmailTemplate: $e\n');
}

קבל הגדרות תבנית אימייל

פרמטרים

שם	סוג	מיקום	חובה	תיאור
tenantId	string	query	כן

תגובה

מחזיר: GetEmailTemplateDefinitionsResponse

דוגמה

getEmailTemplateDefinitions דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הקצב הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (לדוגמה Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
try {
    final result = api_instance.getEmailTemplateDefinitions(tenantId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getEmailTemplateDefinitions: $e\n');
}

קבל שגיאות רינדור תבנית אימייל

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
id	string	path	כן
skip	number	query	לא

תגובה

מחזיר: GetEmailTemplateRenderErrorsResponse

דוגמה

getEmailTemplateRenderErrors דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר אימות מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל 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	Yes
skip	number	query	No

תגובה

מחזיר: GetEmailTemplatesResponse

דוגמה

דוגמת getEmailTemplates

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (לדוגמה, Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final skip = 1.2; // double | 
try {
    final result = api_instance.getEmailTemplates(tenantId, skip);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getEmailTemplates: $e\n');
}

רנדר תבנית אימייל

Parameters

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

Response

Returns: RenderEmailTemplateResponse

Example

דוגמת 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	כן
id	string	path	כן

תגובה

מחזיר: APIEmptyResponse

דוגמה

דוגמת updateEmailTemplate

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר אישור מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח ה-API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateEmailTemplateBody = UpdateEmailTemplateBody(); // UpdateEmailTemplateBody | 
try {
    final result = api_instance.updateEmailTemplate(tenantId, id, updateEmailTemplateBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateEmailTemplate: $e\n');
}

קבל יומן אירועים

req tenantId urlId userIdWS

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	path	כן
urlId	string	query	כן
userIdWS	string	query	כן
startTime	integer	query	כן
endTime	integer	query	לא

תגובה

Returns: GetEventLogResponse

דוגמה

דוגמת getEventLog

Copy

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

קבל יומן אירועים גלובלי

req tenantId urlId userIdWS

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	path	כן
urlId	string	query	כן
userIdWS	string	query	כן
startTime	integer	query	כן
endTime	integer	query	לא

תגובה

מחזיר: 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');
}

צור פוסט בפיד

Parameters

Name	Type	Location	Required
tenantId	string	query	Yes
broadcastId	string	query	No
isLive	boolean	query	No
doSpamCheck	boolean	query	No
skipDupCheck	boolean	query	No

Response

מחזיר: CreateFeedPostResponse

Example

דוגמת 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');
}

צור פוסט בפיד ציבורי

פרמטרים

שם	סוג	מיקום	חובה
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

תגובה

מחזיר: DeleteFeedPostPublicResponse

דוגמה

deleteFeedPostPublic דוגמה

Copy

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

קבל פוסטים בפיד

req tenantId afterId

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
afterId	string	query	לא
limit	integer	query	לא
tags	array	query	לא

תשובה

מחזיר: GetFeedPostsResponse

דוגמה

דוגמת getFeedPosts

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final afterId = afterId_example; // String | 
final limit = 56; // int | 
final tags = []; // List<String> | 
try {
    final result = api_instance.getFeedPosts(tenantId, GetFeedPostsOptions(afterId: afterId, limit: limit, tags: tags));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFeedPosts: $e\n');
}

קבל פוסטים בפיד ציבורי

req tenantId afterId

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	path	כן
afterId	string	query	לא
limit	integer	query	לא
tags	array	query	לא
sso	string	query	לא
isCrawler	boolean	query	לא
includeUserInfo	boolean	query	לא

תגובה

מחזיר: PublicFeedPostsResponse

דוגמה

דוגמה getFeedPostsPublic

Copy

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

קבל סטטיסטיקות פוסטים בפיד

פרמטרים

שם	סוג	מיקום	חובה
tenantId	string	path	Yes
postIds	array	query	Yes
sso	string	query	No

תגובה

מחזיר: 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	לא

תגובה

Returns: UserReactsResponse

דוגמה

getUserReactsPublic דוגמה

Copy

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

הגב על פוסט בפיד ציבורי

פרמטרים

Name	Type	Location	Required
tenantId	string	path	Yes
postId	string	path	Yes
isUndo	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

תגובה

מחזיר: ReactFeedPostResponse

דוגמה

דוגמת reactFeedPostPublic

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // מחרוזת | 
final postId = postId_example; // מחרוזת | 
final reactBodyParams = ReactBodyParams(); // ReactBodyParams | 
final isUndo = true; // בוליאני | 
final broadcastId = broadcastId_example; // מחרוזת | 
final sso = sso_example; // מחרוזת | 
try {
    final result = api_instance.reactFeedPostPublic(tenantId, postId, reactBodyParams, ReactFeedPostPublicOptions(isUndo: isUndo, broadcastId: broadcastId, sso: sso));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->reactFeedPostPublic: $e\n');
}

עדכן פוסט בפיד

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: APIEmptyResponse

דוגמה

דוגמת updateFeedPost

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח ה-API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final feedPost = FeedPost(); // FeedPost | 
try {
    final result = api_instance.updateFeedPost(tenantId, id, feedPost);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateFeedPost: $e\n');
}

עדכן פוסט בפיד ציבורי

פרמטרים

שם	סוג	מיקום	חובה
tenantId	string	path	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	כן
largeInternalURLSanitized	string	query	כן

תגובה

מחזיר: GifGetLargeResponse

דוגמה

דוגמת getGifLarge

Copy

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

חפש GIFים

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	path	כן
search	string	query	כן
locale	string	query	לא
rating	string	query	לא
page	number	query	לא

תגובה

מחזיר: GetGifsSearchResponse

דוגמה

דוגמת getGifsSearch

Copy

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

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

הוסף האשטאג

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן

תגובה

מחזיר: CreateHashTagResponse

דוגמה

addHashTag דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדרת הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (לדוגמה, Bearer) למפתח API, במידת הצורך
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createHashTagBody = CreateHashTagBody(); // CreateHashTagBody | 
try {
    final result = api_instance.addHashTag(tenantId, createHashTagBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addHashTag: $e\n');
}

הוסף האשטאגים בקבוצה

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן

תגובה

מחזיר: BulkCreateHashTagsResponse

דוגמה

דוגמת addHashTagsBulk

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) עבור מפתח API, אם צריך
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final bulkCreateHashTagsBody = BulkCreateHashTagsBody(); // BulkCreateHashTagsBody | 
try {
    final result = api_instance.addHashTagsBulk(tenantId, bulkCreateHashTagsBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addHashTagsBulk: $e\n');
}

מחק האשטאג

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	Yes
tag	string	path	Yes

תגובה

מחזיר: APIEmptyResponse

דוגמה

deleteHashTag דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר הרשאת מפתח API: api_key
// קבע את מפתח ה-API ל-'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, במידת הצורך
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final tag = tag_example; // String | 
final deleteHashTagRequestBody = DeleteHashTagRequestBody(); // DeleteHashTagRequestBody | 
try {
    final result = api_instance.deleteHashTag(tenantId, tag, deleteHashTagRequestBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteHashTag: $e\n');
}

קבל האשטאגים

Parameters

שם	סוג	מיקום	חובה	תיאור
tenantId	string	query	כן
page	number	query	לא

Response

מחזיר: GetHashTagsResponse

Example

דוגמה getHashTags

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

עדכן חלקית האשטאג

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	Yes
tag	string	path	Yes

תגובה

מחזיר: UpdateHashTagResponse

דוגמה

patchHashTag דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קבע הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final tag = tag_example; // String | 
final updateHashTagBody = UpdateHashTagBody(); // UpdateHashTagBody | 
try {
    final result = api_instance.patchHashTag(tenantId, tag, updateHashTagBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->patchHashTag: $e\n');
}

מחק הצבעת פיקוח

פרמטרים

שם	סוג	מיקום	חובה
tenantId	string	query	כן
commentId	string	path	כן
voteId	string	path	כן
broadcastId	string	query	לא
sso	string	query	לא

תגובה

מחזיר: VoteDeleteResponse

דוגמה

deleteModerationVote דוגמה

Copy

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

קבל תגובות API

פרמטרים

Name	Type	Location	Required
tenantId	string	query	כן
page	number	query	לא
count	number	query	לא
text-search	string	query	לא
byIPFromComment	string	query	לא
filters	string	query	לא
searchFilters	string	query	לא
sorts	string	query	לא
demo	boolean	query	לא
sso	string	query	לא

תגובה

מחזיר: 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

פרמטרים

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

תגובה

מחזיר: ModerationExportStatusResponse

דוגמה

דוגמת getApiExportStatus

Copy

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

קבל מזהי API

פרמטרים

שם	סוג	מיקום	נדרש
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	לא

תגובה

מחזיר: ModerationAPIGetCommentIdsResponse

דוגמה

דוגמה getApiIds

Copy

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

קבל משתמשים חסומים מהתגובה

פרמטרים

שם	סוג	מיקום	חובה
tenantId	string	query	כן
commentId	string	path	כן
sso	string	query	לא

תגובה

מחזיר: GetBannedUsersFromCommentResponse

דוגמה

דוגמת getBanUsersFromComment

Copy

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

קבל סטטוס חסימת תגובה

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
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; // String | 
final sso = sso_example; // String | 
try {
    final result = api_instance.getCounts(tenantId, sso);
    print(result);
} catch (e) {
    print('Exception when calling ModerationApi->getCounts: $e\n');
}

קבל יומנים

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

תגובה

מחזירה: ModerationAPIGetLogsResponse

דוגמה

דוגמת getLogs

Copy

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

קבל תגים ידניים

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	Yes
sso	string	query	No

תגובה

מחזיר: GetTenantManualBadgesResponse

דוגמה

דוגמה getManualBadges

Copy

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

קבל תגים ידניים למשתמש

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	Yes
badgesUserId	string	query	No
commentId	string	query	No
sso	string	query	No

תגובה

מחזירה: GetUserManualBadgesResponse

דוגמה

getManualBadgesForUser דוגמא

Copy

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

קבל תגובה תחת פיקוח

פרמטרים

שם	סוג	מיקום	חובה
tenantId	string	query	Yes
commentId	string	path	Yes
includeEmail	boolean	query	No
includeIP	boolean	query	No
sso	string	query	No

תגובה

מחזיר: 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	Yes
value	string	query	No
filters	string	query	No
searchFilters	string	query	No
sso	string	query	No

תגובה

מחזיר: 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');
}

קבל הצעות חיפוש

Parameters

שם	סוג	מיקום	נדרש
tenantId	string	query	Yes
text-search	string	query	No
sso	string	query	No

Response

מחזיר: ModerationSuggestResponse

Example

דוגמת 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	שאילתה	כן
value	string	שאילתה	לא
sso	string	שאילתה	לא

תגובה

מחזיר: 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

דוגמה

getTrustFactor דוגמה

Copy

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

קבל העדפת חסימת משתמש

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
sso	string	query	לא

תגובה

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

קבל פרופיל פנימי של משתמש

Parameters

שם	סוג	מיקום	חובה
tenantId	string	query	Yes
commentId	string	query	No
sso	string	query	No

Response

מחזיר: GetUserInternalProfileResponse

Example

דוגמת getUserInternalProfile

Copy

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

הוסף התאמת הצבעות תגובה

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

תגובה

מחזיר: AdjustVotesResponse

לדוגמה

דוגמת postAdjustCommentVotes

Copy

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

פרסם יצוא API

פרמטרים

שם	סוג	מיקום	נדרש
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	Yes
commentId	string	path	Yes
banEmail	boolean	query	No
banEmailDomain	boolean	query	No
banIP	boolean	query	No
deleteAllUsersComments	boolean	query	No
bannedUntil	string	query	No
isShadowBan	boolean	query	No
updateId	string	query	No
banReason	string	query	No
sso	string	query	No

תגובה

מחזיר: BanUserFromCommentResult

דוגמה

postBanUserFromComment דוגמה

Copy

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

בטל הוראת חרם משתמש

פרמטרים

שם	סוג	מיקום	חובה	תיאור
tenantId	string	query	Yes
sso	string	query	No

תגובה

מחזיר: APIEmptyResponse

דוגמה

postBanUserUndo דוגמה

Copy

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

פרסם סיכום לפני חסימה בקבוצה

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
includeByUserIdAndEmail	boolean	query	לא
includeByIP	boolean	query	לא
includeByEmailDomain	boolean	query	לא
sso	string	query	לא

תגובה

מחזיר: 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');
}

פרסם תגובות לפי מזהים

Parameters

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	Yes
sso	string	query	No

Response

מחזיר: ModerationAPIChildCommentsResponse

Example

דוגמת postCommentsByIds

Copy

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

פרסם סימון תגובה

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

תגובה

מחזיר: APIEmptyResponse

דוגמה

דוגמת postFlagComment

Copy

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

פרסם הסרת תגובה

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

תגובה

מחזיר: 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	Yes
commentId	string	path	Yes
approved	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

תגובה

מחזיר: 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

תשובה

מחזיר: 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	Yes
commentId	string	path	Yes
direction	string	query	No
broadcastId	string	query	No
sso	string	query	No

תגובה

מחזיר: VoteResponse

דוגמה

דוגמת postVote

Copy

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

הענק תו

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	Yes
badgeId	string	query	Yes
userId	string	query	No
commentId	string	query	No
broadcastId	string	query	No
sso	string	query	No

תשובה

מחזיר: AwardUserBadgeResponse

דוגמה

דוגמת putAwardBadge

Copy

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

סגור שרשור

פרמטרים

שם	סוג	מיקום	חובה
tenantId	string	query	כן
urlId	string	query	כן
sso	string	query	לא

תגובה

מחזיר: APIEmptyResponse

דוגמה

putCloseThread דוגמה

Copy

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

הסר תו

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	Yes
badgeId	string	query	Yes
userId	string	query	No
commentId	string	query	No
broadcastId	string	query	No
sso	string	query	No

תגובה

מחזיר: 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');
}

פתח שרשור מחדש

Parameters

שם	סוג	מיקום	נדרש
tenantId	string	שאילתה	Yes
urlId	string	שאילתה	Yes
sso	string	שאילתה	No

Response

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

תגובה

מחזיר: 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

תגובה

Returns: APIEmptyResponse

דוגמה

deleteModerator דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final sendEmail = sendEmail_example; // String | 
try {
    final result = api_instance.deleteModerator(tenantId, id, sendEmail);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteModerator: $e\n');
}

קבל מודרטור

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	Yes
id	string	path	Yes

תגובה

מחזיר: GetModeratorResponse

דוגמה

דוגמת getModerator

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם יש צורך
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.getModerator(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getModerator: $e\n');
}

קבל מודרטורים

פרמטרים

שם	סוג	מיקום	חובה	תיאור
tenantId	string	query	כן
skip	number	query	לא

תגובה

מחזיר: GetModeratorsResponse

דוגמה

דוגמת getModerators

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קבע אוטוריזציית מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל 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	כן

תגובה

מחזיר: APIEmptyResponse

דוגמה

דוגמת sendInvite

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

עדכן מודרטור

פרמטרים

Name	Type	Location	Required	Description
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';
// בטל את ההערה למטה כדי להגדיר קידומת (לדוגמה, Bearer) למפתח API, אם צריך
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateModeratorBody = UpdateModeratorBody(); // UpdateModeratorBody | 
try {
    final result = api_instance.updateModerator(tenantId, id, updateModeratorBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateModerator: $e\n');
}

מחק ספירת התראות

Parameters

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	Yes
id	string	path	Yes

Response

מחזיר: APIEmptyResponse

Example

דוגמה של 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');
}

קבל ספירת התראות במטמון

Parameters

שם	סוג	מיקום	חובה	תיאור
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');
}

קבל ספירת התראות

Parameters

שם	סוג	מיקום	נדרש
tenantId	string	query	Yes
userId	string	query	No
urlId	string	query	No
fromCommentId	string	query	No
viewed	boolean	query	No
type	string	query	No

Response

מחזיר: GetNotificationCountResponse

Example

דוגמת getNotificationCount

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 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';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח ה-API, אם נדרש
//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');
}

עדכן התראה

פרמטרים

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

תשובה

מחזיר: APIEmptyResponse

דוגמה

דוגמת updateNotification

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קונפיגורציית הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל 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	Yes
urlId	string	query	Yes
id	string	query	Yes
title	string	query	No

תגובה

מחזירים: CreateV1PageReact

דוגמה

דוגמת createV2PageReact

Copy

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

מחק תגובה לעמוד V1

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	path	Yes
urlId	string	query	Yes

תגובה

מחזיר: CreateV1PageReact

דוגמה

deleteV1PageReact דוגמה

Copy

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

מחק תגובה לעמוד V2

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	path	Yes
urlId	string	query	Yes
id	string	query	Yes

תגובה

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

תגובה

Returns: 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	כן
urlId	string	query	כן
id	string	query	כן

תגובה

מחזיר: GetV2PageReactUsersResponse

דוגמה

דוגמה getV2PageReactUsers

Copy

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

הוסף עמוד

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	Yes

תגובה

מחזיר: AddPageAPIResponse

דוגמה

דוגמת addPage

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדרת הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל 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	כן
id	string	path	כן

תגובה

מחזיר: DeletePageAPIResponse

דוגמה

דוגמת deletePage

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.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.
דפדוף בעזרת מצביע (cursor) על commenterName: השרת עובר על החלק החלקי {tenantId, urlId, commenterName} מ‑afterName קדימה באמצעות $gt, ללא עלות $skip.

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	path	Yes
urlId	string	query	Yes	מזהה כתובת URL של העמוד (נוקה בצד השרת).
afterName	string	query	No	מצביע: העבר nextAfterName מתשובה קודמת.
afterUserId	string	query	No	קיבוע מצביע במקרים של שוויון: העבר nextAfterUserId מתשובה קודמת. נדרש כאשר afterName מוגדר כך שמקרים של שוויון בשם לא יוותרו על רשומות.

תגובה

Returns: PageUsersOfflineResponse

דוגמה

דוגמת getOfflineUsers

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final urlId = urlId_example; // String | מזהה כתובת URL של העמוד (נוקה בצד השרת).
final afterName = afterName_example; // String | מצביע: העבר nextAfterName מתשובה קודמת.
final afterUserId = afterUserId_example; // String | קיבוע מצביע במקרים של שוויון: העבר nextAfterUserId מתשובה קודמת. נדרש כאשר afterName מוגדר כך שמקרים של שוויון בשם לא יוותרו על רשומות.
try {
    final result = api_instance.getOfflineUsers(tenantId, urlId, GetOfflineUsersOptions(afterName: afterName, afterUserId: afterUserId));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getOfflineUsers: $e\n');
}

קבל משתמשים מקוונים

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

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
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

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	Yes
urlId	string	query	Yes

תשובה

מחזיר: GetPageByURLIdAPIResponse

דוגמה

דוגמת getPageByURLId

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קביעת הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל 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	כן

תגובה

מחזירה: GetPagesAPIResponse

דוגמה

דוגמת getPages

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדרת הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (לדוגמה, Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
try {
    final result = api_instance.getPages(tenantId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPages: $e\n');
}

קבל עמודים ציבוריים

List pages for a tenant. Used by the FChat desktop client to populate its room list.
דורש שהמאפיין enableFChat יהיה אמת (true) בתצורת המותאמת שנפתרה עבור כל דף.
דפים הדורשים SSO מסוננים בהתאם לגישת קבוצת המשתמש המבקש.

Parameters

Name	Type	Location	Required	Description
tenantId	string	path	Yes
cursor	string	query	No	סמן דפדוף אטום שמוחזר כ-`nextCursor` מבקשה קודמת. קשור לאותו `sortBy`.
limit	integer	query	No	1..200, ברירת מחדל 50
q	string	query	No	מסנן קידומת כותרת רגישות לאותיות גדולות/קטנות (case-insensitive) באופן אופציונלי.
sortBy	string	query	No	סדר מיון. `updatedAt` (ברירת מחדל, החדש ביותר ראשון), `commentCount` (התגובות הרבות ביותר ראשונות), או `title` (אלפביתי).
hasComments	boolean	query	No	אם אמת, תחזיר רק דפים עם לפחות תגובה אחת.

Response

Returns: GetPublicPagesResponse

Example

דוגמה getPagesPublic

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String | 
final cursor = cursor_example; // String | סמן דפדוף אטום שמוחזר כ-`nextCursor` מבקשה קודמת. קשור לאותו `sortBy`.
final limit = 56; // int | 1..200, default 50
final q = q_example; // String | מסנן קידומת כותרת רגישות לאותיות גדולות/קטנות (case-insensitive) באופן אופציונלי.
final sortBy = ; // PagesSortBy | סדר מיון. `updatedAt` (ברירת מחדל, החדש ביותר ראשון), `commentCount` (התגובות הרבות ביותר ראשונות), או `title` (אלפביתי).
final hasComments = true; // bool | אם אמת, תחזיר רק דפים עם לפחות תגובה אחת.
try {
    final result = api_instance.getPagesPublic(tenantId, GetPagesPublicOptions(cursor: cursor, limit: limit, q: q, sortBy: sortBy, hasComments: hasComments));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getPagesPublic: $e\n');
}

קבל מידע על משתמשים

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

Parameters

Name	Type	Location	Required	Description
tenantId	string	path	Yes
ids	string	query	Yes	מופרדים בפסיקים userIds.

Response

Returns: PageUsersInfoResponse

Example

דוגמת getUsersInfo

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // מחרוזת | 
final ids = ids_example; // מחרוזת | userIds מופרדים בפסיקים.
try {
    final result = api_instance.getUsersInfo(tenantId, ids);
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getUsersInfo: $e\n');
}

עדכן חלקית עמוד

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	Yes
id	string	path	Yes

תגובה

מחזיר: PatchPageAPIResponse

דוגמה

patchPage דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח ה-API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateAPIPageData = UpdateAPIPageData(); // UpdateAPIPageData | 
try {
    final result = api_instance.patchPage(tenantId, id, updateAPIPageData);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->patchPage: $e\n');
}

מחק אירוע webhook ממתין

פרמטרים

שם	סוג	מיקום	חובה	תיאור
tenantId	string	query	כן
id	string	path	כן

תשובה

מחזיר: APIEmptyResponse

דוגמה

deletePendingWebhookEvent דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קבע הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (לדוגמה 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.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';
// 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 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

דוגמה

דוגמת getPendingWebhookEvents

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קונפיגורציה של אימות מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final externalId = externalId_example; // String | 
final eventType = eventType_example; // String | 
final type = type_example; // String | 
final domain = domain_example; // String | 
final attemptCountGT = 1.2; // double | 
final skip = 1.2; // double | 
try {
    final result = api_instance.getPendingWebhookEvents(tenantId, GetPendingWebhookEventsOptions(commentId: commentId, externalId: externalId, eventType: eventType, type: type, domain: domain, attemptCountGT: attemptCountGT, skip: skip));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPendingWebhookEvents: $e\n');
}

צור קונפיגורציית שאלה

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	Yes

תגובה

מחזיר: CreateQuestionConfigResponse

דוגמה

דוגמת createQuestionConfig

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String |
final createQuestionConfigBody = CreateQuestionConfigBody(); // CreateQuestionConfigBody |
try {
    final result = api_instance.createQuestionConfig(tenantId, createQuestionConfigBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createQuestionConfig: $e\n');
}

מחק קונפיגורציית שאלה

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	Yes
id	string	path	Yes

תגובה

מחזיר: APIEmptyResponse

דוגמה

deleteQuestionConfig דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדרת אימות מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) עבור מפתח ה-API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.deleteQuestionConfig(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteQuestionConfig: $e\n');
}

קבל קונפיגורציית שאלה

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	Yes
id	string	path	Yes

תגובה

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

תגובה

מחזיר: 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');
}

עדכן קונפיגורציית שאלה

פרמטרים

שם	סוג	מיקום	חובה	תיאור
tenantId	string	query	Yes
id	string	path	Yes

תגובה

מחזיר: APIEmptyResponse

דוגמה

updateQuestionConfig דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קביעת הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את הערת השורה שלמטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateQuestionConfigBody = UpdateQuestionConfigBody(); // UpdateQuestionConfigBody | 
try {
    final result = api_instance.updateQuestionConfig(tenantId, id, updateQuestionConfigBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateQuestionConfig: $e\n');
}

צור תוצאה של שאלה

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן

תגובה

מחזיר: CreateQuestionResultResponse

דוגמה

createQuestionResult דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קבע הרשאה של מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל הערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח ה-API, אם נדרש
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('שגיאה בעת קריאה ל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';
// הסרת ההערה למטה כדי להגדיר קידומת (לדוגמה 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.deleteQuestionResult(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteQuestionResult: $e\n');
}

קבל תוצאה של שאלה

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	Yes
id	string	path	Yes

תגובה

מחזיר: GetQuestionResultResponse

דוגמה

דוגמת getQuestionResult

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קונפיגור את אימות מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל 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	Yes
urlId	string	query	No
userId	string	query	No
startDate	string	query	No
questionId	string	query	No
questionIds	string	query	No
skip	number	query	No

תגובה

מחזיר: 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';
// בטל את ההערה למטה כדי להגדיר קידומת (e.g. Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateQuestionResultBody = UpdateQuestionResultBody(); // UpdateQuestionResultBody | 
try {
    final result = api_instance.updateQuestionResult(tenantId, id, updateQuestionResultBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateQuestionResult: $e\n');
}

אגרגציית תוצאות שאלות

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
questionId	string	query	לא
questionIds	array	query	לא
urlId	string	query	לא
timeBucket	string	query	לא
startDate	string	query	לא
forceRecalculate	boolean	query	לא

תגובה

מחזיר: AggregateQuestionResultsResponse

דוגמה

דוגמת aggregateQuestionResults

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר אימות מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (לדוגמה 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');
}

אגרגציית תוצאות שאלות בקבוצה

Parameters

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	Yes
forceRecalculate	boolean	query	No

Response

מחזיר: BulkAggregateQuestionResultsResponse

Example

bulkAggregateQuestionResults דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח ה-API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final bulkAggregateQuestionResultsRequest = BulkAggregateQuestionResultsRequest(); // BulkAggregateQuestionResultsRequest | 
final forceRecalculate = true; // bool | 
try {
    final result = api_instance.bulkAggregateQuestionResults(tenantId, bulkAggregateQuestionResultsRequest, forceRecalculate);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->bulkAggregateQuestionResults: $e\n');
}

צרף תגובות עם תוצאות שאלות

Parameters

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

Response

מחזיר: CombineQuestionResultsWithCommentsResponse

Example

דוגמה של 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	כן

תגובה

מחזיר: AddSSOUserAPIResponse

דוגמה

addSSOUser דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (כגון Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createAPISSOUserData = CreateAPISSOUserData(); // CreateAPISSOUserData | 
try {
    final result = api_instance.addSSOUser(tenantId, createAPISSOUserData);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addSSOUser: $e\n');
}

מחק משתמש SSO

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	Yes
id	string	path	Yes
deleteComments	boolean	query	No
commentDeleteMode	string	query	No

תגובה

מחזיר: DeleteSSOUserAPIResponse

דוגמה

דוגמת deleteSSOUser

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח ה-API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final deleteComments = true; // bool | 
final commentDeleteMode = commentDeleteMode_example; // String | 
try {
    final result = api_instance.deleteSSOUser(tenantId, id, DeleteSSOUserOptions(deleteComments: deleteComments, commentDeleteMode: commentDeleteMode));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteSSOUser: $e\n');
}

קבל משתמש SSO לפי אימייל

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
email	string	path	כן

תגובה

מחזיר: GetSSOUserByEmailAPIResponse

דוגמה

דוגמת getSSOUserByEmail

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדרת הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה שלהלן כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final email = email_example; // String | 
try {
    final result = api_instance.getSSOUserByEmail(tenantId, email);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSSOUserByEmail: $e\n');
}

קבל משתמש SSO לפי מזהה

Parameters

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	Yes
id	string	path	Yes

Response

מחזיר: GetSSOUserByIdAPIResponse

דוגמה

דוגמה getSSOUserById

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

קבל משתמשי SSO

Parameters

Name	Type	Location	Required	Description
tenantId	string	query	כן
skip	integer	query	לא

Response

מחזיר: GetSSOUsersResponse

Example

getSSOUsers דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדרת הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח ה-API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final skip = 56; // int | 
try {
    final result = api_instance.getSSOUsers(tenantId, skip);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSSOUsers: $e\n');
}

עדכן חלקית משתמש SSO

פרמטרים

שם	סוג	מיקום	חובה
tenantId	string	query	Yes
id	string	path	Yes
updateComments	boolean	query	No

תגובה

מחזיר: PatchSSOUserAPIResponse

דוגמה

patchSSOUser דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (לדוגמה Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateAPISSOUserData = UpdateAPISSOUserData(); // UpdateAPISSOUserData | 
final updateComments = true; // bool | 
try {
    final result = api_instance.patchSSOUser(tenantId, id, updateAPISSOUserData, updateComments);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->patchSSOUser: $e\n');
}

הציב משתמש SSO

פרמטרים

שם	סוג	מיקום	חובה
tenantId	string	query	Yes
id	string	path	Yes
updateComments	boolean	query	No

תגובה

מחזיר: PutSSOUserAPIResponse

דוגמה

דוגמת putSSOUser

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קונפיגורציה של אימות מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// הסירו את ההערה למטה כדי להגדיר קידומת (לדוגמה Bearer) למפתח API, אם נדרש
//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');
}

צור מנוי

Parameters

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן

Response

Returns: CreateSubscriptionAPIResponse

Example

דוגמת createSubscription

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

מחק מנוי

Parameters

Name	Type	Location	Required
tenantId	string	query	כן
id	string	path	כן
userId	string	query	לא

Response

Returns: DeleteSubscriptionAPIResponse

Example

דוגמת deleteSubscription

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

קבל מנויים

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
userId	string	query	לא

תגובה

מחזיר: GetSubscriptionsAPIResponse

דוגמה

דוגמת getSubscriptions

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קביעת אישור מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (לדוגמה Bearer) עבור מפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final userId = userId_example; // String | 
try {
    final result = api_instance.getSubscriptions(tenantId, userId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSubscriptions: $e\n');
}

עדכן מנוי

Parameters

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
id	string	path	כן
userId	string	query	לא

Response

מחזיר: UpdateSubscriptionAPIResponse

Example

דוגמת updateSubscription

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר אימות מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// ביטול ההערה למטה כדי להגדיר קידומת (למשל Bearer) עבור מפתח ה-API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateAPIUserSubscriptionData = UpdateAPIUserSubscriptionData(); // UpdateAPIUserSubscriptionData | 
final userId = userId_example; // String | 
try {
    final result = api_instance.updateSubscription(tenantId, id, updateAPIUserSubscriptionData, userId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateSubscription: $e\n');
}

קבל שימוש יומי של שוכרים

Parameters

Name	Type	Location	Required
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	Yes

תגובה

מחזיר: CreateTenantPackageResponse

דוגמה

דוגמת createTenantPackage

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קביעת הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createTenantPackageBody = CreateTenantPackageBody(); // CreateTenantPackageBody | 
try {
    final result = api_instance.createTenantPackage(tenantId, createTenantPackageBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createTenantPackage: $e\n');
}

מחק חבילה לשוכר

פרמטרים

שם	סוג	מיקום	דרוש	תיאור
tenantId	string	query	כן
id	string	path	כן

תגובה

Returns: APIEmptyResponse

דוגמה

דוגמה deleteTenantPackage

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

קבל חבילות שוכרים

Parameters

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	Yes
skip	number	query	No

Response

מחזיר: GetTenantPackagesResponse

Example

דוגמה 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';
// בטל הערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final replaceTenantPackageBody = ReplaceTenantPackageBody(); // ReplaceTenantPackageBody | 
try {
    final result = api_instance.replaceTenantPackage(tenantId, id, replaceTenantPackageBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->replaceTenantPackage: $e\n');
}

עדכן חבילה לשוכר

פרמטרים

שם	סוג	מיקום	חובה	תיאור
tenantId	string	query	כן
id	string	path	כן

תגובה

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

צור משתמש שוכר

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	Yes

תגובה

מחזיר: CreateTenantUserResponse

דוגמה

דוגמת createTenantUser

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדירו הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטלו את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח ה-API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createTenantUserBody = CreateTenantUserBody(); // CreateTenantUserBody | 
try {
    final result = api_instance.createTenantUser(tenantId, createTenantUserBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createTenantUser: $e\n');
}

מחק משתמש שוכר

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	Yes
id	string	path	Yes
deleteComments	string	query	No
commentDeleteMode	string	query	No

תשובה

מחזיר: APIEmptyResponse

דוגמה

deleteTenantUser דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final deleteComments = deleteComments_example; // String | 
final commentDeleteMode = commentDeleteMode_example; // String | 
try {
    final result = api_instance.deleteTenantUser(tenantId, id, DeleteTenantUserOptions(deleteComments: deleteComments, commentDeleteMode: commentDeleteMode));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteTenantUser: $e\n');
}

קבל משתמש שוכר

פרמטרים

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

תגובה

מחזיר: GetTenantUserResponse

דוגמה

דוגמת getTenantUser

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קבע הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח ה-API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.getTenantUser(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTenantUser: $e\n');
}

קבל משתמשי שוכר

פרמטרים

שם	סוג	מיקום	חובה	תיאור
tenantId	string	query	כן
skip	number	query	לא

תגובה

מחזיר: 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	Yes
id	string	path	Yes
updateComments	string	query	No

תגובה

מחזיר: APIEmptyResponse

דוגמה

replaceTenantUser דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קונפיגורציה של הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי לקבוע קידומת (למשל 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	Yes
id	string	path	Yes
redirectURL	string	query	No

תשובה

מחזיר: APIEmptyResponse

דוגמה

sendLoginLink דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדרת אימות מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final redirectURL = redirectURL_example; // String | 
try {
    final result = api_instance.sendLoginLink(tenantId, id, redirectURL);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->sendLoginLink: $e\n');
}

עדכן משתמש שוכר

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
id	string	path	כן
updateComments	string	query	לא

תגובה

מחזיר: APIEmptyResponse

דוגמה

דוגמת updateTenantUser

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר אימות של מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטלו את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateTenantUserBody = UpdateTenantUserBody(); // UpdateTenantUserBody | 
final updateComments = updateComments_example; // String | 
try {
    final result = api_instance.updateTenantUser(tenantId, id, updateTenantUserBody, updateComments);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateTenantUser: $e\n');
}

צור שוכר

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	Yes

תגובה

מחזיר: CreateTenantResponse

דוגמה

דוגמת createTenant

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קביעת הרשאה של מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם יש צורך
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createTenantBody = CreateTenantBody(); // CreateTenantBody | 
try {
    final result = api_instance.createTenant(tenantId, createTenantBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createTenant: $e\n');
}

מחק שוכר

פרמטרים

שם	סוג	מיקום	חובה
tenantId	string	query	כן
id	string	path	כן
sure	string	query	לא

תגובה

מחזיר: APIEmptyResponse

דוגמה

deleteTenant דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final sure = sure_example; // String | 
try {
    final result = api_instance.deleteTenant(tenantId, id, sure);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteTenant: $e\n');
}

קבל שוכר

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	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

תגובה

מחזיר: GetTenantsResponse

דוגמה

דוגמת getTenants

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קבע הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final meta = meta_example; // String | 
final skip = 1.2; // double | 
try {
    final result = api_instance.getTenants(tenantId, GetTenantsOptions(meta: meta, skip: skip));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTenants: $e\n');
}

עדכן שוכר

Parameters

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

Response

Returns: APIEmptyResponse

Example

דוגמת updateTenant

Copy

import 'package:fastcomments_dart/api.dart';
// TODO להגדיר הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// ביטול ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח ה-API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final updateTenantBody = UpdateTenantBody(); // UpdateTenantBody | 
try {
    final result = api_instance.updateTenant(tenantId, id, updateTenantBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateTenant: $e\n');
}

שנה מצב כרטיס

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	Yes
userId	string	query	Yes
id	string	path	Yes

תגובה

מחזיר: ChangeTicketStateResponse

דוגמה

דוגמה ל‑changeTicketState

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קונפיגורציית הרשאה למפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// הסר את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח ה‑API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final userId = userId_example; // String | 
final id = id_example; // String | 
final changeTicketStateBody = ChangeTicketStateBody(); // ChangeTicketStateBody | 
try {
    final result = api_instance.changeTicketState(tenantId, userId, id, changeTicketStateBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->changeTicketState: $e\n');
}

צור כרטיס

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	Yes
userId	string	query	Yes

תגובה

מחזיר: CreateTicketResponse

דוגמה

דוגמת createTicket

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר אימות מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה שלהלן כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final userId = userId_example; // String | 
final createTicketBody = CreateTicketBody(); // CreateTicketBody | 
try {
    final result = api_instance.createTicket(tenantId, userId, createTicketBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createTicket: $e\n');
}

קבל כרטיס

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
id	string	path	כן
userId	string	query	לא

תגובה

מחזיר: GetTicketResponse

דוגמה

דוגמת getTicket

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר את האימות עם מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל 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');
}

קבל כרטיסים

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
userId	string	query	לא
state	number	query	לא
skip	number	query	לא
limit	number	query	לא

תגובה

מחזיר: GetTicketsResponse

דוגמה

getTickets דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קבע הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final userId = userId_example; // String | 
final state = 1.2; // double | 
final skip = 1.2; // double | 
final limit = 1.2; // double | 
try {
    final result = api_instance.getTickets(tenantId, GetTicketsOptions(userId: userId, state: state, skip: skip, limit: limit));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTickets: $e\n');
}

קבל תרגומים

פרמטרים

שם	סוג	מיקום	נדרש
namespace	string	path	Yes
component	string	path	Yes
locale	string	query	No
useFullTranslationIds	boolean	query	No

תגובה

מחזיר: GetTranslationsResponse

דוגמה

דוגמת getTranslations

Copy

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

העלה תמונה

העלאה ושינוי גודל של תמונה

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	path	כן
sizePreset	string	query	לא	תבנית גודל: "Default" (1000x1000px) או "CrossPlatform" (יוצר גדלים למכשירים פופולריים)
urlId	string	query	לא	מזהה דף שממנו מתבצעת ההעלאה, להגדרה

תגובה

מחזיר: 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 | מזהה דף שממנו מתבצעת ההעלאה, להגדרה
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');
}

קבל התקדמות תו משתמש לפי מזהה

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	Yes
id	string	path	Yes

תגובה

מחזיר: APIGetUserBadgeProgressResponse

דוגמה

דוגמה לgetUserBadgeProgressById

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קונפיגורציית הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// הסר את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם צריך
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.getUserBadgeProgressById(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUserBadgeProgressById: $e\n');
}

קבל התקדמות תו משתמש לפי מזהה משתמש

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	Yes
userId	string	path	Yes

תגובה

מחזיר: APIGetUserBadgeProgressResponse

דוגמה

דוגמה ל-getUserBadgeProgressByUserId

Copy

import 'package:fastcomments_dart/api.dart';
// TODO: הגדר אישור מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// הסירו את ההערה למטה כדי להגדיר קידומת (לדוגמה, Bearer) למפתח ה-API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final userId = userId_example; // String | 
try {
    final result = api_instance.getUserBadgeProgressByUserId(tenantId, userId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUserBadgeProgressByUserId: $e\n');
}

קבל רשימת התקדמות תו משתמש

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	Yes
userId	string	query	No
limit	number	query	No
skip	number	query	No

תשובה

מחזיר: APIGetUserBadgeProgressListResponse

דוגמה

דוגמה getUserBadgeProgressList

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final userId = userId_example; // String | 
final limit = 1.2; // double | 
final skip = 1.2; // double | 
try {
    final result = api_instance.getUserBadgeProgressList(tenantId, GetUserBadgeProgressListOptions(userId: userId, limit: limit, skip: skip));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUserBadgeProgressList: $e\n');
}

צור תו משתמש

Parameters

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן

Response

מחזיר: APICreateUserBadgeResponse

Example

createUserBadge דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קונפיגור את הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final createUserBadgeParams = CreateUserBadgeParams(); // CreateUserBadgeParams | 
try {
    final result = api_instance.createUserBadge(tenantId, createUserBadgeParams);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createUserBadge: $e\n');
}

מחק תו משתמש

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: APIEmptySuccessResponse

דוגמה

דוגמת 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 key: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.getUserBadge(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUserBadge: $e\n');
}

קבל תגים למשתמש

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
userId	string	query	לא
badgeId	string	query	לא
type	number	query	לא
displayedOnComments	boolean	query	לא
limit	number	query	לא
skip	number	query	לא

תגובה

מחזיר: APIGetUserBadgesResponse

דוגמה

getUserBadges דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קבעו הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטלו את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final userId = userId_example; // String | 
final badgeId = badgeId_example; // String | 
final type = 1.2; // double | 
final displayedOnComments = true; // bool | 
final limit = 1.2; // double | 
final skip = 1.2; // double | 
try {
    final result = api_instance.getUserBadges(tenantId, GetUserBadgesOptions(userId: userId, badgeId: badgeId, type: type, displayedOnComments: displayedOnComments, limit: limit, skip: skip));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUserBadges: $e\n');
}

עדכן תו משתמש

Parameters

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

Response

מחזיר: APIEmptySuccessResponse

Example

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

קבל התראות משתמש

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
urlId	string	query	לא	משמש לקביעת האם הדף הנוכחי מנוי.
pageSize	integer	query	לא
afterId	string	query	לא
includeContext	boolean	query	לא
afterCreatedAt	integer	query	לא
unreadOnly	boolean	query	לא
dmOnly	boolean	query	לא
noDm	boolean	query	לא
includeTranslations	boolean	query	לא
includeTenantNotifications	boolean	query	לא
sso	string	query	לא

תגובה

מחזיר: GetMyNotificationsResponse

דוגמה

דוגמת getUserNotifications

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // String |
final urlId = urlId_example; // String | משמש לקביעת האם הדף הנוכחי מנוי.
final pageSize = 56; // int |
final afterId = afterId_example; // String |
final includeContext = true; // bool |
final afterCreatedAt = 789; // int |
final unreadOnly = true; // bool |
final dmOnly = true; // bool |
final noDm = true; // bool |
final includeTranslations = true; // bool |
final includeTenantNotifications = true; // bool |
final sso = sso_example; // String |
try {
    final result = api_instance.getUserNotifications(tenantId, GetUserNotificationsOptions(urlId: urlId, pageSize: pageSize, afterId: afterId, includeContext: includeContext, afterCreatedAt: afterCreatedAt, unreadOnly: unreadOnly, dmOnly: dmOnly, noDm: noDm, includeTranslations: includeTranslations, includeTenantNotifications: includeTenantNotifications, sso: sno));
    print(result);
} catch (e) {
    print('Exception when calling PublicApi->getUserNotifications: $e\n');
}

אפס ספירת התראות משתמש

פרמטרים

שם	סוג	מיקום	דרוש	תיאור
tenantId	string	query	כן
sso	string	query	לא

תגובה

מחזיר: ResetUserNotificationsResponse

דוגמה

דוגמת resetUserNotificationCount

Copy

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

אפס התראות משתמש

פרמטרים

שם	סוג	מיקום	חובה
tenantId	string	query	כן
afterId	string	query	לא
afterCreatedAt	integer	query	לא
unreadOnly	boolean	query	לא
dmOnly	boolean	query	לא
noDm	boolean	query	לא
sso	string	query	לא

תגובה

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

עדכן סטטוס מנוי למשתמש עבור תגובות

הפעל או בטל התראות לתגובה ספציפית.

Parameters

שם	סוג	מיקום	חובה
tenantId	string	query	כן
notificationId	string	path	כן
optedInOrOut	string	path	כן
commentId	string	query	כן
sso	string	query	לא

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

עדכן סטטוס מנוי למשתמש עבור עמודים

Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also
להפעיל או להשבית התראות עבור דף. כאשר משתמשים מנויים לדף, נוצרות התראות עבור תגובות שורש חדשות, וכן

פרמטרים

שם	סוג	מיקום	נדרש
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	Yes
notificationId	string	path	Yes
newStatus	string	path	Yes
sso	string	query	No

תגובה

מחזיר: UpdateUserNotificationStatusResponse

דוגמה

updateUserNotificationStatus דוגמה

Copy

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

קבל סטטוס נוכחות משתמשים

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	Yes
urlIdWS	string	query	Yes
userIds	string	query	Yes

תגובה

מחזיר: GetUserPresenceStatusesResponse

דוגמה

דוגמת getUserPresenceStatuses

Copy

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

חפש משתמשים

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	path	Yes
urlId	string	query	Yes
usernameStartsWith	string	query	No
mentionGroupIds	array	query	No
sso	string	query	No
searchSection	string	query	No

תגובה

מחזיר: SearchUsersResult

דוגמה

דוגמת searchUsers

Copy

import 'package:fastcomments_dart/api.dart';
final api_instance = PublicApi();
final tenantId = tenantId_example; // מחרוזת | 
final urlId = urlId_example; // מחרוזת | 
final usernameStartsWith = usernameStartsWith_example; // מחרוזת | 
final mentionGroupIds = []; // רשימה<String> | 
final sso = sso_example; // מחרוזת | 
final searchSection = searchSection_example; // מחרוזת | 
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');
}

קבל משתמש

Parameters

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

Response

Returns: GetUserResponse

Example

דוגמת getUser

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קונפיגורציה של הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל הערה להלן כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
try {
    final result = api_instance.getUser(tenantId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUser: $e\n');
}

צור הצבעה

Parameters

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
commentId	string	query	כן
direction	string	query	כן
userId	string	query	לא
anonUserId	string	query	לא

Response

מחזיר: VoteResponse

דוגמה

createVote דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// הסר את ההערה למטה כדי להגדיר קידומת (e.g. Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final commentId = commentId_example; // String | 
final direction = direction_example; // String | 
final userId = userId_example; // String | 
final anonUserId = anonUserId_example; // String | 
try {
    final result = api_instance.createVote(tenantId, commentId, direction, CreateVoteOptions(userId: userId, anonUserId: anonUserId));
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createVote: $e\n');
}

מחק הצבעה

פרמטרים

שם	סוג	מיקום	חובה
tenantId	string	query	Yes
id	string	path	Yes
editKey	string	query	No

תשובה

מחזיר: VoteDeleteResponse

דוגמה

deleteVote דוגמה

Copy

import 'package:fastcomments_dart/api.dart';
// TODO קונפיגור את הרשאת מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה של השורה למטה כדי להגדיר קידומת (לדוגמה Bearer) עבור מפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final id = id_example; // String | 
final editKey = editKey_example; // String | 
try {
    final result = api_instance.deleteVote(tenantId, id, editKey);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteVote: $e\n');
}

קבל הצבעות

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	Yes
urlId	string	query	Yes

תגובה

מחזיר: GetVotesResponse

דוגמה

דוגמת getVotes

Copy

import 'package:fastcomments_dart/api.dart';
// TODO הגדר אישור מפתח API: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// בטל את ההערה למטה כדי להגדיר קידומת (לדוגמה Bearer) למפתח API, אם נדרש
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
final api_instance = DefaultApi();
final tenantId = tenantId_example; // String | 
final urlId = urlId_example; // String | 
try {
    final result = api_instance.getVotes(tenantId, urlId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getVotes: $e\n');
}

קבל הצבעות למשתמש

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
urlId	string	query	כן
userId	string	query	לא
anonUserId	string	query	לא

תגובה

מחזיר: 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');
}

Need Help?

If you encounter any issues or have questions about the Dart SDK, please:

Contributing

Contributions are welcome! Please visit the GitHub repository for contribution guidelines.

שפה 🇮🇱 עברית

תיעוד

צבר

יומני ביקורת

אימות

חסימה מהתגובה

בדיקת תגובות חסומות

תגובות

תגובות למשתמש

תצורות דומיין

תבניות אימייל

יומן אירועים

פוסטים בפיד

סימון תגובה

GIFים

האשטאגים

פיקוח

מודרטורים

ספירת התראות

התראות

תגובות לעמוד

עמודים

אירועים ממתינים של webhook

קונפיגורציות שאלות

תוצאות שאלות

אגרגציית תוצאות שאלות

משתמשי SSO

מנויים

שימוש יומי של שוכר

חבילות שוכרים

משתמשי שוכר

שוכרים

כרטיסים

תרגומים

העלאת תמונה

התקדמות תו משתמש

תגים למשתמש

התראות משתמש

סטטוס נוכחות משתמש

חיפוש משתמשים

משתמשים

הצבעות

FastComments Dart SDK

מאגר

פריסה

שימוש

SSO

צבר

Parameters

Response

Example

קבל יומני ביקורת

פרמטרים

תגובה

דוגמה

התנתק ציבורי

תגובה

דוגמה

חסום מהתגובה ציבורי

פרמטרים

תגובה

דוגמה

בטל חסימת תגובה ציבורי

פרמטרים

תגובה

דוגמה

תגובות שנבדקו לחסימה

פרמטרים

תגובה

דוגמה

חסום משתמש מהתגובה

פרמטרים

תגובה

דוגמה

צור תגובה ציבורית

Parameters

תגובה

דוגמה

מחק תגובה

פרמטרים