FastComments.com

FastComments Dart SDK

Dies ist das offizielle Dart‑SDK für FastComments.

Verwalten Sie Kommentare, Benutzer, SSO und Moderation aus Ihren Dart‑ und Flutter‑Anwendungen.

Repository

Auf GitHub ansehen

Layout Internal Link


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

SSO Internal Link

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();

Aggregieren Internal Link

Aggregiert Dokumente, indem sie (falls groupBy angegeben ist) gruppiert und mehrere Vorgänge angewendet werden.
Verschiedene Vorgänge (z. B. sum, countDistinct, avg usw.) werden unterstützt.

Parameter

NameTypeLocationRequiredDescription
tenantIdstringqueryJa
parentTenantIdstringqueryNein
includeStatsbooleanqueryNein

Antwort

Rückgabe: AggregateResponse

Beispiel

Aggregationsbeispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entkommentiere unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final aggregationRequest = AggregationRequest(); // AggregationRequest |
11final parentTenantId = parentTenantId_example; // String |
12final includeStats = true; // bool |
13
14try {
15 final result = api_instance.aggregate(tenantId, aggregationRequest, AggregateOptions(parentTenantId: parentTenantId, includeStats: includeStats));
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->aggregate: $e\n');
19}
20

Auditprotokolle abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
limitnumberqueryNein
skipnumberqueryNein
orderstringqueryNein
afternumberqueryNein
beforenumberqueryNein

Antwort

Rückgabe: GetAuditLogsResponse

Beispiel

getAuditLogs Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüsselautorisierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie das Kommentarzeichen unten, um das Präfix (z. B. Bearer) für den API-Schlüssel festzulegen, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final limit = 1.2; // double |
11final skip = 1.2; // double |
12final order = ; // SORTDIR |
13final after = 1.2; // double |
14final before = 1.2; // double |
15
16try {
17 final result = api_instance.getAuditLogs(tenantId, GetAuditLogsOptions(limit: limit, skip: skip, order: order, after: after, before: before));
18 print(result);
19} catch (e) {
20 print('Exception when calling DefaultApi->getAuditLogs: $e\n');
21}
22

Öffentlichen Logout Internal Link

Response

Returns: APIEmptyResponse

Example

logoutPublic Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5
6try {
7 final result = api_instance.logoutPublic();
8 print(result);
9} catch (e) {
10 print('Exception when calling PublicApi->logoutPublic: $e\n');
11}
12

Öffentliches Blockieren aus Kommentar Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
commentIdstringpathJa
ssostringqueryNein

Antwort

Rückgabe: BlockSuccess

Beispiel

blockFromCommentPublic Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final publicBlockFromCommentParams = PublicBlockFromCommentParams(); // PublicBlockFromCommentParams |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.blockFromCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->blockFromCommentPublic: $e\n');
15}
16

Öffentliches Blockieren aufheben Kommentar Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
commentIdstringpathJa
ssostringqueryNein

Antwort

Rückgabe: UnblockSuccess

Beispiel

unBlockCommentPublic Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final publicBlockFromCommentParams = PublicBlockFromCommentParams(); // PublicBlockFromCommentParams |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.unBlockCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->unBlockCommentPublic: $e\n');
15}
16

Überprüfte Kommentare auf Blockierung Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
commentIdsstringqueryJaEine kommagetrennte Liste von Kommentar-IDs.
ssostringqueryNein

Antwort

Rückgabe: CheckBlockedCommentsResponse

Beispiel

checkedCommentsForBlocked Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentIds = commentIds_example; // String | Eine kommagetrennte Liste von Kommentar-IDs.
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.checkedCommentsForBlocked(tenantId, commentIds, sso);
11 print(result);
12} catch (e) {
13 print('Exception when calling PublicApi->checkedCommentsForBlocked: $e\n');
14}
15

Benutzer aus Kommentar blockieren Internal Link

Parameters

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo
anonUserIdstringqueryNo

Response

Rückgabe: BlockSuccess

Beispiel

blockUserFromComment Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// entferne das Kommentarzeichen unten, um das Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final blockFromCommentParams = BlockFromCommentParams(); // BlockFromCommentParams |
12final userId = userId_example; // String |
13final anonUserId = anonUserId_example; // String |
14
15try {
16 final result = api_instance.blockUserFromComment(tenantId, id, blockFromCommentParams, BlockUserFromCommentOptions(userId: userId, anonUserId: anonUserId));
17 print(result);
18} catch (e) {
19 print('Exception when calling DefaultApi->blockUserFromComment: $e\n');
20}
21

Öffentlichen Kommentar erstellen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJa
urlIdstringqueryJa
broadcastIdstringqueryJa
sessionIdstringqueryNein
ssostringqueryNein

Antwort

Returns: SaveCommentsResponseWithPresence

Beispiel

createCommentPublic Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7final broadcastId = broadcastId_example; // String |
8final commentData = CommentData(); // CommentData |
9final sessionId = sessionId_example; // String |
10final sso = sso_example; // String |
11
12try {
13 final result = api_instance.createCommentPublic(tenantId, urlId, broadcastId, commentData, CreateCommentPublicOptions(sessionId: sessionId, sso: sso));
14 print(result);
15} catch (e) {
16 print('Exception when calling PublicApi->createCommentPublic: $e\n');
17}
18

Kommentar löschen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa
contextUserIdstringqueryNein
isLivebooleanqueryNein

Antwort

Rückgabe: DeleteCommentResult

Beispiel

deleteComment Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie das Kommentarzeichen unten, um das Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final contextUserId = contextUserId_example; // String |
12final isLive = true; // bool |
13
14try {
15 final result = api_instance.deleteComment(tenantId, id, DeleteCommentOptions(contextUserId: contextUserId, isLive: isLive));
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->deleteComment: $e\n');
19}
20

Öffentlichen Kommentar löschen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJa
commentIdstringpathJa
broadcastIdstringqueryJa
editKeystringqueryNein
ssostringqueryNein

Antwort

Rückgabe: PublicAPIDeleteCommentResponse

Beispiel

deleteCommentPublic Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final broadcastId = broadcastId_example; // String |
8final editKey = editKey_example; // String |
9final sso = sso_example; // String |
10
11try {
12 final result = api_instance.deleteCommentPublic(tenantId, commentId, broadcastId, DeleteCommentPublicOptions(editKey: editKey, sso: sso));
13 print(result);
14} catch (e) {
15 print('Exception when calling PublicApi->deleteCommentPublic: $e\n');
16}
17

Kommentarbewertung löschen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathYes
commentIdstringpathYes
voteIdstringpathYes
urlIdstringqueryYes
broadcastIdstringqueryYes
editKeystringqueryNo
ssostringqueryNo

Antwort

Rückgabe: VoteDeleteResponse

Beispiel

deleteCommentVote Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final voteId = voteId_example; // String |
8final urlId = urlId_example; // String |
9final broadcastId = broadcastId_example; // String |
10final editKey = editKey_example; // String |
11final sso = sso_example; // String |
12
13try {
14 final result = api_instance.deleteCommentVote(tenantId, commentId, voteId, urlId, broadcastId, DeleteCommentVoteOptions(editKey: editKey, sso: sso));
15 print(result);
16} catch (e) {
17 print('Exception when calling PublicApi->deleteCommentVote: $e\n');
18}
19

Kommentar melden Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa
userIdstringqueryNein
anonUserIdstringqueryNein

Antwort

Rückgabe: FlagCommentResponse

Beispiel

flagComment Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüssel-Authentifizierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Kommentieren Sie die Zeile unten aus, um ein Präfix (z. B. Bearer) für den API‑Schlüssel festzulegen, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final userId = userId_example; // String |
12final anonUserId = anonUserId_example; // String |
13
14try {
15 final result = api_instance.flagComment(tenantId, id, FlagCommentOptions(userId: userId, anonUserId: anonUserId));
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->flagComment: $e\n');
19}
20

Kommentar abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa

Antwort

Rückgabe: APIGetCommentResponse

Beispiel

getComment Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um das Präfix (z.B. Bearer) für den API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getComment(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getComment: $e\n');
17}
18

Kommentare abrufen Internal Link

Parameter

NameTypeLocationRequiredDescription
tenantIdstringqueryJa
pageintegerqueryNein
limitintegerqueryNein
skipintegerqueryNein
asTreebooleanqueryNein
skipChildrenintegerqueryNein
limitChildrenintegerqueryNein
maxTreeDepthintegerqueryNein
urlIdstringqueryNein
userIdstringqueryNein
anonUserIdstringqueryNein
contextUserIdstringqueryNein
hashTagstringqueryNein
parentIdstringqueryNein
directionstringqueryNein
fromDateintegerqueryNein
toDateintegerqueryNein

Antwort

Returns: APIGetCommentsResponse

Beispiel

getComments Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüssel-Authentifizierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie das Kommentarzeichen unten, um das Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final page = 56; // int |
11final limit = 56; // int |
12final skip = 56; // int |
13final asTree = true; // bool |
14final skipChildren = 56; // int |
15final limitChildren = 56; // int |
16final maxTreeDepth = 56; // int |
17final urlId = urlId_example; // String |
18final userId = userId_example; // String |
19final anonUserId = anonUserId_example; // String |
20final contextUserId = contextUserId_example; // String |
21final hashTag = hashTag_example; // String |
22final parentId = parentId_example; // String |
23final direction = ; // SortDirections |
24final fromDate = 789; // int |
25final toDate = 789; // int |
26
27try {
28 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));
29 print(result);
30} catch (e) {
31 print('Exception when calling DefaultApi->getComments: $e\n');
32}
33

Öffentliche Kommentare abrufen Internal Link

Anfrage
tenantId
urlId

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJa
urlIdstringqueryJa
pageintegerqueryNein
directionstringqueryNein
ssostringqueryNein
skipintegerqueryNein
skipChildrenintegerqueryNein
limitintegerqueryNein
limitChildrenintegerqueryNein
countChildrenbooleanqueryNein
fetchPageForCommentIdstringqueryNein
includeConfigbooleanqueryNein
countAllbooleanqueryNein
includei10nbooleanqueryNein
localestringqueryNein
modulesstringqueryNein
isCrawlerbooleanqueryNein
includeNotificationCountbooleanqueryNein
asTreebooleanqueryNein
maxTreeDepthintegerqueryNein
useFullTranslationIdsbooleanqueryNein
parentIdstringqueryNein
searchTextstringqueryNein
hashTagsarrayqueryNein
userIdstringqueryNein
customConfigStrstringqueryNein
afterCommentIdstringqueryNein
beforeCommentIdstringqueryNein

Antwort

Rückgabe: GetCommentsPublicResponseWithPresencePublicComment

Beispiel

getCommentsPublic Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7final page = 56; // int |
8final direction = ; // SortDirections |
9final sso = sso_example; // String |
10final skip = 56; // int |
11final skipChildren = 56; // int |
12final limit = 56; // int |
13final limitChildren = 56; // int |
14final countChildren = true; // bool |
15final fetchPageForCommentId = fetchPageForCommentId_example; // String |
16final includeConfig = true; // bool |
17final countAll = true; // bool |
18final includei10n = true; // bool |
19final locale = locale_example; // String |
20final modules = modules_example; // String |
21final isCrawler = true; // bool |
22final includeNotificationCount = true; // bool |
23final asTree = true; // bool |
24final maxTreeDepth = 56; // int |
25final useFullTranslationIds = true; // bool |
26final parentId = parentId_example; // String |
27final searchText = searchText_example; // String |
28final hashTags = []; // List<String> |
29final userId = userId_example; // String |
30final customConfigStr = customConfigStr_example; // String |
31final afterCommentId = afterCommentId_example; // String |
32final beforeCommentId = beforeCommentId_example; // String |
33
34try {
35 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));
36 print(result);
37} catch (e) {
38 print('Exception when calling PublicApi->getCommentsPublic: $e\n');
39}
40

Kommentartext abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJa
commentIdstringpathJa
editKeystringqueryNein
ssostringqueryNein

Antwort

Rückgabe: PublicAPIGetCommentTextResponse

Beispiel

getCommentText Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final editKey = editKey_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.getCommentText(tenantId, commentId, GetCommentTextOptions(editKey: editKey, sso: sso));
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->getCommentText: $e\n');
15}
16

Namen der Benutzer, die den Kommentar bewertet haben, abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathYes
commentIdstringpathYes
dirintegerqueryYes
ssostringqueryNo

Antwort

Rückgabe: GetCommentVoteUserNamesSuccessResponse

Beispiel

getCommentVoteUserNames Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final dir = 56; // int |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.getCommentVoteUserNames(tenantId, commentId, dir, sso);
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->getCommentVoteUserNames: $e\n');
15}
16

Kommentar sperren Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathYes
commentIdstringpathYes
broadcastIdstringqueryYes
ssostringqueryNo

Antwort

Returns: APIEmptyResponse

Beispiel

lockComment Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final broadcastId = broadcastId_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.lockComment(tenantId, commentId, broadcastId, sso);
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->lockComment: $e\n');
15}
16

Kommentar anheften Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJa
commentIdstringpathJa
broadcastIdstringqueryJa
ssostringqueryNein

Antwort

Rückgabe: ChangeCommentPinStatusResponse

Beispiel

pinComment Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final broadcastId = broadcastId_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.pinComment(tenantId, commentId, broadcastId, sso);
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->pinComment: $e\n');
15}
16

Kommentar speichern Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
isLivebooleanqueryNo
doSpamCheckbooleanqueryNo
sendEmailsbooleanqueryNo
populateNotificationsbooleanqueryNo

Antwort

Returns: APISaveCommentResponse

Beispiel

saveComment Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Autorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Zeile unten auskommentieren, um Präfix (z.B. Bearer) für den API-Schlüssel festzulegen, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createCommentParams = CreateCommentParams(); // CreateCommentParams |
11final isLive = true; // bool |
12final doSpamCheck = true; // bool |
13final sendEmails = true; // bool |
14final populateNotifications = true; // bool |
15
16try {
17 final result = api_instance.saveComment(tenantId, createCommentParams, SaveCommentOptions(isLive: isLive, doSpamCheck: doSpamCheck, sendEmails: sendEmails, populateNotifications: populateNotifications));
18 print(result);
19} catch (e) {
20 print('Exception when calling DefaultApi->saveComment: $e\n');
21}
22

Mehrere Kommentare speichern Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
isLivebooleanqueryNein
doSpamCheckbooleanqueryNein
sendEmailsbooleanqueryNein
populateNotificationsbooleanqueryNein

Antwort

Gibt zurück: SaveCommentsBulkResponse

Beispiel

saveCommentsBulk Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Autorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um das Präfix (z.B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createCommentParams = [List<CreateCommentParams>()]; // List<CreateCommentParams> |
11final isLive = true; // bool |
12final doSpamCheck = true; // bool |
13final sendEmails = true; // bool |
14final populateNotifications = true; // bool |
15
16try {
17 final result = api_instance.saveCommentsBulk(tenantId, createCommentParams, SaveCommentsBulkOptions(isLive: isLive, doSpamCheck: doSpamCheck, sendEmails: sendEmails, populateNotifications: populateNotifications));
18 print(result);
19} catch (e) {
20 print('Exception when calling DefaultApi->saveCommentsBulk: $e\n');
21}
22

Kommentartext festlegen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathYes
commentIdstringpathYes
broadcastIdstringqueryYes
editKeystringqueryNo
ssostringqueryNo

Antwort

Rückgabe: PublicAPISetCommentTextResponse

Beispiel

setCommentText Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final broadcastId = broadcastId_example; // String |
8final commentTextUpdateRequest = CommentTextUpdateRequest(); // CommentTextUpdateRequest |
9final editKey = editKey_example; // String |
10final sso = sso_example; // String |
11
12try {
13 final result = api_instance.setCommentText(tenantId, commentId, broadcastId, commentTextUpdateRequest, SetCommentTextOptions(editKey: editKey, sso: sso));
14 print(result);
15} catch (e) {
16 print('Exception when calling PublicApi->setCommentText: $e\n');
17}
18

Blockierung des Benutzers aus Kommentar aufheben Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo
anonUserIdstringqueryNo

Antwort

Returns: UnblockSuccess

Beispiel

unBlockUserFromComment Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Kommentiere die Zeile unten aus, um ein Präfix (z. B. Bearer) für den API‑Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final unBlockFromCommentParams = UnBlockFromCommentParams(); // UnBlockFromCommentParams |
12final userId = userId_example; // String |
13final anonUserId = anonUserId_example; // String |
14
15try {
16 final result = api_instance.unBlockUserFromComment(tenantId, id, unBlockFromCommentParams, UnBlockUserFromCommentOptions(userId: userId, anonUserId: anonUserId));
17 print(result);
18} catch (e) {
19 print('Exception when calling DefaultApi->unBlockUserFromComment: $e\n');
20}
21

Meldung des Kommentars aufheben Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa
userIdstringqueryNein
anonUserIdstringqueryNein

Antwort

Rückgabe: FlagCommentResponse

Beispiel

unFlagComment Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Auskommentieren Sie unten, um ein Präfix (z.B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final userId = userId_example; // String |
12final anonUserId = anonUserId_example; // String |
13
14try {
15 final result = api_instance.unFlagComment(tenantId, id, UnFlagCommentOptions(userId: userId, anonUserId: anonUserId));
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->unFlagComment: $e\n');
19}
20

Sperre des Kommentars aufheben Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJa
commentIdstringpathJa
broadcastIdstringqueryJa
ssostringqueryNein

Antwort

Rückgabe: APIEmptyResponse

Beispiel

unLockComment Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final broadcastId = broadcastId_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.unLockComment(tenantId, commentId, broadcastId, sso);
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->unLockComment: $e\n');
15}
16

Anheften des Kommentars aufheben Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJa
commentIdstringpathJa
broadcastIdstringqueryJa
ssostringqueryNein

Antwort

Rückgabe: ChangeCommentPinStatusResponse

Beispiel

unPinComment Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final broadcastId = broadcastId_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.unPinComment(tenantId, commentId, broadcastId, sso);
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->unPinComment: $e\n');
15}
16

Kommentar aktualisieren Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa
contextUserIdstringqueryNein
doSpamCheckbooleanqueryNein
isLivebooleanqueryNein

Antwort

Rückgabe: APIEmptyResponse

Beispiel

updateComment Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Autorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Auskommentieren Sie unten, um das Präfix (z.B. Bearer) für den API‑Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updatableCommentParams = UpdatableCommentParams(); // UpdatableCommentParams |
12final contextUserId = contextUserId_example; // String |
13final doSpamCheck = true; // bool |
14final isLive = true; // bool |
15
16try {
17 final result = api_instance.updateComment(tenantId, id, updatableCommentParams, UpdateCommentOptions(contextUserId: contextUserId, doSpamCheck: doSpamCheck, isLive: isLive));
18 print(result);
19} catch (e) {
20 print('Exception when calling DefaultApi->updateComment: $e\n');
21}
22

Kommentar bewerten Internal Link

Parameters

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJa
commentIdstringpathJa
urlIdstringqueryJa
broadcastIdstringqueryJa
sessionIdstringqueryNein
ssostringqueryNein

Response

Rückgabe: VoteResponse

Beispiel

voteComment Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final urlId = urlId_example; // String |
8final broadcastId = broadcastId_example; // String |
9final voteBodyParams = VoteBodyParams(); // VoteBodyParams |
10final sessionId = sessionId_example; // String |
11final sso = sso_example; // String |
12
13try {
14 final result = api_instance.voteComment(tenantId, commentId, urlId, broadcastId, voteBodyParams, VoteCommentOptions(sessionId: sessionId, sso: sso));
15 print(result);
16} catch (e) {
17 print('Exception when calling PublicApi->voteComment: $e\n');
18}
19

Kommentare für Benutzer abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
userIdstringqueryNo
directionstringqueryNo
repliesToUserIdstringqueryNo
pagenumberqueryNo
includei10nbooleanqueryNo
localestringqueryNo
isCrawlerbooleanqueryNo

Antwort

Rückgabe: GetCommentsForUserResponse

Beispiel

getCommentsForUser Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final userId = userId_example; // String |
6final direction = ; // SortDirections |
7final repliesToUserId = repliesToUserId_example; // String |
8final page = 1.2; // double |
9final includei10n = true; // bool |
10final locale = locale_example; // String |
11final isCrawler = true; // bool |
12
13try {
14 final result = api_instance.getCommentsForUser(GetCommentsForUserOptions(userId: userId, direction: direction, repliesToUserId: repliesToUserId, page: page, includei10n: includei10n, locale: locale, isCrawler: isCrawler));
15 print(result);
16} catch (e) {
17 print('Exception when calling PublicApi->getCommentsForUser: $e\n');
18}
19

Domain-Konfiguration hinzufügen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa

Antwort

Rückgabe: AddDomainConfigResponse

Beispiel

addDomainConfig Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API‑Schlüssel‑Authentifizierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final addDomainConfigParams = AddDomainConfigParams(); // AddDomainConfigParams |
11
12try {
13 final result = api_instance.addDomainConfig(tenantId, addDomainConfigParams);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->addDomainConfig: $e\n');
17}
18

Domain-Konfiguration löschen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
domainstringpathJa

Antwort

Rückgabe: DeleteDomainConfigResponse

Beispiel

deleteDomainConfig Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie das Kommentarzeichen unten, um das Präfix (z.B. Bearer) für den API-Schlüssel festzulegen, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final domain = domain_example; // String |
11
12try {
13 final result = api_instance.deleteDomainConfig(tenantId, domain);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->deleteDomainConfig: $e\n');
17}
18

Domain-Konfiguration abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
domainstringpathYes

Rückgabe

Rückgabe: GetDomainConfigResponse

Beispiel

getDomainConfig Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüsselautorisation: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// auskommentieren Sie unten, um das Präfix (z. B. Bearer) für den API‑Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final domain = domain_example; // String |
11
12try {
13 final result = api_instance.getDomainConfig(tenantId, domain);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getDomainConfig: $e\n');
17}
18

Domain-Konfigurationen abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa

Antwort

Rückgabe: GetDomainConfigsResponse

Beispiel

getDomainConfigs Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüsselautorisierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie das Kommentarzeichen unten, um das Präfix (z. B. Bearer) für den API-Schlüssel festzulegen, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10
11try {
12 final result = api_instance.getDomainConfigs(tenantId);
13 print(result);
14} catch (e) {
15 print('Exception when calling DefaultApi->getDomainConfigs: $e\n');
16}
17

Domain-Konfiguration patchen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
domainToUpdatestringpathJa

Antwort

Rückgabe: PatchDomainConfigResponse

Beispiel

patchDomainConfig Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Autorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final domainToUpdate = domainToUpdate_example; // String |
11final patchDomainConfigParams = PatchDomainConfigParams(); // PatchDomainConfigParams |
12
13try {
14 final result = api_instance.patchDomainConfig(tenantId, domainToUpdate, patchDomainConfigParams);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->patchDomainConfig: $e\n');
18}
19

Domain-Konfiguration setzen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
domainToUpdatestringpathYes

Antwort

Returns: PutDomainConfigResponse

Beispiel

putDomainConfig Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API‑Schlüssel‑Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
6// Kommentieren Sie die unten stehende Zeile aus, um ein Präfix (z. B. Bearer) für den API‑Schlüssel einzurichten, falls erforderlich
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final domainToUpdate = domainToUpdate_example; // String |
11final updateDomainConfigParams = UpdateDomainConfigParams(); // UpdateDomainConfigParams |
12
13try {
14 final result = api_instance.putDomainConfig(tenantId, domainToUpdate, updateDomainConfigParams);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->putDomainConfig: $e\n');
18}
19

E-Mail-Vorlage erstellen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa

Antwort

Rückgabe: CreateEmailTemplateResponse

Beispiel

createEmailTemplate Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Autorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createEmailTemplateBody = CreateEmailTemplateBody(); // CreateEmailTemplateBody |
11
12try {
13 final result = api_instance.createEmailTemplate(tenantId, createEmailTemplateBody);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->createEmailTemplate: $e\n');
17}
18

E-Mail-Vorlage löschen Internal Link

Parameters

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa

Response

Rückgabe: APIEmptyResponse

Beispiel

deleteEmailTemplate Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO: API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entkommentieren Sie unten, um das Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.deleteEmailTemplate(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->deleteEmailTemplate: $e\n');
17}
18

Renderfehler der E-Mail-Vorlage löschen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
idstringpathYes
errorIdstringpathYes

Antwort

Rückgabe: APIEmptyResponse

Beispiel

deleteEmailTemplateRenderError Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüssel-Authentifizierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Kommentar entfernen, um Präfix (z.B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final errorId = errorId_example; // String |
12
13try {
14 final result = api_instance.deleteEmailTemplateRenderError(tenantId, id, errorId);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->deleteEmailTemplateRenderError: $e\n');
18}
19

E-Mail-Vorlage abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa

Antwort

Rückgabe: GetEmailTemplateResponse

Beispiel

getEmailTemplate Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Autorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Zeile unten auskommentieren, um Präfix (z.B. Bearer) für API-Schlüssel einzurichten, falls benötigt
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getEmailTemplate(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getEmailTemplate: $e\n');
17}
18

E-Mail-Vorlagendefinitionen abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa

Antwort

Rückgabe: GetEmailTemplateDefinitionsResponse

Beispiel

Beispiel für getEmailTemplateDefinitions
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entkommentieren Sie unten, um das Präfix (z. B. Bearer) für den API-Schlüssel bei Bedarf einzurichten
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10
11try {
12 final result = api_instance.getEmailTemplateDefinitions(tenantId);
13 print(result);
14} catch (e) {
15 print('Exception when calling DefaultApi->getEmailTemplateDefinitions: $e\n');
16}
17

Renderfehler der E-Mail-Vorlage abrufen Internal Link

Parameter

NameTypeLocationRequiredDescription
tenantIdstringqueryJa
idstringpathJa
skipnumberqueryNein

Antwort

Rückgabe: GetEmailTemplateRenderErrorsResponse

Beispiel

getEmailTemplateRenderErrors Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüsselautorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Kommentar unten auskommentieren, um das Präfix (z.B. Bearer) für den API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final skip = 1.2; // double |
12
13try {
14 final result = api_instance.getEmailTemplateRenderErrors(tenantId, id, skip);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->getEmailTemplateRenderErrors: $e\n');
18}
19

E-Mail-Vorlagen abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
skipnumberqueryNein

Antwort

Rückgabe: GetEmailTemplatesResponse

Beispiel

getEmailTemplates Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Autorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um das Präfix (e.g. Bearer) für den API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final skip = 1.2; // double |
11
12try {
13 final result = api_instance.getEmailTemplates(tenantId, skip);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getEmailTemplates: $e\n');
17}
18

E-Mail-Vorlage rendern Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
localestringqueryNein

Antwort

Gibt zurück: RenderEmailTemplateResponse

Beispiel

renderEmailTemplate Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüssel-Authentifizierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final renderEmailTemplateBody = RenderEmailTemplateBody(); // RenderEmailTemplateBody |
11final locale = locale_example; // String |
12
13try {
14 final result = api_instance.renderEmailTemplate(tenantId, renderEmailTemplateBody, locale);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->renderEmailTemplate: $e\n');
18}
19

E-Mail-Vorlage aktualisieren Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa

Antwort

Rückgabe: APIEmptyResponse

Beispiel

updateEmailTemplate Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüssel-Authentifizierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Kommentar entfernen, um das Präfix (z. B. Bearer) für den API-Schlüssel festzulegen, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updateEmailTemplateBody = UpdateEmailTemplateBody(); // UpdateEmailTemplateBody |
12
13try {
14 final result = api_instance.updateEmailTemplate(tenantId, id, updateEmailTemplateBody);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->updateEmailTemplate: $e\n');
18}
19

Ereignisprotokoll abrufen Internal Link

Anforderung tenantId urlId userIdWS

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJa
urlIdstringqueryJa
userIdWSstringqueryJa
startTimeintegerqueryJa
endTimeintegerqueryNein

Antwort

Rückgabe: GetEventLogResponse

Beispiel

getEventLog Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7final userIdWS = userIdWS_example; // String |
8final startTime = 789; // int |
9final endTime = 789; // int |
10
11try {
12 final result = api_instance.getEventLog(tenantId, urlId, userIdWS, startTime, endTime);
13 print(result);
14} catch (e) {
15 print('Exception when calling PublicApi->getEventLog: $e\n');
16}
17

Globales Ereignisprotokoll abrufen Internal Link

Anfrage tenantId urlId userIdWS

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJa
urlIdstringqueryJa
userIdWSstringqueryJa
startTimeintegerqueryJa
endTimeintegerqueryNein

Antwort

Rückgabe: GetEventLogResponse

Beispiel

getGlobalEventLog Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7final userIdWS = userIdWS_example; // String |
8final startTime = 789; // int |
9final endTime = 789; // int |
10
11try {
12 final result = api_instance.getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);
13 print(result);
14} catch (e) {
15 print('Exception when calling PublicApi->getGlobalEventLog: $e\n');
16}
17

Feed-Beitrag erstellen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
broadcastIdstringqueryNein
isLivebooleanqueryNein
doSpamCheckbooleanqueryNein
skipDupCheckbooleanqueryNein

Antwort

Rückgabe: CreateFeedPostsResponse

Beispiel

createFeedPost Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Uncomment unten, um das Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createFeedPostParams = CreateFeedPostParams(); // CreateFeedPostParams |
11final broadcastId = broadcastId_example; // String |
12final isLive = true; // bool |
13final doSpamCheck = true; // bool |
14final skipDupCheck = true; // bool |
15
16try {
17 final result = api_instance.createFeedPost(tenantId, createFeedPostParams, CreateFeedPostOptions(broadcastId: broadcastId, isLive: isLive, doSpamCheck: doSpamCheck, skipDupCheck: skipDupCheck));
18 print(result);
19} catch (e) {
20 print('Exception when calling DefaultApi->createFeedPost: $e\n');
21}
22

Öffentlichen Feed-Beitrag erstellen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringPfadJa
broadcastIdstringAbfrageNein
ssostringAbfrageNein

Antwort

Rückgabe: CreateFeedPostResponse

Beispiel

createFeedPostPublic Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final createFeedPostParams = CreateFeedPostParams(); // CreateFeedPostParams |
7final broadcastId = broadcastId_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.createFeedPostPublic(tenantId, createFeedPostParams, CreateFeedPostPublicOptions(broadcastId: broadcastId, sso: sso));
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->createFeedPostPublic: $e\n');
15}
16

Öffentlichen Feed-Beitrag löschen Internal Link

Parameter

NameTypLocationErforderlichBeschreibung
tenantIdstringpathJa
postIdstringpathJa
broadcastIdstringqueryNein
ssostringqueryNein

Antwort

Rückgabe: DeleteFeedPostPublicResponse

Beispiel

deleteFeedPostPublic Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final postId = postId_example; // String |
7final broadcastId = broadcastId_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.deleteFeedPostPublic(tenantId, postId, DeleteFeedPostPublicOptions(broadcastId: broadcastId, sso: sso));
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->deleteFeedPostPublic: $e\n');
15}
16

Öffentliche Feed-Beiträge abrufen Internal Link

req tenantId afterId

Parameter

NameTypeLocationRequiredDescription
tenantIdstringpathYes
afterIdstringqueryNo
limitintegerqueryNo
tagsarrayqueryNo
ssostringqueryNo
isCrawlerbooleanqueryNo
includeUserInfobooleanqueryNo

Antwort

Returns: PublicFeedPostsResponse

Beispiel

getFeedPostsPublic Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final afterId = afterId_example; // String |
7final limit = 56; // int |
8final tags = []; // List<String> |
9final sso = sso_example; // String |
10final isCrawler = true; // bool |
11final includeUserInfo = true; // bool |
12
13try {
14 final result = api_instance.getFeedPostsPublic(tenantId, GetFeedPostsPublicOptions(afterId: afterId, limit: limit, tags: tags, sso: sso, isCrawler: isCrawler, includeUserInfo: includeUserInfo));
15 print(result);
16} catch (e) {
17 print('Exception when calling PublicApi->getFeedPostsPublic: $e\n');
18}
19

Statistiken der Feed-Beiträge abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJa
postIdsarrayqueryJa
ssostringqueryNein

Antwort

Rückgabe: FeedPostsStatsResponse

Beispiel

getFeedPostsStats Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final postIds = []; // List<String> |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getFeedPostsStats(tenantId, postIds, sso);
11 print(result);
12} catch (e) {
13 print('Exception when calling PublicApi->getFeedPostsStats: $e\n');
14}
15

Öffentliche Reaktionen eines Benutzers abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringPfadJa
postIdsarrayAbfrageNein
ssostringAbfrageNein

Antwort

Rückgabe: UserReactsResponse

Beispiel

getUserReactsPublic Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final postIds = []; // List<String> |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getUserReactsPublic(tenantId, GetUserReactsPublicOptions(postIds: postIds, sso: sso));
11 print(result);
12} catch (e) {
13 print('Exception when calling PublicApi->getUserReactsPublic: $e\n');
14}
15

Öffentlich auf Feed-Beitrag reagieren Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJa
postIdstringpathJa
isUndobooleanqueryNein
broadcastIdstringqueryNein
ssostringqueryNein

Antwort

Rückgabe: ReactFeedPostResponse

Beispiel

reactFeedPostPublic Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final postId = postId_example; // String |
7final reactBodyParams = ReactBodyParams(); // ReactBodyParams |
8final isUndo = true; // bool |
9final broadcastId = broadcastId_example; // String |
10final sso = sso_example; // String |
11
12try {
13 final result = api_instance.reactFeedPostPublic(tenantId, postId, reactBodyParams, ReactFeedPostPublicOptions(isUndo: isUndo, broadcastId: broadcastId, sso: sso));
14 print(result);
15} catch (e) {
16 print('Exception when calling PublicApi->reactFeedPostPublic: $e\n');
17}
18

Feed-Beitrag aktualisieren Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa

Antwort

Rückgabe: APIEmptyResponse

Beispiel

updateFeedPost Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API‑Schlüssel‑Authorisierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie den Kommentar unten, um das Präfix (z. B. Bearer) für den API‑Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final feedPost = FeedPost(); // FeedPost |
12
13try {
14 final result = api_instance.updateFeedPost(tenantId, id, feedPost);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->updateFeedPost: $e\n');
18}
19

Öffentlichen Feed-Beitrag aktualisieren Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJa
postIdstringpathJa
broadcastIdstringqueryNein
ssostringqueryNein

Antwort

Rückgabe: CreateFeedPostResponse

Beispiel

updateFeedPostPublic Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final postId = postId_example; // String |
7final updateFeedPostParams = UpdateFeedPostParams(); // UpdateFeedPostParams |
8final broadcastId = broadcastId_example; // String |
9final sso = sso_example; // String |
10
11try {
12 final result = api_instance.updateFeedPostPublic(tenantId, postId, updateFeedPostParams, UpdateFeedPostPublicOptions(broadcastId: broadcastId, sso: sso));
13 print(result);
14} catch (e) {
15 print('Exception when calling PublicApi->updateFeedPostPublic: $e\n');
16}
17

Öffentliches Kommentarmelden Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
commentIdstringpathYes
isFlaggedbooleanqueryYes
ssostringqueryNo

Antwort

Rückgabe: APIEmptyResponse

Beispiel

flagCommentPublic Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final isFlagged = true; // bool |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.flagCommentPublic(tenantId, commentId, isFlagged, sso);
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->flagCommentPublic: $e\n');
15}
16

Großes GIF abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJa
largeInternalURLSanitizedstringqueryJa

Antwort

Rückgabe: GifGetLargeResponse

Beispiel

getGifLarge Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final largeInternalURLSanitized = largeInternalURLSanitized_example; // String |
7
8try {
9 final result = api_instance.getGifLarge(tenantId, largeInternalURLSanitized);
10 print(result);
11} catch (e) {
12 print('Exception when calling PublicApi->getGifLarge: $e\n');
13}
14

GIF-Suche abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJa
searchstringqueryJa
localestringqueryNein
ratingstringqueryNein
pagenumberqueryNein

Antwort

Rückgabe: GetGifsSearchResponse

Beispiel

getGifsSearch Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final search = search_example; // String |
7final locale = locale_example; // String |
8final rating = rating_example; // String |
9final page = 1.2; // double |
10
11try {
12 final result = api_instance.getGifsSearch(tenantId, search, GetGifsSearchOptions(locale: locale, rating: rating, page: page));
13 print(result);
14} catch (e) {
15 print('Exception when calling PublicApi->getGifsSearch: $e\n');
16}
17

Trend-GIFs abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJa
localestringqueryNein
ratingstringqueryNein
pagenumberqueryNein

Antwort

Rückgabe: GetGifsTrendingResponse

Beispiel

getGifsTrending Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final locale = locale_example; // String |
7final rating = rating_example; // String |
8final page = 1.2; // double |
9
10try {
11 final result = api_instance.getGifsTrending(tenantId, GetGifsTrendingOptions(locale: locale, rating: rating, page: page));
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->getGifsTrending: $e\n');
15}
16

Hashtag hinzufügen Internal Link

Parameter

NameTypLocationErforderlichBeschreibung
tenantIdstringqueryJa

Antwort

Rückgabe: CreateHashTagResponse

Beispiel

addHashTag Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüsselautorisierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Kommentieren Sie unten aus, um ein Präfix (z. B. Bearer) für den API-Schlüssel festzulegen, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createHashTagBody = CreateHashTagBody(); // CreateHashTagBody |
11
12try {
13 final result = api_instance.addHashTag(tenantId, createHashTagBody);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->addHashTag: $e\n');
17}
18

Mehrere Hashtags hinzufügen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa

Antwort

Rückgabe: BulkCreateHashTagsResponse

Beispiel

addHashTagsBulk Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um das Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final bulkCreateHashTagsBody = BulkCreateHashTagsBody(); // BulkCreateHashTagsBody |
11
12try {
13 final result = api_instance.addHashTagsBulk(tenantId, bulkCreateHashTagsBody);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->addHashTagsBulk: $e\n');
17}
18

Hashtag löschen Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
tagstringpathYes

Response

Rückgabe: APIEmptyResponse

Beispiel

deleteHashTag Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüsselautorisierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie das Kommentarzeichen unten, um das Präfix (z. B. Bearer) für den API-Schlüssel festzulegen, falls benötigt
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final tag = tag_example; // String |
11final deleteHashTagRequestBody = DeleteHashTagRequestBody(); // DeleteHashTagRequestBody |
12
13try {
14 final result = api_instance.deleteHashTag(tenantId, tag, deleteHashTagRequestBody);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->deleteHashTag: $e\n');
18}
19

Hashtags abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
pagenumberqueryNein

Antwort

Rückgabe: GetHashTagsResponse

Beispiel

getHashTags Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüsselautorisation konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um das Präfix (z.B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final page = 1.2; // double |
11
12try {
13 final result = api_instance.getHashTags(tenantId, page);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getHashTags: $e\n');
17}
18

Hashtag patchen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
tagstringpathYes

Antwort

Rückgabe: UpdateHashTagResponse

Beispiel

patchHashTag Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API‑Schlüsselberechtigung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final tag = tag_example; // String |
11final updateHashTagBody = UpdateHashTagBody(); // UpdateHashTagBody |
12
13try {
14 final result = api_instance.patchHashTag(tenantId, tag, updateHashTagBody);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->patchHashTag: $e\n');
18}
19

Moderationsabstimmung löschen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
commentIdstringpathYes
voteIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Antwort

Rückgabe: VoteDeleteResponse

Beispiel

deleteModerationVote Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final voteId = voteId_example; // String |
8final broadcastId = broadcastId_example; // String |
9final sso = sso_example; // String |
10
11try {
12 final result = api_instance.deleteModerationVote(tenantId, commentId, voteId, DeleteModerationVoteOptions(broadcastId: broadcastId, sso: sso));
13 print(result);
14} catch (e) {
15 print('Exception when calling ModerationApi->deleteModerationVote: $e\n');
16}
17

API-Kommentare abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
pagenumberqueryNo
countnumberqueryNo
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
sortsstringqueryNo
demobooleanqueryNo
ssostringqueryNo

Antwort

Rückgabe: ModerationAPIGetCommentsResponse

Beispiel

getApiComments Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final page = 1.2; // double |
7final count = 1.2; // double |
8final textSearch = textSearch_example; // String |
9final byIPFromComment = byIPFromComment_example; // String |
10final filters = filters_example; // String |
11final searchFilters = searchFilters_example; // String |
12final sorts = sorts_example; // String |
13final demo = true; // bool |
14final sso = sso_example; // String |
15
16try {
17 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));
18 print(result);
19} catch (e) {
20 print('Exception when calling ModerationApi->getApiComments: $e\n');
21}
22

API-Exportstatus abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
batchJobIdstringqueryNein
ssostringqueryNein

Antwort

Rückgabe: ModerationExportStatusResponse

Beispiel

getApiExportStatus Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final batchJobId = batchJobId_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getApiExportStatus(tenantId, GetApiExportStatusOptions(batchJobId: batchJobId, sso: sso));
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->getApiExportStatus: $e\n');
14}
15

API-IDs abrufen Internal Link


Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
afterIdstringqueryNo
demobooleanqueryNo
ssostringqueryNo

Antwort

Rückgabe: ModerationAPIGetCommentIdsResponse

Beispiel

getApiIds Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final textSearch = textSearch_example; // String |
7final byIPFromComment = byIPFromComment_example; // String |
8final filters = filters_example; // String |
9final searchFilters = searchFilters_example; // String |
10final afterId = afterId_example; // String |
11final demo = true; // bool |
12final sso = sso_example; // String |
13
14try {
15 final result = api_instance.getApiIds(tenantId, GetApiIdsOptions(textSearch: textSearch, byIPFromComment: byIPFromComment, filters: filters, searchFilters: searchFilters, afterId: afterId, demo: demo, sso: sso));
16 print(result);
17} catch (e) {
18 print('Exception when calling ModerationApi->getApiIds: $e\n');
19}
20

Benutzer, die aus Kommentaren verbannt sind, abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
commentIdstringpathJa
ssostringqueryNein

Antwort

Rückgabe: GetBannedUsersFromCommentResponse

Beispiel

getBanUsersFromComment Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getBanUsersFromComment(tenantId, commentId, sso);
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->getBanUsersFromComment: $e\n');
14}
15

Kommentar-Bannstatus abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

Antwort

Rückgabe: GetCommentBanStatusResponse

Beispiel

getCommentBanStatus Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getCommentBanStatus(tenantId, commentId, sso);
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->getCommentBanStatus: $e\n');
14}
15

Kinderkommentare abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
commentIdstringpathJa
ssostringqueryNein

Antwort

Rückgabe: ModerationAPIChildCommentsResponse

Beispiel

getCommentChildren Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getCommentChildren(tenantId, commentId, sso);
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->getCommentChildren: $e\n');
14}
15

Anzahl abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
text-searchstringqueryNein
byIPFromCommentstringqueryNein
filterstringqueryNein
searchFiltersstringqueryNein
demobooleanqueryNein
ssostringqueryNein

Antwort

Rückgabe: ModerationAPICountCommentsResponse

Beispiel

getCount Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final textSearch = textSearch_example; // String |
7final byIPFromComment = byIPFromComment_example; // String |
8final filter = filter_example; // String |
9final searchFilters = searchFilters_example; // String |
10final demo = true; // bool |
11final sso = sso_example; // String |
12
13try {
14 final result = api_instance.getCount(tenantId, GetCountOptions(textSearch: textSearch, byIPFromComment: byIPFromComment, filter: filter, searchFilters: searchFilters, demo: demo, sso: sso));
15 print(result);
16} catch (e) {
17 print('Exception when calling ModerationApi->getCount: $e\n');
18}
19

Anzahlen abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
ssostringqueryNein

Antwort

Rückgabe: GetBannedUsersCountResponse

Beispiel

getCounts Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final sso = sso_example; // String |
7
8try {
9 final result = api_instance.getCounts(tenantId, sso);
10 print(result);
11} catch (e) {
12 print('Exception when calling ModerationApi->getCounts: $e\n');
13}
14

Protokolle abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
commentIdstringpathJa
ssostringqueryNein

Antwort

Rückgabe: ModerationAPIGetLogsResponse

Beispiel

getLogs Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getLogs(tenantId, commentId, sso);
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->getLogs: $e\n');
14}
15

Manuelle Abzeichen abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
ssostringqueryNein

Antwort

Rückgabe: GetTenantManualBadgesResponse

Beispiel

getManualBadges Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final sso = sso_example; // String |
7
8try {
9 final result = api_instance.getManualBadges(tenantId, sso);
10 print(result);
11} catch (e) {
12 print('Exception when calling ModerationApi->getManualBadges: $e\n');
13}
14

Manuelle Abzeichen für Benutzer abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
badgesUserIdstringqueryNein
commentIdstringqueryNein
ssostringqueryNein

Antwort

Rückgabe: GetUserManualBadgesResponse

Beispiel

getManualBadgesForUser Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final badgesUserId = badgesUserId_example; // String |
7final commentId = commentId_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.getManualBadgesForUser(tenantId, GetManualBadgesForUserOptions(badgesUserId: badgesUserId, commentId: commentId, sso: sso));
12 print(result);
13} catch (e) {
14 print('Exception when calling ModerationApi->getManualBadgesForUser: $e\n');
15}
16

Moderationskommentar abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
commentIdstringpathJa
includeEmailbooleanqueryNein
includeIPbooleanqueryNein
ssostringqueryNein

Antwort

Rückgabe: ModerationAPICommentResponse

Beispiel

getModerationComment Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final includeEmail = true; // bool |
8final includeIP = true; // bool |
9final sso = sso_example; // String |
10
11try {
12 final result = api_instance.getModerationComment(tenantId, commentId, GetModerationCommentOptions(includeEmail: includeEmail, includeIP: includeIP, sso: sso));
13 print(result);
14} catch (e) {
15 print('Exception when calling ModerationApi->getModerationComment: $e\n');
16}
17

Moderationskommentartext abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
commentIdstringpathJa
ssostringqueryNein

Antwort

Rückgabe: GetCommentTextResponse

Beispiel

getModerationCommentText Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getModerationCommentText(tenantId, commentId, sso);
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->getModerationCommentText: $e\n');
14}
15

Vorab-Bann-Zusammenfassung abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
commentIdstringpathJa
includeByUserIdAndEmailbooleanqueryNein
includeByIPbooleanqueryNein
includeByEmailDomainbooleanqueryNein
ssostringqueryNein

Antwort

Rückgabe: PreBanSummary

Beispiel

getPreBanSummary Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final includeByUserIdAndEmail = true; // bool |
8final includeByIP = true; // bool |
9final includeByEmailDomain = true; // bool |
10final sso = sso_example; // String |
11
12try {
13 final result = api_instance.getPreBanSummary(tenantId, commentId, GetPreBanSummaryOptions(includeByUserIdAndEmail: includeByUserIdAndEmail, includeByIP: includeByIP, includeByEmailDomain: includeByEmailDomain, sso: sso));
14 print(result);
15} catch (e) {
16 print('Exception when calling ModerationApi->getPreBanSummary: $e\n');
17}
18

Zusammenfassung der Suchkommentare abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
valuestringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
ssostringqueryNo

Antwort

Rückgabe: ModerationCommentSearchResponse

Beispiel

Beispiel für getSearchCommentsSummary
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final value = value_example; // String |
7final filters = filters_example; // String |
8final searchFilters = searchFilters_example; // String |
9final sso = sso_example; // String |
10
11try {
12 final result = api_instance.getSearchCommentsSummary(tenantId, GetSearchCommentsSummaryOptions(value: value, filters: filters, searchFilters: searchFilters, sso: sso));
13 print(result);
14} catch (e) {
15 print('Exception when calling ModerationApi->getSearchCommentsSummary: $e\n');
16}
17

Suchseiten abrufen Internal Link

Parameters

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
valuestringqueryNein
ssostringqueryNein

Response

Returns: ModerationPageSearchResponse

Beispiel

getSearchPages Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final value = value_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getSearchPages(tenantId, GetSearchPagesOptions(value: value, sso: sso));
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->getSearchPages: $e\n');
14}
15

Suchseiten (Sites) abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
valuestringqueryNein
ssostringqueryNein

Antwort

Rückgabe: ModerationSiteSearchResponse

Beispiel

getSearchSites Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final value = value_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getSearchSites(tenantId, GetSearchSitesOptions(value: value, sso: sso));
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->getSearchSites: $e\n');
14}
15

Suchvorschläge abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
text-searchstringqueryNein
ssostringqueryNein

Antwort

Rückgabe: ModerationSuggestResponse

Beispiel

getSearchSuggest Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final textSearch = textSearch_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getSearchSuggest(tenantId, GetSearchSuggestOptions(textSearch: textSearch, sso: sso));
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->getSearchSuggest: $e\n');
14}
15

Benutzer suchen Internal Link

Parameters

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
valuestringqueryNein
ssostringqueryNein

Response

Rückgabe: ModerationUserSearchResponse

Example

getSearchUsers Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final value = value_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getSearchUsers(tenantId, GetSearchUsersOptions(value: value, sso: sso));
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->getSearchUsers: $e\n');
14}
15

Trust-Faktor abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
userIdstringqueryNein
ssostringqueryNein

Antwort

Rückgabe: GetUserTrustFactorResponse

Beispiel

getTrustFactor Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final userId = userId_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getTrustFactor(tenantId, GetTrustFactorOptions(userId: userId, sso: sso));
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->getTrustFactor: $e\n');
14}
15

Benutzer-Bannpräferenz abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
ssostringqueryNein

Antwort

Rückgabe: APIModerateGetUserBanPreferencesResponse

Beispiel

getUserBanPreference Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final sso = sso_example; // String |
7
8try {
9 final result = api_instance.getUserBanPreference(tenantId, sso);
10 print(result);
11} catch (e) {
12 print('Exception when calling ModerationApi->getUserBanPreference: $e\n');
13}
14

Internes Benutzerprofil abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
commentIdstringqueryNein
ssostringqueryNein

Antwort

Rückgabe: GetUserInternalProfileResponse

Beispiel

getUserInternalProfile Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getUserInternalProfile(tenantId, GetUserInternalProfileOptions(commentId: commentId, sso: sso));
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->getUserInternalProfile: $e\n');
14}
15

Kommentarabstimmungen anpassen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
commentIdstringpathJa
broadcastIdstringqueryNein
ssostringqueryNein

Antwort

Rückgabe: AdjustVotesResponse

Beispiel

postAdjustCommentVotes Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final adjustCommentVotesParams = AdjustCommentVotesParams(); // AdjustCommentVotesParams |
8final broadcastId = broadcastId_example; // String |
9final sso = sso_example; // String |
10
11try {
12 final result = api_instance.postAdjustCommentVotes(tenantId, commentId, adjustCommentVotesParams, PostAdjustCommentVotesOptions(broadcastId: broadcastId, sso: sso));
13 print(result);
14} catch (e) {
15 print('Exception when calling ModerationApi->postAdjustCommentVotes: $e\n');
16}
17

API-Export durchführen Internal Link

Parameter

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
sortsstringqueryNo
ssostringqueryNo

Antwort

Returns: ModerationExportResponse

Beispiel

postApiExport Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final textSearch = textSearch_example; // String |
7final byIPFromComment = byIPFromComment_example; // String |
8final filters = filters_example; // String |
9final searchFilters = searchFilters_example; // String |
10final sorts = sorts_example; // String |
11final sso = sso_example; // String |
12
13try {
14 final result = api_instance.postApiExport(tenantId, PostApiExportOptions(textSearch: textSearch, byIPFromComment: byIPFromComment, filters: filters, searchFilters: searchFilters, sorts: sorts, sso: sso));
15 print(result);
16} catch (e) {
17 print('Exception when calling ModerationApi->postApiExport: $e\n');
18}
19

Benutzer aus Kommentar bannen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
commentIdstringpathYes
banEmailbooleanqueryNo
banEmailDomainbooleanqueryNo
banIPbooleanqueryNo
deleteAllUsersCommentsbooleanqueryNo
bannedUntilstringqueryNo
isShadowBanbooleanqueryNo
updateIdstringqueryNo
banReasonstringqueryNo
ssostringqueryNo

Antwort

Rückgabe: BanUserFromCommentResult

Beispiel

postBanUserFromComment Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final banEmail = true; // bool |
8final banEmailDomain = true; // bool |
9final banIP = true; // bool |
10final deleteAllUsersComments = true; // bool |
11final bannedUntil = bannedUntil_example; // String |
12final isShadowBan = true; // bool |
13final updateId = updateId_example; // String |
14final banReason = banReason_example; // String |
15final sso = sso_example; // String |
16
17try {
18 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));
19 print(result);
20} catch (e) {
21 print('Exception when calling ModerationApi->postBanUserFromComment: $e\n');
22}
23

Bann von Benutzer rückgängig machen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
ssostringqueryNo

Antwort

Rückgabe: APIEmptyResponse

Beispiel

postBanUserUndo Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final banUserUndoParams = BanUserUndoParams(); // BanUserUndoParams |
7final sss = sso_example; // String |
8
9try {
10 final result = api_instance.postBanUserUndo(tenantId, banUserUndoParams, sso);
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->postBanUserUndo: $e\n');
14}
15

Mehrfache Vorab-Bann-Zusammenfassung Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
includeByUserIdAndEmailbooleanqueryNein
includeByIPbooleanqueryNein
includeByEmailDomainbooleanqueryNein
ssostringqueryNein

Antwort

Rückgabe: BulkPreBanSummary

Beispiel

postBulkPreBanSummary Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final bulkPreBanParams = BulkPreBanParams(); // BulkPreBanParams |
7final includeByUserIdAndEmail = true; // bool |
8final includeByIP = true; // bool |
9final includeByEmailDomain = true; // bool |
10final sso = sso_example; // String |
11
12try {
13 final result = api_instance.postBulkPreBanSummary(tenantId, bulkPreBanParams, PostBulkPreBanSummaryOptions(includeByUserIdAndEmail: includeByUserIdAndEmail, includeByIP: includeByIP, includeByEmailDomain: includeByEmailDomain, sso: sso));
14 print(result);
15} catch (e) {
16 print('Exception when calling ModerationApi->postBulkPreBanSummary: $e\n');
17}
18

Kommentare nach IDs posten Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
ssostringqueryNein

Antwort

Rückgabe: ModerationAPIChildCommentsResponse

Beispiel

postCommentsByIds Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentsByIdsParams = CommentsByIdsParams(); // CommentsByIdsParams |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.postCommentsByIds(tenantId, commentsByIdsParams, sso);
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->postCommentsByIds: $e\n');
14}
15

Kommentar melden Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Antwort

Rückgabe: APIEmptyResponse

Beispiel

postFlagComment Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final broadcastId = broadcastId_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.postFlagComment(tenantId, commentId, PostFlagCommentOptions(broadcastId: broadcastId, sso: sso));
12 print(result);
13} catch (e) {
14 print('Exception when calling ModerationApi->postFlagComment: $e\n');
15}
16

Kommentar entfernen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
commentIdstringpathJa
broadcastIdstringqueryNein
ssostringqueryNein

Antwort

Rückgabe: PostRemoveCommentApiResponse

Beispiel

postRemoveComment Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final broadcastId = broadcastId_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.postRemoveComment(tenantId, commentId, PostRemoveCommentOptions(broadcastId: broadcastId, sso: sso));
12 print(result);
13} catch (e) {
14 print('Exception when calling ModerationApi->postRemoveComment: $e\n');
15}
16

Gelöschten Kommentar wiederherstellen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Antwort

Returns: APIEmptyResponse

Beispiel

postRestoreDeletedComment Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final broadcastId = broadcastId_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.postRestoreDeletedComment(tenantId, commentId, PostRestoreDeletedCommentOptions(broadcastId: broadcastId, sso: sso));
12 print(result);
13} catch (e) {
14 print('Exception when calling ModerationApi->postRestoreDeletedComment: $e\n');
15}
16

Genehmigungsstatus des Kommentars setzen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
commentIdstringpathYes
approvedbooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Antwort

Rückgabe: SetCommentApprovedResponse

Beispiel

postSetCommentApprovalStatus Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final approved = true; // bool |
8final broadcastId = broadcastId_example; // String |
9final sso = sso_example; // String |
10
11try {
12 final result = api_instance.postSetCommentApprovalStatus(tenantId, commentId, PostSetCommentApprovalStatusOptions(approved: approved, broadcastId: broadcastId, sso: sso));
13 print(result);
14} catch (e) {
15 print('Exception when calling ModerationApi->postSetCommentApprovalStatus: $e\n');
16}
17

Überprüfungsstatus des Kommentars setzen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
commentIdstringpathJa
reviewedbooleanqueryNein
broadcastIdstringqueryNein
ssostringqueryNein

Antwort

Rückgabe: APIEmptyResponse

Beispiel

postSetCommentReviewStatus Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final reviewed = true; // bool |
8final broadcastId = broadcastId_example; // String |
9final sso = sso_example; // String |
10
11try {
12 final result = api_instance.postSetCommentReviewStatus(tenantId, commentId, PostSetCommentReviewStatusOptions(reviewed: reviewed, broadcastId: broadcastId, sso: sso));
13 print(result);
14} catch (e) {
15 print('Exception when calling ModerationApi->postSetCommentReviewStatus: $e\n');
16}
17

Spam-Status des Kommentars setzen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
commentIdstringpathJa
spambooleanqueryNein
permNotSpambooleanqueryNein
broadcastIdstringqueryNein
ssostringqueryNein

Antwort

Rückgabe: APIEmptyResponse

Beispiel

postSetCommentSpamStatus Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final spam = true; // bool |
8final permNotSpam = true; // bool |
9final broadcastId = broadcastId_example; // String |
10final sso = sso_example; // String |
11
12try {
13 final result = api_instance.postSetCommentSpamStatus(tenantId, commentId, PostSetCommentSpamStatusOptions(spam: spam, permNotSpam: permNotSpam, broadcastId: broadcastId, sso: sso));
14 print(result);
15} catch (e) {
16 print('Exception when calling ModerationApi->postSetCommentSpamStatus: $e\n');
17}
18

Kommentartext setzen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
commentIdstringpathJa
broadcastIdstringqueryNein
ssostringqueryNein

Antwort

Rückgabe: SetCommentTextResponse

Beispiel

postSetCommentText Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final setCommentTextParams = SetCommentTextParams(); // SetCommentTextParams |
8final broadcastId = broadcastId_example; // String |
9final sso = sso_example; // String |
10
11try {
12 final result = api_instance.postSetCommentText(tenantId, commentId, setCommentTextParams, PostSetCommentTextOptions(broadcastId: broadcastId, sso: sso));
13 print(result);
14} catch (e) {
15 print('Exception when calling ModerationApi->postSetCommentText: $e\n');
16}
17

Meldung des Kommentars aufheben Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Antwort

Returns: APIEmptyResponse

Beispiel

postUnFlagComment Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final broadcastId = broadcastId_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.postUnFlagComment(tenantId, commentId, PostUnFlagCommentOptions(broadcastId: broadcastId, sso: sso));
12 print(result);
13} catch (e) {
14 print('Exception when calling ModerationApi->postUnFlagComment: $e\n');
15}
16

Abstimmung posten Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
commentIdstringpathJa
directionstringqueryNein
broadcastIdstringqueryNein
ssostringqueryNein

Antwort

Returns: VoteResponse

Beispiel

postVote Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final direction = direction_example; // String |
8final broadcastId = broadcastId_example; // String |
9final sso = sso_example; // String |
10
11try {
12 final result = api_instance.postVote(tenantId, commentId, PostVoteOptions(direction: direction, broadcastId: broadcastId, sso: sso));
13 print(result);
14} catch (e) {
15 print('Exception when calling ModerationApi->postVote: $e\n');
16}
17

Abzeichen vergeben Internal Link

Parameter

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
badgeIdstringqueryYes
userIdstringqueryNo
commentIdstringqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Antwort

Rückgabe: AwardUserBadgeResponse

Beispiel

putAwardBadge Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final badgeId = badgeId_example; // String |
7final userId = userId_example; // String |
8final commentId = commentId_example; // String |
9final broadcastId = broadcastId_example; // String |
10final sso = sso_example; // String |
11
12try {
13 final result = api_instance.putAwardBadge(tenantId, badgeId, PutAwardBadgeOptions(userId: userId, commentId: commentId, broadcastId: broadcastId, sso: sso));
14 print(result);
15} catch (e) {
16 print('Exception when calling ModerationApi->putAwardBadge: $e\n');
17}
18

Thread schließen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
urlIdstringqueryYes
ssostringqueryNo

Antwort

Rückgabe: APIEmptyResponse

Beispiel

putCloseThread Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.putCloseThread(tenantId, urlId, sso);
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->putCloseThread: $e\n');
14}
15

Abzeichen entfernen Internal Link


Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
badgeIdstringqueryJa
userIdstringqueryNein
commentIdstringqueryNein
broadcastIdstringqueryNein
ssostringqueryNein

Antwort

Returns: RemoveUserBadgeResponse

Beispiel

putRemoveBadge Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final badgeId = badgeId_example; // String |
7final userId = userId_example; // String |
8final commentId = commentId_example; // String |
9final broadcastId = broadcastId_example; // String |
10final sso = sso_example; // String |
11
12try {
13 final result = api_instance.putRemoveBadge(tenantId, badgeId, PutRemoveBadgeOptions(userId: userId, commentId: commentId, broadcastId: broadcastId, sso: sso));
14 print(result);
15} catch (e) {
16 print('Exception when calling ModerationApi->putRemoveBadge: $e\n');
17}
18

Thread wieder öffnen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
urlIdstringqueryYes
ssostringqueryNo

Antwort

Rückgabe: APIEmptyResponse

Beispiel

putReopenThread Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.putReopenThread(tenantId, urlId, sso);
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->putReopenThread: $e\n');
14}
15

Trust-Faktor setzen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
userIdstringqueryNo
trustFactorstringqueryNo
ssostringqueryNo

Antwort

Rückgabe: SetUserTrustFactorResponse

Beispiel

setTrustFactor Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final userId = userId_example; // String |
7final trustFactor = trustFactor_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.setTrustFactor(tenantId, SetTrustFactorOptions(userId: userId, trustFactor: trustFactor, sso: sso));
12 print(result);
13} catch (e) {
14 print('Exception when calling ModerationApi->setTrustFactor: $e\n');
15}
16

Moderator erstellen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa

Antwort

Rückgabe: CreateModeratorResponse

Beispiel

createModerator Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüssel-Authentifizierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createModeratorBody = CreateModeratorBody(); // CreateModeratorBody |
11
12try {
13 final result = api_instance.createModerator(tenantId, createModeratorBody);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->createModerator: $e\n');
17}
18

Moderator löschen Internal Link

Parameter

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
sendEmailstringqueryNo

Antwort

Rückgabe: APIEmptyResponse

Beispiel

deleteModerator Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um Präfix (z.B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final sendEmail = sendEmail_example; // String |
12
13try {
14 final result = api_instance.deleteModerator(tenantId, id, sendEmail);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->deleteModerator: $e\n');
18}
19

Moderator abrufen Internal Link

Parameters

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
idstringpathYes

Response

Rückgabe: GetModeratorResponse

Example

getModerator Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entkommentieren Sie unten, um das Präfix (z.B. Bearer) für den API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getModerator(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getModerator: $e\n');
17}
18

Moderatoren abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
skipnumberqueryNein

Antwort

Returns: GetModeratorsResponse

Beispiel

getModerators Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die Autorisierung des API-Schlüssels: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie den Kommentar unten, um das Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final skip = 1.2; // double |
11
12try {
13 final result = api_instance.getModerators(tenantId, skip);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getModerators: $e\n');
17}
18

Einladung senden Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa
fromNamestringqueryJa

Antwort

Rückgabe: APIEmptyResponse

Beispiel

sendInvite Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entkommentieren Sie unten, um das Präfix (z.B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final fromName = fromName_example; // String |
12
13try {
14 final result = api_instance.sendInvite(tenantId, id, fromName);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->sendInvite: $e\n');
18}
19

Moderator aktualisieren Internal Link

Parameter

NameTypLocationErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa

Antwort

Rückgabe: APIEmptyResponse

Beispiel

updateModerator Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Autorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entkommentieren Sie unten, um das Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updateModeratorBody = UpdateModeratorBody(); // UpdateModeratorBody |
12
13try {
14 final result = api_instance.updateModerator(tenantId, id, updateModeratorBody);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->updateModerator: $e\n');
18}
19

Benachrichtigungszähler löschen Internal Link

Parameter

NameTypeLocationRequiredDescription
tenantIdstringqueryJa
idstringpathJa

Antwort

Rückgabe: APIEmptyResponse

Beispiel

deleteNotificationCount Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfiguriere die API-Schlüssel-Authentifizierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie das Kommentarzeichen unten, um das Präfix (z. B. Bearer) für den API‑Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.deleteNotificationCount(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->deleteNotificationCount: $e\n');
17}
18

Zwischengespeicherten Benachrichtigungszähler abrufen Internal Link

Parameters

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa

Response

Rückgabe: GetCachedNotificationCountResponse

Example

getCachedNotificationCount Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüssel-Authentifizierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Kommentar auskommentieren unten, um Prefix (z. B. Bearer) für API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getCachedNotificationCount(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getCachedNotificationCount: $e\n');
17}
18

Benachrichtigungszähler abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
userIdstringqueryNein
urlIdstringqueryNein
fromCommentIdstringqueryNein
viewedbooleanqueryNein
typestringqueryNein

Antwort

Rückgabe: GetNotificationCountResponse

Beispiel

getNotificationCount Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um Präfix (z. B. Bearer) für API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final userId = userId_example; // String |
11final urlId = urlId_example; // String |
12final fromCommentId = fromCommentId_example; // String |
13final viewed = true; // bool |
14final type = type_example; // String |
15
16try {
17 final result = api_instance.getNotificationCount(tenantId, GetNotificationCountOptions(userId: userId, urlId: urlId, fromCommentId: fromCommentId, viewed: viewed, type: type));
18 print(result);
19} catch (e) {
20 print('Exception when calling DefaultApi->getNotificationCount: $e\n');
21}
22

Benachrichtigungen abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
userIdstringqueryNein
urlIdstringqueryNein
fromCommentIdstringqueryNein
viewedbooleanqueryNein
typestringqueryNein
skipnumberqueryNein

Antwort

Rückgabe: GetNotificationsResponse

Beispiel

getNotifications Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie das Kommentarzeichen unten, um das Präfix (z. B. Bearer) für den API‑Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final userId = userId_example; // String |
11final urlId = urlId_example; // String |
12final fromCommentId = fromCommentId_example; // String |
13final viewed = true; // bool |
14final type = type_example; // String |
15final skip = 1.2; // double |
16
17try {
18 final result = api_instance.getNotifications(tenantId, GetNotificationsOptions(userId: userId, urlId: urlId, fromCommentId: fromCommentId, viewed: viewed, type: type, skip: skip));
19 print(result);
20} catch (e) {
21 print('Exception when calling DefaultApi->getNotifications: $e\n');
22}
23

Benachrichtigung aktualisieren Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa
userIdstringqueryNein

Antwort

Rückgabe: APIEmptyResponse

Beispiel

updateNotification Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API‑Schlüsselautorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entkommentieren Sie unten, um das Präfix (z. B. Bearer) für den API‑Schlüssel festzulegen, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updateNotificationBody = UpdateNotificationBody(); // UpdateNotificationBody |
12final userId = userId_example; // String |
13
14try {
15 final result = api_instance.updateNotification(tenantId, id, updateNotificationBody, userId);
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->updateNotification: $e\n');
19}
20

V1-Seitenreaktion erstellen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJa
urlIdstringqueryJa
titlestringqueryNein

Antwort

Rückgabe: CreateV1PageReact

Beispiel

createV1PageReact Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7final title = title_example; // String |
8
9try {
10 final result = api_instance.createV1PageReact(tenantId, urlId, title);
11 print(result);
12} catch (e) {
13 print('Exception when calling PublicApi->createV1PageReact: $e\n');
14}
15

V2-Seitenreaktion erstellen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJa
urlIdstringqueryJa
idstringqueryJa
titlestringqueryNein

Antwort

Rückgabe: CreateV1PageReact

Beispiel

createV2PageReact Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7final id = id_example; // String |
8final title = title_example; // String |
9
10try {
11 final result = api_instance.createV2PageReact(tenantId, urlId, id, title);
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->createV2PageReact: $e\n');
15}
16

V1-Seitenreaktion löschen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathYes
urlIdstringqueryYes

Antwort

Rückgabe: CreateV1PageReact

Beispiel

Beispiel für deleteV1PageReact
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7
8try {
9 final result = api_instance.deleteV1PageReact(tenantId, urlId);
10 print(result);
11} catch (e) {
12 print('Exception when calling PublicApi->deleteV1PageReact: $e\n');
13}
14

V2-Seitenreaktion löschen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathYes
urlIdstringqueryYes
idstringqueryYes

Antwort

Rückgabe: CreateV1PageReact

Beispiel

deleteV2PageReact Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7final id = id_example; // String |
8
9try {
10 final result = api_instance.deleteV2PageReact(tenantId, urlId, id);
11 print(result);
12} catch (e) {
13 print('Exception when calling PublicApi->deleteV2PageReact: $e\n');
14}
15

V1-Seiten-Likes abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJa
urlIdstringqueryJa

Antwort

Rückgabe: GetV1PageLikes

Beispiel

getV1PageLikes Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7
8try {
9 final result = api_instance.getV1PageLikes(tenantId, urlId);
10 print(result);
11} catch (e) {
12 print('Exception when calling PublicApi->getV1PageLikes: $e\n');
13}
14

V2-Seitenreaktionen abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJa
urlIdstringqueryJa

Antwort

Rückgabe: GetV2PageReacts

Beispiel

getV2PageReacts Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7
8try {
9 final result = api_instance.getV2PageReacts(tenantId, urlId);
10 print(result);
11} catch (e) {
12 print('Exception when calling PublicApi->getV2PageReacts: $e\n');
13}
14

V2-Seitenreaktionsbenutzer abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathYes
urlIdstringqueryYes
idstringqueryYes

Antwort

Rückgabe: GetV2PageReactUsersResponse

Beispiel

getV2PageReactUsers Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7final id = id_example; // String |
8
9try {
10 final result = api_instance.getV2PageReactUsers(tenantId, urlId, id);
11 print(result);
12} catch (e) {
13 print('Exception when calling PublicApi->getV2PageReactUsers: $e\n');
14}
15

Seite hinzufügen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa

Antwort

Rückgabe: AddPageAPIResponse

Beispiel

addPage Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Autorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie das Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API‑Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createAPIPageData = CreateAPIPageData(); // CreateAPIPageData |
11
12try {
13 final result = api_instance.addPage(tenantId, createAPIPageData);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->addPage: $e\n');
17}
18

Seite löschen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa

Antwort

Rückgabe: DeletePageAPIResponse

Beispiel

deletePage Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um ein Präfix (z. B. Bearer) für den API‑Schlüssel festzulegen, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.deletePage(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->deletePage: $e\n');
17}
18

Offline-Benutzer abrufen Internal Link

Past commenters on the page who are NOT currently online. Sorted by displayName.
Use this after exhausting /users/online to render a “Members” section.
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.

Parameter

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYesSeiten-URL-Bezeichner (serverseitig bereinigt).
afterNamestringqueryNoCursor: übergeben Sie nextAfterName aus der vorherigen Antwort.
afterUserIdstringqueryNoCursor‑Tiebreaker: übergeben Sie nextAfterUserId aus der vorherigen Antwort. Erforderlich, wenn afterName gesetzt ist, damit Namensbindungen keine Einträge verlieren.

Antwort

Rückgabe: PageUsersOfflineResponse

Beispiel

Beispiel für getOfflineUsers
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String | Seiten-URL-Bezeichner (serverseitig bereinigt).
7final afterName = afterName_example; // String | Cursor: übergeben Sie nextAfterName aus der vorherigen Antwort.
8final afterUserId = afterUserId_example; // String | Cursor‑Tiebreaker: übergeben Sie nextAfterUserId aus der vorherigen Antwort. Erforderlich, wenn afterName gesetzt ist, damit Namensbindungen keine Einträge verlieren.
9
10try {
11 final result = api_instance.getOfflineUsers(tenantId, urlId, GetOfflineUsersOptions(afterName: afterName, afterUserId: afterUserId));
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->getOfflineUsers: $e\n');
15}
16

Online-Benutzer abrufen Internal Link


Derzeit online Viewer einer Seite: Personen, deren Websocket‑Session gerade die Seite abonniert.
Gibt anonCount + totalCount zurück (raumweite Abonnenten, einschließlich anonymer Viewer, die wir nicht aufzählen).

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJa
urlIdstringqueryJaSeiten‑URL‑Kennzeichen (serverseitig bereinigt).
afterNamestringqueryNeinCursor: übergebe nextAfterName aus der vorherigen Antwort.
afterUserIdstringqueryNeinCursor‑Tiebreaker: übergebe nextAfterUserId aus der vorherigen Antwort. Erforderlich, wenn afterName gesetzt ist, damit Namens‑Tie‑Einträge nicht weggelassen werden.

Antwort

Gibt zurück: PageUsersOnlineResponse

Beispiel

getOnlineUsers Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String | Seiten-URL-Kennzeichen (serverseitig bereinigt).
7final afterName = afterName_example; // String | Cursor: übergebe nextAfterName aus der vorherigen Antwort.
8final afterUserId = afterUserId_example; // String | Cursor‑Tiebreaker: übergebe nextAfterUserId aus der vorherigen Antwort. Erforderlich, wenn afterName gesetzt ist, damit Namens‑Tie‑Einträge nicht weggelassen werden.
9
10try {
11 final result = api_instance.getOnlineUsers(tenantId, urlId, GetOnlineUsersOptions(afterName: afterName, afterUserId: afterUserId));
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->getOnlineUsers: $e\n');
15}
16

Seite nach URL-ID abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
urlIdstringqueryJa

Antwort

Rückgabe: GetPageByURLIdAPIResponse

Beispiel

getPageByURLId Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um Präfix (z.B. Bearer) für API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final urlId = urlId_example; // String |
11
12try {
13 final result = api_instance.getPageByURLId(tenantId, urlId);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getPageByURLId: $e\n');
17}
18

Seiten abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes

Antwort

Rückgabe: GetPagesAPIResponse

Beispiel

getPages Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Autorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10
11try {
12 final result = api_instance.getPages(tenantId);
13 print(result);
14} catch (e) {
15 print('Exception when calling DefaultApi->getPages: $e\n');
16}
17

Öffentliche Seiten abrufen Internal Link

List pages for a tenant. Used by the FChat desktop client to populate its room list. Requires enableFChat to be true on the resolved custom config for each page. Pages that require SSO are filtered against the requesting user's group access.

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathYes
cursorstringqueryNoUndurchsichtiger Paginierungs‑Cursor, zurückgegeben als nextCursor von einer vorherigen Anforderung. Gebunden an das gleiche sortBy.
limitintegerqueryNo1..200, Standard 50
qstringqueryNoOptionaler, nicht‑groß-/kleinschreibungsempfindlicher Titelfilter‑Präfix.
sortBystringqueryNoSortierreihenfolge. updatedAt (Standard, neueste zuerst), commentCount (meiste Kommentare zuerst) oder title (alphabetisch).
hasCommentsbooleanqueryNoWenn true, nur Seiten zurückgeben, die mindestens einen Kommentar enthalten.

Antwort

Rückgabe: GetPublicPagesResponse

Beispiel

Beispiel getPagesPublic
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final cursor = cursor_example; // String | Undurchsichtiger Paginierungs‑Cursor, zurückgegeben als `nextCursor` von einer vorherigen Anforderung. Gebunden an das gleiche `sortBy`.
7final limit = 56; // int | 1..200, Standard 50
8final q = q_example; // String | Optionaler, nicht‑groß-/kleinschreibungsempfindlicher Titelfilter‑Präfix.
9final sortBy = ; // PagesSortBy | Sortierreihenfolge. `updatedAt` (Standard, neueste zuerst), `commentCount` (meiste Kommentare zuerst) oder `title` (alphabetisch).
10final hasComments = true; // bool | Wenn true, nur Seiten zurückgeben, die mindestens einen Kommentar enthalten.
11
12try {
13 final result = api_instance.getPagesPublic(tenantId, GetPagesPublicOptions(cursor: cursor, limit: limit, q: q, sortBy: sortBy, hasComments: hasComments));
14 print(result);
15} catch (e) {
16 print('Exception when calling PublicApi->getPagesPublic: $e\n');
17}
18

Benutzerinformationen abrufen Internal Link

Bulk-Benutzerinformationen für einen Mandanten. Anhand von userIds werden Anzeigeninformationen aus User / SSOUser zurückgegeben.
Wird vom Kommentar‑Widget verwendet, um Benutzer zu ergänzen, die gerade über ein Präsenzereignis erschienen sind.
Kein Seitenkontext: Datenschutz wird einheitlich durchgesetzt (private Profile werden maskiert).

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringpathJa
idsstringqueryJaKommagetrennte userIds.

Antwort

Rückgabe: PageUsersInfoResponse

Beispiel

getUsersInfo Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final ids = ids_example; // String | Kommagetrennte userIds.
7
8try {
9 final result = api_instance.getUsersInfo(tenantId, ids);
10 print(result);
11} catch (e) {
12 print('Exception when calling PublicApi->getUsersInfo: $e\n');
13}
14

Seite patchen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa

Antwort

Rückgabe: PatchPageAPIResponse

Beispiel

patchPage Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüssel-Authentifizierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie das Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API‑Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updateAPIPageData = UpdateAPIPageData(); // UpdateAPIPageData |
12
13try {
14 final result = api_instance.patchPage(tenantId, id, updateAPIPageData);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->patchPage: $e\n');
18}
19

Ausstehendes Webhook-Ereignis löschen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa

Antwort

Rückgabe: APIEmptyResponse

Beispiel

deletePendingWebhookEvent Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüssel-Authentifizierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entkommentieren Sie die folgende Zeile, um das Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.deletePendingWebhookEvent(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->deletePendingWebhookEvent: $e\n');
17}
18

Anzahl ausstehender Webhook-Ereignisse abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
commentIdstringqueryNein
externalIdstringqueryNein
eventTypestringqueryNein
typestringqueryNein
domainstringqueryNein
attemptCountGTnumberqueryNein

Antwort

Rückgabe: GetPendingWebhookEventCountResponse

Beispiel

getPendingWebhookEventCount Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um das Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final commentId = commentId_example; // String |
11final externalId = externalId_example; // String |
12final eventType = eventType_example; // String |
13final type = type_example; // String |
14final domain = domain_example; // String |
15final attemptCountGT = 1.2; // double |
16
17try {
18 final result = api_instance.getPendingWebhookEventCount(tenantId, GetPendingWebhookEventCountOptions(commentId: commentId, externalId: externalId, eventType: eventType, type: type, domain: domain, attemptCountGT: attemptCountGT));
19 print(result);
20} catch (e) {
21 print('Exception when calling DefaultApi->getPendingWebhookEventCount: $e\n');
22}
23

Ausstehende Webhook-Ereignisse abrufen Internal Link

Parameter

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringqueryNo
externalIdstringqueryNo
eventTypestringqueryNo
typestringqueryNo
domainstringqueryNo
attemptCountGTnumberqueryNo
skipnumberqueryNo

Antwort

Rückgabe: GetPendingWebhookEventsResponse

Beispiel

getPendingWebhookEvents Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüssel-Authentifizierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie das Kommentarzeichen unten, um das Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final commentId = commentId_example; // String |
11final externalId = externalId_example; // String |
12final eventType = eventType_example; // String |
13final type = type_example; // String |
14final domain = domain_example; // String |
15final attemptCountGT = 1.2; // double |
16final skip = 1.2; // double |
17
18try {
19 final result = api_instance.getPendingWebhookEvents(tenantId, GetPendingWebhookEventsOptions(commentId: commentId, externalId: externalId, eventType: eventType, type: type, domain: domain, attemptCountGT: attemptCountGT, skip: skip));
20 print(result);
21} catch (e) {
22 print('Exception when calling DefaultApi->getPendingWebhookEvents: $e\n');
23}
24

Fragenkonfiguration erstellen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa

Antwort

Returns: CreateQuestionConfigResponse

Beispiel

createQuestionConfig Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Autorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie die Auskommentierung unten, um das Präfix (z.B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createQuestionConfigBody = CreateQuestionConfigBody(); // CreateQuestionConfigBody |
11
12try {
13 final result = api_instance.createQuestionConfig(tenantId, createQuestionConfigBody);
14 print(result);
15} catch (e) {
16 // Ausnahme beim Aufruf von DefaultApi->createQuestionConfig: $e
17 print('Exception when calling DefaultApi->createQuestionConfig: $e\n');
18}
19

Fragenkonfiguration löschen Internal Link

Parameter

NameTypLocationErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa

Antwort

Returns: APIEmptyResponse

Beispiel

deleteQuestionConfig Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie den Kommentar unten, um den Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.deleteQuestionConfig(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->deleteQuestionConfig: $e\n');
17}
18

Fragenkonfiguration abrufen Internal Link

Parameter

NameTypStandortErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa

Antwort

Returns: GetQuestionConfigResponse

Beispiel

getQuestionConfig Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüssel-Authentifizierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Zeile auskommentieren, um Präfix (z. B. Bearer) für API-Schlüssel festzulegen, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getQuestionConfig(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getQuestionConfig: $e\n');
17}
18

Fragenkonfigurationen abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
skipnumberqueryNo

Antwort

Rückgabe: GetQuestionConfigsResponse

Beispiel

getQuestionConfigs Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API‑Schlüssel‑Authentifizierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final skip = 1.2; // double |
11
12try {
13 final result = api_instance.getQuestionConfigs(tenantId, skip);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getQuestionConfigs: $e\n');
17}
18

Fragenkonfiguration aktualisieren Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa

Antwort

Rückgabe: APIEmptyResponse

Beispiel

updateQuestionConfig Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um Präfix (z. B. Bearer) für API-Schlüssel festzulegen, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updateQuestionConfigBody = UpdateQuestionConfigBody(); // UpdateQuestionConfigBody |
12
13try {
14 final result = api_instance.updateQuestionConfig(tenantId, id, updateQuestionConfigBody);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->updateQuestionConfig: $e\n');
18}
19

Fragergebnis erstellen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa

Antwort

Rückgabe: CreateQuestionResultResponse

Beispiel

createQuestionResult Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie den Kommentar unten, um das Präfix (z.B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createQuestionResultBody = CreateQuestionResultBody(); // CreateQuestionResultBody |
11
12try {
13 final result = api_instance.createQuestionResult(tenantId, createQuestionResultBody);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->createQuestionResult: $e\n');
17}
18

Fragergebnis löschen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
idstringpathYes

Antwort

Rückgabe: APIEmptyResponse

Beispiel

deleteQuestionResult Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüsselautorisierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Kommentar unten auskommentieren, um Präfix (z. B. Bearer) für den API-Schlüssel festzulegen, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.deleteQuestionResult(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->deleteQuestionResult: $e\n');
17}
18

Fragergebnis abrufen Internal Link

Parameters

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
idstringpathYes

Response

Returns: GetQuestionResultResponse

Example

getQuestionResult Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüsselberechtigung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie den Kommentar unten, um das Präfix (e.g. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getQuestionResult(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getQuestionResult: $e\n');
17}
18

Fragergebnisse abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
urlIdstringqueryNein
userIdstringqueryNein
startDatestringqueryNein
questionIdstringqueryNein
questionIdsstringqueryNein
skipnumberqueryNein

Antwort

Returns: GetQuestionResultsResponse

Beispiel

Beispiel für getQuestionResults
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüssel-Authentifizierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entkommentieren Sie unten, um das Präfix (z. B. Bearer) für den API-Schlüssel festzulegen, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final urlId = urlId_example; // String |
11final userId = userId_example; // String |
12final startDate = startDate_example; // String |
13final questionId = questionId_example; // String |
14final questionIds = questionIds_example; // String |
15final skip = 1.2; // double |
16
17try {
18 final result = api_instance.getQuestionResults(tenantId, GetQuestionResultsOptions(urlId: urlId, userId: userId, startDate: startDate, questionId: questionId, questionIds: questionIds, skip: skip));
19 print(result);
20} catch (e) {
21 print('Exception when calling DefaultApi->getQuestionResults: $e\n');
22}
23

Fragergebnis aktualisieren Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Antwort

Rückgabe: APIEmptyResponse

Beispiel

updateQuestionResult Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüssel-Authentifizierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// entfernen Sie das Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel festzulegen, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updateQuestionResultBody = UpdateQuestionResultBody(); // UpdateQuestionResultBody |
12
13try {
14 final result = api_instance.updateQuestionResult(tenantId, id, updateQuestionResultBody);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->updateQuestionResult: $e\n');
18}
19

Fragergebnisse aggregieren Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
questionIdstringqueryNo
questionIdsarrayqueryNo
urlIdstringqueryNo
timeBucketstringqueryNo
startDatestringqueryNo
forceRecalculatebooleanqueryNo

Antwort

Rückgabe: AggregateQuestionResultsResponse

Beispiel

aggregateQuestionResults Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um Prefix (z.B. Bearer) für API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final questionId = questionId_example; // String |
11final questionIds = []; // List<String> |
12final urlId = urlId_example; // String |
13final timeBucket = ; // AggregateTimeBucket |
14final startDate = 2013-10-20T19:20:30+01:00; // DateTime |
15final forceRecalculate = true; // bool |
16
17try {
18 final result = api_instance.aggregateQuestionResults(tenantId, AggregateQuestionResultsOptions(questionId: questionId, questionIds: questionIds, urlId: urlId, timeBucket: timeBucket, startDate: startDate, forceRecalculate: forceRecalculate));
19 print(result);
20} catch (e) {
21 print('Exception when calling DefaultApi->aggregateQuestionResults: $e\n');
22}
23

Mehrfachaggregation von Fragergebnissen Internal Link

Parameter

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
forceRecalculatebooleanqueryNo

Antwort

Rückgabe: BulkAggregateQuestionResultsResponse

Beispiel

bulkAggregateQuestionResults Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüssel-Authentifizierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie das Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final bulkAggregateQuestionResultsRequest = BulkAggregateQuestionResultsRequest(); // BulkAggregateQuestionResultsRequest |
11final forceRecalculate = true; // bool |
12
13try {
14 final result = api_instance.bulkAggregateQuestionResults(tenantId, bulkAggregateQuestionResultsRequest, forceRecalculate);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->bulkAggregateQuestionResults: $e\n');
18}
19

Kommentare mit Fragergebnissen kombinieren Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
questionIdstringqueryNein
questionIdsarrayqueryNein
urlIdstringqueryNein
startDatestringqueryNein
forceRecalculatebooleanqueryNein
minValuenumberqueryNein
maxValuenumberqueryNein
limitnumberqueryNein

Antwort

Rückgabe: CombineQuestionResultsWithCommentsResponse

Beispiel

combineCommentsWithQuestionResults Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entkommentieren Sie unten, um das Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final questionId = questionId_example; // String |
11final questionIds = []; // List<String> |
12final urlId = urlId_example; // String |
13final startDate = 2013-10-20T19:20:30+01:00; // DateTime |
14final forceRecalculate = true; // bool |
15final minValue = 1.2; // double |
16final maxValue = 1.2; // double |
17final limit = 1.2; // double |
18
19try {
20 final result = api_instance.combineCommentsWithQuestionResults(tenantId, CombineCommentsWithQuestionResultsOptions(questionId: questionId, questionIds: questionIds, urlId: urlId, startDate: startDate, forceRecalculate: forceRecalculate, minValue: minValue, maxValue: maxValue, limit: limit));
21 print(result);
22} catch (e) {
23 print('Exception when calling DefaultApi->combineCommentsWithQuestionResults: $e\n');
24}
25

SSO-Benutzer hinzufügen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa

Antwort

Rückgabe: AddSSOUserAPIResponse

Beispiel

addSSOUser Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüsselauthorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createAPISSOUserData = CreateAPISSOUserData(); // CreateAPISSOUserData |
11
12try {
13 final result = api_instance.addSSOUser(tenantId, createAPISSOUserData);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->addSSOUser: $e\n');
17}
18

SSO-Benutzer löschen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa
deleteCommentsbooleanqueryNein
commentDeleteModestringqueryNein

Antwort

Gibt zurück: DeleteSSOUserAPIResponse

Beispiel

deleteSSOUser Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüsselberechtigung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie den Kommentar unten, um das Präfix (z.B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final deleteComments = true; // bool |
12final commentDeleteMode = commentDeleteMode_example; // String |
13
14try {
15 final result = api_instance.deleteSSOUser(tenantId, id, DeleteSSOUserOptions(deleteComments: deleteComments, commentDeleteMode: commentDeleteMode));
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->deleteSSOUser: $e\n');
19}
20

SSO-Benutzer per E-Mail abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringAbfrageJa
emailstringPfadJa

Antwort

Rückgabe: GetSSOUserByEmailAPIResponse

Beispiel

Beispiel für getSSOUserByEmail
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie das Kommentarzeichen unten, um das Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final email = email_example; // String |
11
12try {
13 final result = api_instance.getSSOUserByEmail(tenantId, email);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getSSOUserByEmail: $e\n');
17}
18

SSO-Benutzer per ID abrufen Internal Link

Parameter

NameTypeLocationRequiredDescription
tenantIdstringqueryJa
idstringpathJa

Antwort

Rückgabe: GetSSOUserByIdAPIResponse

Beispiel

getSSOUserById Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Autorisation konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// entferne den Kommentar unten, um das Präfix (z. B. Bearer) für den API‑Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getSSOUserById(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getSSOUserById: $e\n');
17}
18

SSO-Benutzer abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
skipintegerqueryNein

Antwort

Rückgabe: GetSSOUsersResponse

Beispiel

getSSOUsers Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Autorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entkommentieren Sie unten, um das Präfix (z. B. Bearer) für den API‑Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final skip = 56; // int |
11
12try {
13 final result = api_instance.getSSOUsers(tenantId, skip);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getSSOUsers: $e\n');
17}
18

SSO-Benutzer patchen Internal Link

Parameters

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
idstringpathYes
updateCommentsbooleanqueryNo

Antwort

Rückgabe: PatchSSOUserAPIResponse

Beispiel

patchSSOUser Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüssel-Authentifizierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie das Kommentarzeichen unten, um das Präfix (z.B. Bearer) für den API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updateAPISSOUserData = UpdateAPISSOUserData(); // UpdateAPISSOUserData |
12final updateComments = true; // bool |
13
14try {
15 final result = api_instance.patchSSOUser(tenantId, id, updateAPISSOUserData, updateComments);
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->patchSSOUser: $e\n');
19}
20

SSO-Benutzer setzen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa
updateCommentsbooleanqueryNein

Antwort

Rückgabe: PutSSOUserAPIResponse

Beispiel

putSSOUser Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüsselautorisierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie das Kommentarzeichen unten, um das Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updateAPISSOUserData = UpdateAPISSOUserData(); // UpdateAPISSOUserData |
12final updateComments = true; // bool |
13
14try {
15 final result = api_instance.putSSOUser(tenantId, id, updateAPISSOUserData, updateComments);
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->putSSOUser: $e\n');
19}
20

Abonnement erstellen Internal Link

Parameter

NameTypLocationErforderlichBeschreibung
tenantIdstringqueryJa

Antwort

Returns: CreateSubscriptionAPIResponse

Beispiel

createSubscription Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um Präfix (z. B. Bearer) für API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createAPIUserSubscriptionData = CreateAPIUserSubscriptionData(); // CreateAPIUserSubscriptionData |
11
12try {
13 final result = api_instance.createSubscription(tenantId, createAPIUserSubscriptionData);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->createSubscription: $e\n');
17}
18

Abonnement löschen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa
userIdstringqueryNein

Antwort

Rückgabe: DeleteSubscriptionAPIResponse

Beispiel

deleteSubscription Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Autorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Kommentiere die folgende Zeile aus, um das Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final userId = userId_example; // String |
12
13try {
14 final result = api_instance.deleteSubscription(tenantId, id, userId);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->deleteSubscription: $e\n');
18}
19

Abonnements abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
userIdstringqueryNein

Antwort

Rückgabe: GetSubscriptionsAPIResponse

Beispiel

getSubscriptions Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Autorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie das Kommentarzeichen unten, um Präfix (z. B. Bearer) für den API-Schlüssel festzulegen, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final userId = userId_example; // String |
11
12try {
13 final result = api_instance.getSubscriptions(tenantId, userId);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getSubscriptions: $e\n');
17}
18

Abonnement aktualisieren Internal Link

Parameters

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo

Response

Rückgabe: UpdateSubscriptionAPIResponse

Beispiel

updateSubscription Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Autorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um Prefix (z.B. Bearer) für API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updateAPIUserSubscriptionData = UpdateAPIUserSubscriptionData(); // UpdateAPIUserSubscriptionData |
12final userId = userId_example; // String |
13
14try {
15 final result = api_instance.updateSubscription(tenantId, id, updateAPIUserSubscriptionData, userId);
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->updateSubscription: $e\n');
19}
20

Tägliche Nutzung des Mandanten abrufen Internal Link

Parameters

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
yearNumbernumberqueryNein
monthNumbernumberqueryNein
dayNumbernumberqueryNein
skipnumberqueryNein

Response

Rückgabe: GetTenantDailyUsagesResponse

Example

getTenantDailyUsages Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entkommentiere unten, um das Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final yearNumber = 1.2; // double |
11final monthNumber = 1.2; // double |
12final dayNumber = 1.2; // double |
13final skip = 1.2; // double |
14
15try {
16 final result = api_instance.getTenantDailyUsages(tenantId, GetTenantDailyUsagesOptions(yearNumber: yearNumber, monthNumber: monthNumber, dayNumber: dayNumber, skip: skip));
17 print(result);
18} catch (e) {
19 print('Exception when calling DefaultApi->getTenantDailyUsages: $e\n');
20}
21

Mandantenpaket erstellen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa

Antwort

Rückgabe: CreateTenantPackageResponse

Beispiel

createTenantPackage Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Autorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createTenantPackageBody = CreateTenantPackageBody(); // CreateTenantPackageBody |
11
12try {
13 final result = api_instance.createTenantPackage(tenantId, createTenantPackageBody);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->createTenantPackage: $e\n');
17}
18

Mandantenpaket löschen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa

Antwort

Rückgabe: APIEmptyResponse

Beispiel

deleteTenantPackage Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüssel-Authentifizierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entkommentieren Sie unten, um das Präfix (z.B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.deleteTenantPackage(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->deleteTenantPackage: $e\n');
17}
18

Mandantenpaket abrufen Internal Link

Parameter

NameTypLocationErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa

Antwort

Rückgabe: GetTenantPackageResponse

Beispiel

getTenantPackage Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Kommentar unten entfernen, um Präfix (z. B. Bearer) für API-Schlüssel festzulegen, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getTenantPackage(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getTenantPackage: $e\n');
17}
18

Mandantenpakete abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
skipnumberqueryNein

Antwort

Rückgabe: GetTenantPackagesResponse

Beispiel

getTenantPackages Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Kommentar entfernen unten, um Präfix (z. B. Bearer) für API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final skip = 1.2; // double |
11
12try {
13 final result = api_instance.getTenantPackages(tenantId, skip);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getTenantPackages: $e\n');
17}
18

Mandantenpaket ersetzen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
idstringpathYes

Antwort

Rückgabe: APIEmptyResponse

Beispiel

replaceTenantPackage Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüssel-Authentifizierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie den Kommentar unten, um das Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final replaceTenantPackageBody = ReplaceTenantPackageBody(); // ReplaceTenantPackageBody |
12
13try {
14 final result = api_instance.replaceTenantPackage(tenantId, id, replaceTenantPackageBody);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->replaceTenantPackage: $e\n');
18}
19

Mandantenpaket aktualisieren Internal Link

Parameters

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa

Antwort

Rückgabe: APIEmptyResponse

Beispiel

updateTenantPackage Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie die Kommentierung unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updateTenantPackageBody = UpdateTenantPackageBody(); // UpdateTenantPackageBody |
12
13try {
14 final result = api_instance.updateTenantPackage(tenantId, id, updateTenantPackageBody);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->updateTenantPackage: $e\n');
18}
19

Mandantenbenutzer erstellen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa

Antwort

Rückgabe: CreateTenantUserResponse

Beispiel

createTenantUser Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Autorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um das Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createTenantUserBody = CreateTenantUserBody(); // CreateTenantUserBody |
11
12try {
13 final result = api_instance.createTenantUser(tenantId, createTenantUserBody);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->createTenantUser: $e\n');
17}
18

Mandantenbenutzer löschen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
idstringpathYes
deleteCommentsstringqueryNo
commentDeleteModestringqueryNo

Antwort

Rückgabe: APIEmptyResponse

Beispiel

deleteTenantUser Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um Präfix (z. B. Bearer) für API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final deleteComments = deleteComments_example; // String |
12final commentDeleteMode = commentDeleteMode_example; // String |
13
14try {
15 final result = api_instance.deleteTenantUser(tenantId, id, DeleteTenantUserOptions(deleteComments: deleteComments, commentDeleteMode: commentDeleteMode));
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->deleteTenantUser: $e\n');
19}
20

Mandantenbenutzer abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa

Antwort

Rückgabe: GetTenantUserResponse

Beispiel

getTenantUser Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüsselautorisation konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// entferne den Kommentar unten, um das Präfix (z.B. Bearer) für den API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getTenantUser(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getTenantUser: $e\n');
17}
18

Mandantenbenutzer abrufen Internal Link

Parameter

NameTypeLocationRequiredBeschreibung
tenantIdstringqueryYes
skipnumberqueryNo

Antwort

Rückgabe: GetTenantUsersResponse

Beispiel

getTenantUsers Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Autorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// entfernen Sie das Kommentarzeichen unten, um das Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final skip = 1.2; // double |
11
12try {
13 final result = api_instance.getTenantUsers(tenantId, skip);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getTenantUsers: $e\n');
17}
18

Mandantenbenutzer ersetzen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
idstringpathYes
updateCommentsstringqueryNo

Antwort

Rückgabe: APIEmptyResponse

Beispiel

replaceTenantUser Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüsselautorisierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final replaceTenantUserBody = ReplaceTenantUserBody(); // ReplaceTenantUserBody |
12final updateComments = updateComments_example; // String |
13
14try {
15 final result = api_instance.replaceTenantUser(tenantId, id, replaceTenantUserBody, updateComments);
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->replaceTenantUser: $e\n');
19}
20

Parameter

NameTypLocationErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa
redirectURLstringqueryNein

Antwort

Rückgabe: APIEmptyResponse

Beispiel

sendLoginLink Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüssel‑Autorisierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final redirectURL = redirectURL_example; // String |
12
13try {
14 final result = api_instance.sendLoginLink(tenantId, id, redirectURL);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->sendLoginLink: $e\n');
18}
19

Mandantenbenutzer aktualisieren Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa
updateCommentsstringqueryNein

Antwort

Returns: APIEmptyResponse

Beispiel

updateTenantUser Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um ein Präfix (z. B. Bearer) für den API-Schlüssel festzulegen, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updateTenantUserBody = UpdateTenantUserBody(); // UpdateTenantUserBody |
12final updateComments = updateComments_example; // String |
13
14try {
15 final result = api_instance.updateTenantUser(tenantId, id, updateTenantUserBody, updateComments);
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->updateTenantUser: $e\n');
19}
20

Mandant erstellen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa

Antwort

Rückgabe: CreateTenantResponse

Beispiel

createTenant Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um das Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createTenantBody = CreateTenantBody(); // CreateTenantBody |
11
12try {
13 final result = api_instance.createTenant(tenantId, createTenantBody);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->createTenant: $e\n');
17}
18

Mandant löschen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa
surestringqueryNein

Antwort

Rückgabe: APIEmptyResponse

Beispiel

deleteTenant Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final sure = sure_example; // String |
12
13try {
14 final result = api_instance.deleteTenant(tenantId, id, sure);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->deleteTenant: $e\n');
18}
19

Mandant abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa

Antwort

Rückgabe: GetTenantResponse

Beispiel

getTenant Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um das Präfix (z.B. Bearer) für den API-Schlüssel festzulegen, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getTenant(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getTenant: $e\n');
17}
18

Mandanten abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
metastringqueryNein
skipnumberqueryNein

Antwort

Rückgabe: GetTenantsResponse

Beispiel

getTenants Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final meta = meta_example; // String |
11final skip = 1.2; // double |
12
13try {
14 final result = api_instance.getTenants(tenantId, GetTenantsOptions(meta: meta, skip: skip));
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->getTenants: $e\n');
18}
19

Mandant aktualisieren Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa

Antwort

Returns: APIEmptyResponse

Beispiel

updateTenant Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Autorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// auskommentieren Sie unten, um ein Prefix (z.B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updateTenantBody = UpdateTenantBody(); // UpdateTenantBody |
12
13try {
14 final result = api_instance.updateTenant(tenantId, id, updateTenantBody);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->updateTenant: $e\n');
18}
19

Ticketstatus ändern Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
userIdstringqueryJa
idstringpathJa

Antwort

Rückgabe: ChangeTicketStateResponse

Beispiel

changeTicketState Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel Authorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final userId = userId_example; // String |
11final id = id_example; // String |
12final changeTicketStateBody = ChangeTicketStateBody(); // ChangeTicketStateBody |
13
14try {
15 final result = api_instance.changeTicketState(tenantId, userId, id, changeTicketStateBody);
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->changeTicketState: $e\n');
19}
20

Ticket erstellen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
userIdstringqueryJa

Antwort

Rückgabe: CreateTicketResponse

Beispiel

createTicket Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um Prefix (z.B. Bearer) für API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final userId = userId_example; // String |
11final createTicketBody = CreateTicketBody(); // CreateTicketBody |
12
13try {
14 final result = api_instance.createTicket(tenantId, userId, createTicketBody);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->createTicket: $e\n');
18}
19

Ticket abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo

Antwort

Rückgabe: GetTicketResponse

Beispiel

getTicket Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um Präfix (e.g. Bearer) für API-Schlüssel einzurichten, falls benötigt
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final userId = userId_example; // String |
12
13try {
14 final result = api_instance.getTicket(tenantId, id, userId);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->getTicket: $e\n');
18}
19

Tickets abrufen Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
userIdstringqueryNo
statenumberqueryNo
skipnumberqueryNo
limitnumberqueryNo

Response

Rückgabe: GetTicketsResponse

Example

getTickets Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüsselautorisierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entkommentieren Sie unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final userId = userId_example; // String |
11final state = 1.2; // double |
12final skip = 1.2; // double |
13final limit = 1.2; // double |
14
15try {
16 final result = api_instance.getTickets(tenantId, GetTicketsOptions(userId: userId, state: state, skip: skip, limit: limit));
17 print(result);
18} catch (e) {
19 print('Exception when calling DefaultApi->getTickets: $e\n');
20}
21

Übersetzungen abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
namespacestringpathJa
componentstringpathJa
localestringqueryNein
useFullTranslationIdsbooleanqueryNein

Antwort

Rückgabe: GetTranslationsResponse

Beispiel

getTranslations Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final namespace = namespace_example; // String |
6final component = component_example; // String |
7final locale = locale_example; // String |
8final useFullTranslationIds = true; // bool |
9
10try {
11 final result = api_instance.getTranslations(namespace, component, GetTranslationsOptions(locale: locale, useFullTranslationIds: useFullTranslationIds));
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->getTranslations: $e\n');
15}
16

Bild hochladen Internal Link

Upload and resize an image

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
sizePresetstringqueryNoGrößen‑Voreinstellung: "Default" (1000x1000px) oder "CrossPlatform" (erstellt Größen für gängige Geräte)
urlIdstringqueryNoSeiten‑ID, von der der Upload erfolgt, zur Konfiguration

Response

Returns: UploadImageResponse

Example

uploadImage Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final file = BINARY_DATA_HERE; // MultipartFile |
7final sizePreset = ; // SizePreset | Größen‑Voreinstellung: \"Default\" (1000x1000px) oder \"CrossPlatform\" (erstellt Größen für gängige Geräte)
8final urlId = urlId_example; // String | Seiten‑ID, von der der Upload erfolgt, zur Konfiguration
9
10try {
11 final result = api_instance.uploadImage(tenantId, file, UploadImageOptions(sizePreset: sizePreset, urlId: urlId));
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->uploadImage: $e\n');
15}
16

Benutzer-Abzeichen-Fortschritt nach ID abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
idstringpathYes

Antwort

Rückgabe: APIGetUserBadgeProgressResponse

Beispiel

getUserBadgeProgressById Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entkommentieren Sie unten, um das Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getUserBadgeProgressById(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getUserBadgeProgressById: $e\n');
17}
18

Benutzer-Abzeichen-Fortschritt nach Benutzer-ID abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
userIdstringpathYes

Antwort

Rückgabe: APIGetUserBadgeProgressResponse

Beispiel

getUserBadgeProgressByUserId Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Auskommentieren Sie die nachfolgende Zeile, um das Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final userId = userId_example; // String |
11
12try {
13 final result = api_instance.getUserBadgeProgressByUserId(tenantId, userId);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getUserBadgeProgressByUserId: $e\n');
17}
18

Liste des Benutzer-Abzeichen-Fortschritts abrufen Internal Link

Parameter

NameTypLocationErforderlichBeschreibung
tenantIdstringqueryJa
userIdstringqueryNein
limitnumberqueryNein
skipnumberqueryNein

Antwort

Returns: APIGetUserBadgeProgressListResponse

Beispiel

Beispiel für getUserBadgeProgressList
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Autorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entkommentieren Sie die folgende Zeile, um das Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final userId = userId_example; // String |
11final limit = 1.2; // double |
12final skip = 1.2; // double |
13
14try {
15 final result = api_instance.getUserBadgeProgressList(tenantId, GetUserBadgeProgressListOptions(userId: userId, limit: limit, skip: skip));
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->getUserBadgeProgressList: $e\n');
19}
20

Benutzerabzeichen erstellen Internal Link

Parameter

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

Antwort

Rückgabe: APICreateUserBadgeResponse

Beispiel

createUserBadge Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um Präfix (z.B. Bearer) für API-Schlüssel festzulegen, falls benötigt
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createUserBadgeParams = CreateUserBadgeParams(); // CreateUserBadgeParams |
11
12try {
13 final result = api_instance.createUserBadge(tenantId, createUserBadgeParams);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->createUserBadge: $e\n');
17}
18

Benutzerabzeichen löschen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa

Antwort

Rückgabe: APIEmptySuccessResponse

Beispiel

deleteUserBadge Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Kommentiere die folgende Zeile aus, um das Präfix (z. B. Bearer) für den API‑Schlüssel festzulegen, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.deleteUserBadge(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->deleteUserBadge: $e\n');
17}
18

Benutzerabzeichen abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
idstringpathYes

Antwort

Returns: APIGetUserBadgeResponse

Beispiel

getUserBadge Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüssel-Authentifizierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getUserBadge(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getUserBadge: $e\n');
17}
18

Benutzerabzeichen abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
userIdstringqueryNein
badgeIdstringqueryNein
typenumberqueryNein
displayedOnCommentsbooleanqueryNein
limitnumberqueryNein
skipnumberqueryNein

Antwort

Rückgabe: APIGetUserBadgesResponse

Beispiel

getUserBadges Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entfernen Sie das Kommentarzeichen unten, um das Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls benötigt
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final userId = userId_example; // String |
11final badgeId = badgeId_example; // String |
12final type = 1.2; // double |
13final displayedOnComments = true; // bool |
14final limit = 1.2; // double |
15final skip = 1.2; // double |
16
17try {
18 final result = api_instance.getUserBadges(tenantId, GetUserBadgesOptions(userId: userId, badgeId: badgeId, type: type, displayedOnComments: displayedOnComments, limit: limit, skip: skip));
19 print(result);
20} catch (e) {
21 print('Exception when calling DefaultApi->getUserBadges: $e\n');
22}
23

Benutzerabzeichen aktualisieren Internal Link

Parameter

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Antwort

Returns: APIEmptySuccessResponse

Beispiel

updateUserBadge Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüssel-Authentifizierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// entkommentieren Sie unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updateUserBadgeParams = UpdateUserBadgeParams(); // UpdateUserBadgeParams |
12
13try {
14 final result = api_instance.updateUserBadge(tenantId, id, updateUserBadgeParams);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->updateUserBadge: $e\n');
18}
19

Benutzerbenachrichtigungszähler abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
ssostringqueryNo

Antwort

Rückgabe: GetUserNotificationCountResponse

Beispiel

getUserNotificationCount Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final sno = sso_example; // String |
7
8try {
9 final result = api_instance.getUserNotificationCount(tenantId, sso);
10 print(result);
11} catch (e) {
12 print('Exception when calling PublicApi->getUserNotificationCount: $e\n');
13}
14

Benutzerbenachrichtigungen abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
urlIdstringqueryNoWird verwendet, um zu bestimmen, ob die aktuelle Seite abonniert ist.
pageSizeintegerqueryNo
afterIdstringqueryNo
includeContextbooleanqueryNo
afterCreatedAtintegerqueryNo
unreadOnlybooleanqueryNo
dmOnlybooleanqueryNo
noDmbooleanqueryNo
includeTranslationsbooleanqueryNo
includeTenantNotificationsbooleanqueryNo
ssostringqueryNo

Antwort

Rückgabe: GetMyNotificationsResponse

Beispiel

getUserNotifications Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String | Wird verwendet, um zu bestimmen, ob die aktuelle Seite abonniert ist.
7final pageSize = 56; // int |
8final afterId = afterId_example; // String |
9final includeContext = true; // bool |
10final afterCreatedAt = 789; // int |
11final unreadOnly = true; // bool |
12final dmOnly = true; // bool |
13final noDm = true; // bool |
14final includeTranslations = true; // bool |
15final includeTenantNotifications = true; // bool |
16final sso = sso_example; // String |
17
18try {
19 final result = api_instance.getUserNotifications(tenantId, GetUserNotificationsOptions(urlId: urlId, pageSize: pageSize, afterId: afterId, includeContext: includeContext, afterCreatedAt: afterCreatedAt, unreadOnly: unreadOnly, dmOnly: dmOnly, noDm: noDm, includeTranslations: includeTranslations, includeTenantNotifications: includeTenantNotifications, sso: sso));
20 print(result);
21} catch (e) {
22 print('Exception when calling PublicApi->getUserNotifications: $e\n');
23}
24

Benutzerbenachrichtigungszähler zurücksetzen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
ssostringqueryNein

Antwort

Rückgabe: ResetUserNotificationsResponse

Beispiel

resetUserNotificationCount Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final sso = sso_example; // String |
7
8try {
9 final result = api_instance.resetUserNotificationCount(tenantId, sso);
10 print(result);
11} catch (e) {
12 print('Exception when calling PublicApi->resetUserNotificationCount: $e\n');
13}
14

Benutzerbenachrichtigungen zurücksetzen Internal Link

Parameter

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
afterIdstringqueryNo
afterCreatedAtintegerqueryNo
unreadOnlybooleanqueryNo
dmOnlybooleanqueryNo
noDmbooleanqueryNo
ssostringqueryNo

Antwort

Rückgabe: ResetUserNotificationsResponse

Beispiel

resetUserNotifications Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final afterId = afterId_example; // String |
7final afterCreatedAt = 789; // int |
8final unreadOnly = true; // bool |
9final dmOnly = true; // bool |
10final noDm = true; // bool |
11final sso = sso_example; // String |
12
13try {
14 final result = api_instance.resetUserNotifications(tenantId, ResetUserNotificationsOptions(afterId: afterId, afterCreatedAt: afterCreatedAt, unreadOnly: unreadOnly, dmOnly: dmOnly, noDm: noDm, sso: sso));
15 print(result);
16} catch (e) {
17 print('Exception when calling PublicApi->resetUserNotifications: $e\n');
18}
19

Kommentar-Abonnement-Status der Benutzerbenachrichtigung aktualisieren Internal Link

Enable or disable notifications for a specific comment.

Parameters

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
notificationIdstringpathYes
optedInOrOutstringpathYes
commentIdstringqueryYes
ssostringqueryNo

Response

Rückgabe: UpdateUserNotificationCommentSubscriptionStatusResponse

Example

updateUserNotificationCommentSubscriptionStatus Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final notificationId = notificationId_example; // String |
7final optedInOrOut = optedInOrOut_example; // String |
8final commentId = commentId_example; // String |
9final sso = sso_example; // String |
10
11try {
12 final result = api_instance.updateUserNotificationCommentSubscriptionStatus(tenantId, notificationId, optedInOrOut, commentId, sso);
13 print(result);
14} catch (e) {
15 print('Exception when calling PublicApi->updateUserNotificationCommentSubscriptionStatus: $e\n');
16}
17

Seiten-Abonnement-Status der Benutzerbenachrichtigung aktualisieren Internal Link

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

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
urlIdstringqueryJa
urlstringqueryJa
pageTitlestringqueryJa
subscribedOrUnsubscribedstringpathJa
ssostringqueryNein

Antwort

Rückgabe: UpdateUserNotificationPageSubscriptionStatusResponse

Beispiel

updateUserNotificationPageSubscriptionStatus Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7final url = url_example; // String |
8final pageTitle = pageTitle_example; // String |
9final subscribedOrUnsubscribed = subscribedOrUnsubscribed_example; // String |
10final sso = sso_example; // String |
11
12try {
13 final result = api_instance.updateUserNotificationPageSubscriptionStatus(tenantId, urlId, url, pageTitle, subscribedOrUnsubscribed, sso);
14 print(result);
15} catch (e) {
16 print('Exception when calling PublicApi->updateUserNotificationPageSubscriptionStatus: $e\n');
17}
18

Benutzerbenachrichtigungsstatus aktualisieren Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
notificationIdstringpathJa
newStatusstringpathJa
ssostringqueryNein

Antwort

Rückgabe: UpdateUserNotificationStatusResponse

Beispiel

updateUserNotificationStatus Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final notificationId = notificationId_example; // String |
7final newStatus = newStatus_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.updateUserNotificationStatus(tenantId, notificationId, newStatus, sso);
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->updateUserNotificationStatus: $e\n');
15}
16

Anwesenheitsstatus der Benutzer abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
urlIdWSstringqueryJa
userIdsstringqueryJa

Antwort

Rückgabe: GetUserPresenceStatusesResponse

Beispiel

getUserPresenceStatuses Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlIdWS = urlIdWS_example; // String |
7final userIds = userIds_example; // String |
8
9try {
10 final result = api_instance.getUserPresenceStatuses(tenantId, urlIdWS, userIds);
11 print(result);
12} catch (e) {
13 print('Exception when calling PublicApi->getUserPresenceStatuses: $e\n');
14}
15

Benutzer suchen Internal Link

Parameter

NameTypLocationErforderlichBeschreibung
tenantIdstringpathJa
urlIdstringqueryJa
usernameStartsWithstringqueryNein
mentionGroupIdsarrayqueryNein
ssostringqueryNein
searchSectionstringqueryNein

Antwort

Rückgabe: SearchUsersResult

Beispiel

searchUsers Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7final usernameStartsWith = usernameStartsWith_example; // String |
8final mentionGroupIds = []; // List<String> |
9final sso = sso_example; // String |
10final searchSection = searchSection_example; // String |
11
12try {
13 final result = api_instance.searchUsers(tenantId, urlId, SearchUsersOptions(usernameStartsWith: usernameStartsWith, mentionGroupIds: mentionGroupIds, sso: sso, searchSection: searchSection));
14 print(result);
15} catch (e) {
16 print('Exception when calling PublicApi->searchUsers: $e\n');
17}
18

Benutzer abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa

Antwort

Rückgabe: GetUserResponse

Beispiel

getUser Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getUser(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getUser: $e\n');
17}
18

Abstimmung erstellen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryYes
commentIdstringqueryYes
directionstringqueryYes
userIdstringqueryNo
anonUserIdstringqueryNo

Antwort

Rückgabe: VoteResponse

Beispiel

createVote Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüsselautorisierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Kommentieren Sie die folgende Zeile aus, um das Präfix (z. B. Bearer) für den API‑Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final commentId = commentId_example; // String |
11final direction = direction_example; // String |
12final userId = userId_example; // String |
13final anonUserId = anonUserId_example; // String |
14
15try {
16 final result = api_instance.createVote(tenantId, commentId, direction, CreateVoteOptions(userId: userId, anonUserId: anonUserId));
17 print(result);
18} catch (e) {
19 print('Exception when calling DefaultApi->createVote: $e\n');
20}
21

Abstimmung löschen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
idstringpathJa
editKeystringqueryNein

Antwort

Rückgabe: VoteDeleteResponse

Beispiel

deleteVote Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API-Schlüssel-Autorisierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Auskommentieren Sie unten, um das Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final editKey = editKey_example; // String |
12
13try {
14 final result = api_instance.deleteVote(tenantId, id, editKey);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->deleteVote: $e\n');
18}
19

Abstimmungen abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
urlIdstringqueryJa

Antwort

Rückgabe: GetVotesResponse

Beispiel

getVotes Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO API‑Schlüssel‑Authentifizierung konfigurieren: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// unten auskommentieren, um ein Präfix (z. B. Bearer) für den API‑Schlüssel einzurichten, falls nötig
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final urlId = urlId_example; // String |
11
12try {
13 final result = api_instance.getVotes(tenantId, urlId);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getVotes: $e\n');
17}
18

Abstimmungen für Benutzer abrufen Internal Link

Parameter

NameTypOrtErforderlichBeschreibung
tenantIdstringqueryJa
urlIdstringqueryJa
userIdstringqueryNein
anonUserIdstringqueryNein

Antwort

Rückgabe: GetVotesForUserResponse

Beispiel

getVotesForUser Beispiel
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Konfigurieren Sie die API-Schlüsselautorisierung: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Entkommentieren Sie unten, um das Präfix (z.B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final urlId = urlId_example; // String |
11final userId = userId_example; // String |
12final anonUserId = anonUserId_example; // String |
13
14try {
15 final result = api_instance.getVotesForUser(tenantId, urlId, GetVotesForUserOptions(userId: userId, anonUserId: anonUserId));
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->getVotesForUser: $e\n');
19}
20

Brauchen Sie Hilfe?

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

Beitragen

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