FastComments JavaScript/TypeScript SDK

Geben Sie Ihrem Coding‑Agent den FastComments‑Kontext, den er benötigt – Widgets, Konfiguration, Secure SSO, die REST‑API und die SDKs:

npx skills add fastcomments/skills

Funktioniert mit Claude Code, Codex, Cursor, Copilot, Gemini und jedem anderen Agenten, den das skills CLI unterstützt.

npm install fastcomments-sdk

Vollständige API-Referenz: docs/api/README.md

Dieses SDK verwendet zwei Einstiegspunkte, um optimale Kompatibilität sicherzustellen und Laufzeitfehler zu vermeiden:

• fastcomments-sdk/browser - Browser-sichere Version mit nativer fetch-Unterstützung
• fastcomments-sdk/server - Vollständige Node.js-Version mit SSO-Unterstützung
• fastcomments-sdk (Standard) - Nur Typen, sicher überall zu importieren

Das SDK stellt diese API-Klassen bereit:

• DefaultApi - Gesicherte Endpunkte, die Ihren API-Schlüssel zur Authentifizierung benötigen. Verwenden Sie diese für serverseitige Vorgänge.
• PublicApi - Öffentliche Endpunkte, die ohne API-Schlüssel zugänglich sind. Diese können direkt von Browsern/Mobilgeräten/etc. aufgerufen werden.
• ModerationApi - Moderator-Dashboard-Endpunkte (Kommentar-Moderation, Sperren, Abzeichen, Vertrauensfaktor, Suche). Authentifiziert durch die Sitzung des Moderators; übergeben Sie den sso-Abfrageparameter für SSO-authentifizierte Moderatoren.
• HiddenApi - Interne/Admin-Endpunkte für erweiterte Anwendungsfälle.

Beispiel: Verwendung der Public API (browser-sicher)

import { PublicApi } from 'fastcomments-sdk/browser';

const publicApi = new PublicApi();

// Kommentare für eine Seite abrufen (kein API-Schlüssel erforderlich)
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Beispiel: Verwendung der Default API (nur serverseitig)

import { DefaultApi, Configuration } from 'fastcomments-sdk/server';

const config = new Configuration({
  apiKey: 'your-api-key' // Geheim halten!
});
const defaultApi = new DefaultApi(config);

// Kommentare mit vollem Administratorzugriff abrufen
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Beispiel: Verwendung der Moderation API

import { createFastCommentsSDK } from 'fastcomments-sdk/server';

const sdk = createFastCommentsSDK({ /* basePath usw. */ });

// Durch Moderator authentifizierte Aufrufe (Session-Cookie oder `sso` für einen SSO-Moderator übergeben).
const comments = await sdk.moderationApi.getApiComments({
  tenantId: 'your-tenant-id'
});

await sdk.moderationApi.postSetCommentSpamStatus({
  commentId: 'comment-id',
  spam: true
});

FastComments unterstützt SSO, um sich in Ihr bestehendes Benutzerauthentifizierungssystem zu integrieren. Die SSO-Funktionalität ist nur im Server-Export verfügbar, da sie Node.js-Crypto-Funktionen benötigt.

Einfache SSO (nur serverseitig)

Einfache SSO sollte serverseitig erzeugt und an den Client gesendet werden:

// Server-seitiger Code (Node.js/Backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Erstelle einfache SSO mit dem eingebauten Helfer  
const userData = {
  username: 'john_doe',
  email: 'john@example.com',
  displayName: 'John Doe',
  avatar: 'https://example.com/avatar.jpg'
};

const sso = FastCommentsSSO.createSimple(userData, {
  loginURL: '/login',
  logoutURL: '/logout'
});

const ssoToken = sso.createToken();

// Sende ssoToken an Ihren Client-Code
// Der Client-Code kann dieses Token dann mit dem Browser-SDK verwenden

Sichere SSO (serverseitig, empfohlen)

Sichere SSO sollte serverseitig implementiert werden und bietet bessere Sicherheit:

// Server-seitiger Code (Node.js/Backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Erstelle sichere SSO mit dem eingebauten Helfer
const userData = {
  id: 'user-123',
  email: 'john@example.com',
  username: 'john_doe',
  displayName: 'John Doe',
  avatar: 'https://example.com/avatar.jpg',
  isAdmin: false,
  isModerator: false
};

const sso = FastCommentsSSO.createSecure('your-api-key', userData, {
  loginURL: '/login',
  logoutURL: '/logout'
});

const ssoConfig = sso.prepareToSend();

// Mit API-Aufrufen auf dem Server verwenden
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: JSON.stringify(ssoConfig)
});

// Oder sende ssoConfig an den Client zur Browser-Verwendung

Verwendung von SSO im Browser (mit servergeneriertem Token)

// Client-seitiger Code (Browser)
import { PublicApi } from 'fastcomments-sdk/browser';

// Hole SSO-Token von Ihrem Server-Endpunkt
const ssoToken = await fetch('/api/sso-token').then(r => r.json());

const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: ssoToken // Use the server-generated SSO token
});

SSO mit Kommentar-Erstellung

// Server-seitig: SSO und Kommentar erstellen
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

const sso = FastCommentsSSO.createSecure('your-api-key', userData);
const ssoConfig = sso.prepareToSend();

const response = await publicApi.createCommentPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  broadcastId: 'unique-broadcast-id',
  commentData: {
    comment: 'This is my comment',
    date: Date.now(),
    commenterName: 'John Doe',
    url: 'https://example.com/page',
    urlId: 'page-url-id'
  },
  sso: JSON.stringify(ssoConfig)
});

Kommentare für eine Seite abrufen

const comments = await sdk.publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'article-123'
});

Einen Kommentar erstellen

const newComment = await sdk.publicApi.createCommentPublic({
  createCommentParams: {
    tenantId: 'your-tenant-id',
    urlId: 'article-123',
    comment: 'Great article!',
    commenterName: 'John Doe',
    commenterEmail: 'john@example.com'
  }
});

Für einen Kommentar abstimmen

const voteResponse = await sdk.publicApi.voteComment({
  voteBodyParams: {
    commentId: 'comment-id',
    direction: 1 // 1 für Upvote, -1 für Downvote
  }
});

Benutzerverwaltung (erfordert API-Schlüssel)

// Benutzer suchen (erfordert DefaultApi)
const users = await sdk.defaultApi.searchUsers({
  tenantId: 'your-tenant-id',
  urlId: 'page-id',
  usernameStartsWith: 'john'
});

Abonnieren Sie Live-Ereignisse, um Echtzeit-Updates für Kommentare, Abstimmungen und andere Aktivitäten zu erhalten.

Ereignisse auf Seitenebene

Abonnieren Sie Live-Ereignisse für eine bestimmte Seite (Kommentare, Abstimmungen usw.):

import { subscribeToChanges, LiveEvent, LiveEventType } from 'fastcomments-sdk/browser';

const config = {
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
};

// Subscribe to live events for a page
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (get this from getComments response)
  (event: LiveEvent) => {
    console.log('Live event received:', event);
    
    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // Aktualisieren Sie Ihre UI mit dem neuen Kommentar
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Aktualisieren Sie die Abstimmungszahlen in Ihrer UI
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }
    
    return true; // Geben Sie true zurück, wenn das Ereignis verarbeitet wurde
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Close the subscription when done
subscription.close();

Benutzerbezogene Ereignisse abonnieren

Abonnieren Sie benutzerspezifische Ereignisse (Benachrichtigungen, Erwähnungen usw.):

import { subscribeToUserFeed, LiveEvent, LiveEventType } from 'fastcomments-sdk/browser';

const userConfig = {
  userIdWS: 'user-session-id', // Get this from getComments response
};

// Subscribe to user's personal feed
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);
    
    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // Benachrichtigung in Ihrer UI anzeigen
        break;
      case LiveEventType.notification_update:
        console.log('Notification updated:', event.notification);
        break;
      default:
        console.log('Other user event:', event.type);
    }
    
    return true;
  },
  (isConnected: boolean) => {
    console.log('User feed connection:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Close when done
userSubscription.close();

Abrufen von userIdWS

Der userIdWS Parameter wird für Live-Ereignisse benötigt und kann aus API-Antworten abgerufen werden:

const response = await sdk.publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-id'
});

// Extract userIdWS from the response
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // Now you can subscribe to live events
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

Sie werden sehen, dass Sie in einigen API-Aufrufen eine broadcastId übergeben sollen. Wenn Sie Ereignisse erhalten, bekommen Sie diese ID zurück, sodass Sie das Ereignis ignorieren können, falls Sie Änderungen auf dem Client optimistisch anwenden möchten (was Sie wahrscheinlich tun sollten, da es die beste Erfahrung bietet). Geben Sie hier eine UUID an. Die ID sollte so eindeutig sein, dass sie in einer Browsersitzung nicht zweimal vorkommt.

import { v4 as uuidv4 } from 'uuid';

const response = await sdk.publicApi.createCommentPublic({
  createCommentParams: {
    tenantId: 'your-tenant-id',
    urlId: 'page-id',
    comment: 'My comment',
    broadcastId: uuidv4() // Eindeutige ID für diese Operation
  }
});

try {
  const comments = await sdk.publicApi.getCommentsPublic({
    tenantId: 'your-tenant-id',
    urlId: 'page-id'
  });
} catch (error) {
  if (error.response?.status === 404) {
    console.log('Page not found');
  } else {
    console.error('API Error:', error.message);
  }
}

Erstellt ein neues Testkonto für einen KI‑Agenten ohne menschliche Anmeldung. Es wird kein API‑Schlüssel benötigt, um dies aufzurufen.

Die Antwort enthält die Mandanten‑ID, einen API‑Schlüssel, der sofort gegen die REST‑API und den MCP‑Server funktioniert, sowie eine Claim‑URL. Geben Sie die Claim‑URL an die Person, für die Sie arbeiten: Wenn sie diese öffnet, während sie bei FastComments angemeldet ist, wird das Konto mit ihr verknüpft. Nicht beanspruchte Konten und deren Schlüssel werden 72 Stunden nach Erstellung gelöscht. Bis zur Beanspruchung hat das Konto die üblichen Testlimits.

Parameter

Antwort

Rückgabe: CreateAgentTenantResponse

Beispiel

createAgentTenant Beispiel

Copy

1

2const tenantBody: CreateAgentTenantBody = {

3 name: "Acme Corp",

4 domain: "acme.example.com",

5 contactEmail: "admin@acme.example.com", // optional

6 planId: 3 // optional

7};

8

9const result: CreateAgentTenantResponse = await createAgentTenant(tenantBody);

10

Aggregiert Dokumente durch Gruppierung (falls groupBy angegeben ist) und Anwendung mehrerer Operationen.
Verschiedene Operationen (z. B. sum, countDistinct, avg usw.) werden unterstützt.

Parameters

Response

Rückgabe: AggregateResponse

Beispiel

Aggregationsbeispiel

Copy

1

2const tenantId: string = "tenant-12345";

3

4const aggregationRequest: AggregationRequest = {

5 predicates: [

6 {

7 field: "status",

8 operator: "eq",

9 value: { type: "string", value: "approved" }

10 }

11 ],

12 operations: [

13 { type: "count", field: "commentId" }

14 ],

15 sort: { field: "createdAt", direction: "desc" }

16};

17

18const parentTenantId: string = "parent-001";

19const includeStats: boolean = true;

20

21const result: AggregateResponse = await aggregate(

22 tenantId,

23 aggregationRequest,

24 parentTenantId,

25 includeStats

26);

27

Parameter

Antwort

Rückgabe: GetAuditLogsResponse

Beispiel

getAuditLogs Beispiel

Copy

1

2async function fetchAuditLogs(): Promise<void> {

3 const tenantId: string = "tenant_12345";

4 const limit: number = 50;

5 const skip: number = 0;

6 const order: SORTDIR = { direction: "DESC" };

7 const after: number = Date.now() - 86400000; // vor 1 Tag

8 const before: number = Date.now();

9 const username: string = "alice.smith";

10 const ip: string = "198.51.100.23";

11 const crudType: string = "CREATE";

12 const resourceName: string = "thread";

13 const targetId: string = "thread_45678";

14 const target: string = "forum_12";

15 const includeManagedTenants: boolean = false;

16

17 const logs: GetAuditLogsResponse = await getAuditLogs(

18 tenantId,

19 limit,

20 skip,

21 order,

22 after,

23 before,

24 username,

25 ip,

26 crudType,

27 resourceName,

28 targetId,

29 target,

30 includeManagedTenants

31 );

32

33 console.log(logs);

34}

35

36fetchAuditLogs();

37

Parameter

Antwort

Rückgabe: BlockSuccess

Beispiel

blockFromCommentPublic Beispiel

Copy

1

2async function demoBlock() {

3 const tenantId: string = "tenant_9f8b7c";

4 const commentId: string = "comment_3e2d1a";

5 const blockParams: PublicBlockFromCommentParams = {

6 reason: "harassment",

7 expiresInHours: 48

8 };

9 const ssoToken: string = "sso_5g6h7i";

10

11 const resultWithSso: BlockSuccess = await blockFromCommentPublic(tenantId, commentId, blockParams, ssoToken);

12 const resultWithoutSso: BlockSuccess = await blockFromCommentPublic(tenantId, commentId, blockParams);

13}

14

Parameter

Antwort

Rückgabe: UnblockSuccess

Beispiel

unBlockCommentPublic Beispiel

Copy

1

2const tenantId: string = "c9f1e2a4-5b6d-4f8a-9c2e-123456789abc";

3const commentId: string = "d3b2c1a9-8f7e-4d6b-9a0b-987654321def";

4

5const unblockParams: PublicBlockFromCommentParams = {

6 reason: "User request resolved",

7 moderatorId: "mod-456"

8};

9

10const ssoToken: string = "sso-token-789xyz";

11

12const unblockResult: UnblockSuccess = await unBlockCommentPublic(tenantId, commentId, unblockParams, ssoToken);

13const unblockResultNoSso: UnblockSuccess = await unBlockCommentPublic(tenantId, commentId, unblockParams);

14

Parameter

Antwort

Rückgabe: CheckBlockedCommentsResponse

Beispiel

checkedCommentsForBlocked Beispiel

Copy

1

2(async () => {

3 const tenantId: string = "tenant_12345";

4 const commentIds: string = "cmt_9876,cmt_5432";

5 const ssoToken: string = "sso_user_abc123";

6

7 const responseWithSso: CheckBlockedCommentsResponse = await checkedCommentsForBlocked(tenantId, commentIds, ssoToken);

8 const responseWithoutSso: CheckBlockedCommentsResponse = await checkedCommentsForBlocked(tenantId, commentIds);

9})();

10

Parameter

Antwort

Rückgabe: BlockSuccess

Beispiel

blockUserFromComment Beispiel

Copy

1

2async function demo() {

3 const tenantId: string = "tenant-123e4567-e89b-12d3-a456-426614174000";

4 const commentId: string = "cmt-9876543210";

5 const blockParams: BlockFromCommentParams = {

6 reason: "spam",

7 durationHours: 24

8 };

9 const userId: string = "user-abc123";

10 const anonUserId: string = "anon-xyz789";

11 const result: BlockSuccess = await blockUserFromComment(tenantId, commentId, blockParams, userId, anonUserId);

12 console.log(result);

13}

14demo();

15

Parameter

Antwort

Rückgabe: SaveCommentsResponseWithPresence

Beispiel

createCommentPublic Beispiel

Copy

1

2async function runExample() {

3 const tenantId: string = "tenant-456";

4 const urlId: string = "url-789";

5 const broadcastId: string = "broadcast-101112";

6 const commentData: CommentData = { text: "This is a comment", userId: "user-123" };

7 const sessionId: string = "session-131415";

8 const sso: string = "sso-token-xyz";

9 const result: SaveCommentsResponseWithPresence = await createCommentPublic(tenantId, urlId, broadcastId, commentData, sessionId, sso);

10 const resultNoOpt: SaveCommentsResponseWithPresence = await createCommentPublic(tenantId, urlId, broadcastId, commentData);

11}

12

Parameter

Antwort

Rückgabe: DeleteCommentResult

Beispiel

deleteComment Beispiel

Copy

1

2async function removeComment(): Promise<void> {

3 const tenantId: string = "tenant_12345";

4 const commentId: string = "comment_9876";

5 const contextUserId: string = "user_42";

6 const result: DeleteCommentResult = await deleteComment(tenantId, commentId, contextUserId, true);

7 console.log(result);

8}

9removeComment();

10

Parameter

Antwort

Rückgabe: PublicAPIDeleteCommentResponse

Beispiel

deleteCommentPublic Beispiel

Copy

1

2(async () => {

3 const tenantId: string = "tenant_12345";

4 const commentId: string = "cmt_9876";

5 const broadcastId: string = "brd_5555";

6 const editKey: string = "edit_abc123";

7 const sso: string = "sso_token_xyz";

8

9 const resultWithoutOptional: PublicAPIDeleteCommentResponse = await deleteCommentPublic(tenantId, commentId, broadcastId);

10 const resultWithOptional: PublicAPIDeleteCommentResponse = await deleteCommentPublic(tenantId, commentId, broadcastId, editKey, sso);

11})();

12

Parameters

Antwort

Rückgabe: VoteDeleteResponse

Beispiel

deleteCommentVote Beispiel

Copy

1

2const tenantId: string = "tenant_12345";

3const commentId: string = "cmt_9876";

4const voteId: string = "vote_555";

5const urlId: string = "url_abcde";

6const broadcastId: string = "brd_2023";

7const editKey: string = "edit_abc123"; // optional

8const ssoToken: string = "sso_token_xyz"; // optional

9

10// Aufruf nur mit den erforderlichen Parametern und einem optionalen Parameter

11const deleteResult: VoteDeleteResponse = await deleteCommentVote(

12 tenantId,

13 commentId,

14 voteId,

15 urlId,

16 broadcastId,

17 editKey

18);

19

20// Aufruf mit beiden optionalen Parametern

21const deleteResultWithSSO: VoteDeleteResponse = await deleteCommentVote(

22 tenantId,

23 commentId,

24 voteId,

25 urlId,

26 broadcastId,

27 editKey,

28 ssoToken

29);

30

Parameter

Antwort

Rückgabe: FlagCommentResponse

Beispiel

flagComment Beispiel

Copy

1

2(async () => {

3 const tenantId: string = "acme-corp";

4 const commentId: string = "comment-20230915-001";

5 const userId: string = "user-42";

6 const anonUserId: string = "anon-abc123";

7

8 const response: FlagCommentResponse = await flagComment(tenantId, commentId, userId, anonUserId);

9 console.log(response);

10})();

11

Parameter

Antwort

Rückgabe: APIGetCommentResponse

Beispiel

getComment Beispiel

Copy

1

2async function fetchComment(): Promise<void> {

3 const tenantId: string = "acme-corp";

4 const commentId: string = "cmt_1234567890";

5

6 const response: APIGetCommentResponse = await getComment(tenantId, commentId);

7 const comment: APIComment | undefined = response.comment;

8

9 // Demonstration optionaler Felder

10 const badgeInfo: CommentUserBadgeInfo | undefined = comment?.user?.badge;

11 const hashtags: CommentUserHashTagInfo[] | undefined = comment?.user?.hashtags;

12 const mentions: CommentUserMentionInfo[] | undefined = comment?.user?.mentions;

13 const meta: APICommentBaseMeta | undefined = comment?.meta;

14

15 console.log(comment?.id, badgeInfo?.type);

16}

17

18fetchComment();

19

Parameter

Antwort

Rückgabe: APIGetCommentsResponse

Beispiel

getComments Beispiel

Copy

1

2async function loadComments(): Promise<void> {

3 const tenantId: string = "acme-corp";

4 const page: number = 1;

5 const limit: number = 50;

6 const asTree: boolean = false;

7 const direction: SortDirections = "asc";

8 const fromDate: number = Date.now() - 30 * 24 * 60 * 60 * 1000; // 30 days ago

9 const toDate: number = Date.now();

10

11 const commentsResponse: APIGetCommentsResponse = await getComments(

12 tenantId,

13 page,

14 limit,

15 undefined,

16 asTree,

17 undefined,

18 undefined,

19 undefined,

20 undefined,

21 undefined,

22 undefined,

23 undefined,

24 undefined,

25 undefined,

26 direction,

27 fromDate,

28 toDate

29 );

30

31 console.log(commentsResponse);

32}

33

req tenantId urlId

Parameter

Antwort

Rückgabe: GetCommentsResponseWithPresencePublicComment

Beispiel

getCommentsPublic Beispiel

Copy

1

2async function loadComments(): Promise<void> {

3 const tenantId: string = "tenant-42",

4 urlId: string = "post-2023-09-15",

5 page: number = 1,

6 direction: SortDirections = "desc",

7 limit: number = 30,

8 includeConfig: boolean = true,

9 locale: string = "en-US",

10 isCrawler: boolean = false,

11 asTree: boolean = true,

12 maxTreeDepth: number = 2,

13 searchText: string = "fastcomments",

14 hashTags: string[] = ["fastcomments","typescript"],

15 userId: string = "user-123";

16

17 const result: GetCommentsResponseWithPresencePublicComment = await getCommentsPublic(

18 tenantId,

19 urlId,

20 page,

21 direction,

22 undefined,

23 undefined,

24 undefined,

25 limit,

26 undefined,

27 undefined,

28 undefined,

29 includeConfig,

30 undefined,

31 undefined,

32 locale,

33 undefined,

34 isCrawler,

35 undefined,

36 asTree,

37 maxTreeDepth,

38 undefined,

39 undefined,

40 searchText,

41 hashTags,

42 userId

43 );

44}

45

Parameter

Antwort

Rückgabe: PublicAPIGetCommentTextResponse

Beispiel

getCommentText Beispiel

Copy

1

2const tenantId: string = "acme-corp-tenant";

3const commentId: string = "comment-987654321";

4const editKey: string = "edit-key-abc123";

5const sso: string = "sso-token-xyz789";

6

7const commentWithEdit: PublicAPIGetCommentTextResponse = await getCommentText(

8 tenantId,

9 commentId,

10 editKey,

11 sso

12);

13

14const commentBasic: PublicAPIGetCommentTextResponse = await getCommentText(

15 tenantId,

16 commentId

17);

18

Parameter

Antwort

Rückgabe: GetCommentVoteUserNamesSuccessResponse

Beispiel

getCommentVoteUserNames Beispiel

Copy

1

2async function example() {

3 const tenantId: string = 'tenant-9876';

4 const commentId: string = 'comment-abc123';

5 const dir: number = 1;

6 const ssoToken: string = 'sso-xyz789';

7

8 const resultWithSso: GetCommentVoteUserNamesSuccessResponse = await getCommentVoteUserNames(tenantId, commentId, dir, ssoToken);

9 const resultWithoutSso: GetCommentVoteUserNamesSuccessResponse = await getCommentVoteUserNames(tenantId, commentId, dir);

10}

11

Parameter

Antwort

Rückgabe: APIEmptyResponse

Beispiel

lockComment Beispiel

Copy

1

2async function demoLockComment() {

3 const tenantId: string = "tenant_12345";

4 const commentId: string = "cmt_9876";

5 const broadcastId: string = "brd_5555";

6 const ssoToken: string = "sso_user_abc";

7

8 const resultWithSso: APIEmptyResponse = await lockComment(tenantId, commentId, broadcastId, ssoToken);

9 const resultWithoutSso: APIEmptyResponse = await lockComment(tenantId, commentId, broadcastId);

10}

11

12demoLockComment();

13

Parameter

Antwort

Rückgabe: ChangeCommentPinStatusResponse

Beispiel

pinComment Beispiel

Copy

1

2async function demoPinComment() {

3 const tenantId: string = "tenant_12345";

4 const commentId: string = "cmt_98765";

5 const broadcastId: string = "brd_54321";

6

7 const resultWithoutSso: ChangeCommentPinStatusResponse = await pinComment(tenantId, commentId, broadcastId);

8 const ssoToken: string = "sso_abcde12345";

9 const resultWithSso: ChangeCommentPinStatusResponse = await pinComment(tenantId, commentId, broadcastId, ssoToken);

10}

11

12demoPinComment();

13

Parameter

Antwort

Rückgabe: APISaveCommentResponse

Beispiel

saveComment Beispiel

Copy

1

2const tenantId: string = "tenant_12345";

3

4const commentParams: CreateCommentParams = {

5 content: "This is a comment with a mention and a hashtag.",

6 userId: "user_987",

7 mentions: [

8 { userId: "user_123", start: 27, end: 34 }

9 ] as CommentUserMentionInfo[],

10 hashtags: [

11 { tag: "feedback", start: 45, end: 53 }

12 ] as CommentUserHashTagInfo[],

13 poll: {

14 question: "Do you like this feature?",

15 options: ["Yes", "No"]

16 } as CommentPollInput,

17};

18

19const response: APISaveCommentResponse = await saveComment(

20 tenantId,

21 commentParams,

22 true, // istLive

23 true, // Spamprüfung durchführen

24 false, // E-Mails senden

25 true // Benachrichtigungen füllen

26);

27

Parameter

Antwort

Rückgabe: Array<SaveCommentsBulkResponse

Beispiel

saveCommentsBulk Beispiel

Copy

1

2const tenantId: string = "tenant_12345";

3

4const mention1: CommentUserMentionInfo = {

5 userId: "user_002",

6 start: 10,

7 end: 20,

8};

9

10const hashtag1: CommentUserHashTagInfo = {

11 tag: "news",

12 start: 30,

13 end: 35,

14};

15

16const poll1: CommentPollInput = {

17 question: "Did you find this helpful?",

18 options: ["Yes", "No"],

19};

20

21const commentA: CreateCommentParams = {

22 content: "This is a great article!",

23 userId: "user_001",

24 mentions: [mention1],

25 hashtags: [hashtag1],

26 poll: poll1,

27};

28

29const commentB: CreateCommentParams = {

30 content: "I have a question about the topic.",

31 userId: "user_003",

32};

33

34const createCommentParams: CreateCommentParams[] = [commentA, commentB];

35

36const isLive: boolean = true;

37const doSpamCheck: boolean = false;

38const sendEmails: boolean = true;

39const populateNotifications: boolean = false;

40

41const results: SaveCommentsBulkResponse[] = await saveCommentsBulk(

42 tenantId,

43 createCommentParams,

44 isLive,

45 doSpamCheck,

46 sendEmails,

47 populateNotifications

48);

49

Parameter

Antwort

Rückgabe: PublicAPISetCommentTextResponse

Beispiel

setCommentText Beispiel

Copy

1

2(async () => {

3 const tenantId: string = "tenant_12345";

4 const commentId: string = "cmt_98765";

5 const broadcastId: string = "brd_54321";

6 const commentTextUpdateRequest: CommentTextUpdateRequest = {

7 text: "Revised comment text with additional details."

8 };

9 const editKey: string = "edit_abc123";

10 const sso: string = "sso_token_456def";

11

12 const response: PublicAPISetCommentTextResponse = await setCommentText(

13 tenantId,

14 commentId,

15 broadcastId,

16 commentTextUpdateRequest,

17 editKey,

18 sso

19 );

20})();

21

Parameter

Antwort

Rückgabe: UnblockSuccess

Beispiel

unBlockUserFromComment Beispiel

Copy

1

2(async () => {

3 const tenantId: string = "tenant-9f8b7c6d";

4 const commentId: string = "comment-4a3b2c1d";

5 const params: UnBlockFromCommentParams = {

6 reason: "User appealed the block",

7 adminNote: "Reviewed and unblocked"

8 };

9 const userId: string = "user-5e6f7g8h";

10 const anonUserId: string = "anon-1a2b3c4d";

11 const result: UnblockSuccess = await unBlockUserFromComment(

12 tenantId,

13 commentId,

14 params,

15 userId,

16 anonUserId

17 );

18 console.log(result);

19})();

20

Parameter

Antwort

Rückgabe: FlagCommentResponse

Beispiel

unFlagComment Beispiel

Copy

1

2async function runExample() {

3 const tenantId: string = "acme-corp";

4 const commentId: string = "cmt-20230915-001";

5 const userId: string = "user-42";

6

7 const unflaggedByUser: FlagCommentResponse = await unFlagComment(tenantId, commentId, userId);

8 const unflaggedByAnon: FlagCommentResponse = await unFlagComment(tenantId, commentId, undefined, "anon-xyz");

9

10 console.log(unflaggedByUser, unflaggedByAnon);

11}

12

Parameter

Antwort

Rückgabe: APIEmptyResponse

Beispiel

unLockComment Beispiel

Copy

1

2async function demoUnlock() {

3 const tenantId: string = "acme-corp";

4 const commentId: string = "cmt_1234567890";

5 const broadcastId: string = "brd_987654321";

6 const ssoToken: string = "sso_abcdef123456";

7

8 const resultWithoutSso: APIEmptyResponse = await unLockComment(tenantId, commentId, broadcastId);

9 const resultWithSso: APIEmptyResponse = await unLockComment(tenantId, commentId, broadcastId, ssoToken);

10}

11

Parameter

Antwort

Rückgabe: ChangeCommentPinStatusResponse

Beispiel

unPinComment Beispiel

Copy

1

2(async () => {

3 const tenantId: string = "acme-corp";

4 const commentId: string = "comment-20230915-001";

5 const broadcastId: string = "broadcast-2023-09-15";

6 const ssoToken: string = "sso-abc123";

7

8 const result: ChangeCommentPinStatusResponse = await unPinComment(tenantId, commentId, broadcastId, ssoToken);

9 const resultWithoutSso: ChangeCommentPinStatusResponse = await unPinComment(tenantId, commentId, broadcastId);

10})();

11

Parameter

Antwort

Rückgabe: APIEmptyResponse

Beispiel

updateComment Beispiel

Copy

1

2const tenantId: string = "c1a2b3d4-5678-90ab-cdef-1234567890ab";

3const commentId: string = "comment-9876543210";

4const updateParams: UpdatableCommentParams = {

5 content: "Edited comment content",

6 isApproved: true

7};

8

9const contextUserId: string = "user-11223344";

10const doSpamCheck: boolean = true;

11const isLive: boolean = false;

12

13const response: APIEmptyResponse = await updateComment(

14 tenantId,

15 commentId,

16 updateParams,

17 contextUserId,

18 doSpamCheck,

19 isLive

20);

21

Parameter

Antwort

Rückgabe: VoteResponse

Beispiel

voteComment Beispiel

Copy

1

2async function runVote() {

3 const tenantId: string = 'tenant_001';

4 const commentId: string = 'cmt_987654';

5 const urlId: string = 'url_12345';

6 const broadcastId: string = 'brd_56789';

7 const voteBody: VoteBodyParams = { direction: 'up' };

8 const sessionId: string = 'sess_abc123';

9 const sso: string = 'sso_token_xyz';

10 const response: VoteResponse = await voteComment(

11 tenantId,

12 commentId,

13 urlId,

14 broadcastId,

15 voteBody,

16 sessionId,

17 sso

18 );

19 console.log(response);

20}

21runVote();

22

Parameter

Antwort

Rückgabe: GetCommentsForUserResponse

Beispiel

getCommentsForUser Beispiel

Copy

1

2const userId: string = '550e8400-e29b-41d4-a716-446655440000';

3const direction: SortDirections = SortDirections.Descending;

4const page: number = 3;

5const includei10n: boolean = true;

6const locale: string = 'fr-FR';

7const isCrawler: boolean = false;

8

9const commentsResponse: GetCommentsForUserResponse = await getCommentsForUser(

10 userId,

11 direction,

12 undefined,

13 page,

14 includei10n,

15 locale,

16 isCrawler

17);

18

Parameter

Antwort

Rückgabe: AddDomainConfigResponse

Beispiel

addDomainConfig Beispiel

Copy

1

2(async () => {

3 const tenantId: string = 'tenant_12345';

4 const config: AddDomainConfigParams = {

5 domain: 'myblog.example.com',

6 enabled: true,

7 // description ist optional und hier weggelassen

8 };

9 const response: AddDomainConfigResponse = await addDomainConfig(tenantId, config);

10 console.log(response);

11})();

12

Parameter

Antwort

Rückgabe: DeleteDomainConfigResponse

Beispiel

deleteDomainConfig Beispiel

Copy

1

2async function runExample() {

3 const tenantId: string = 'acme-corp';

4 const domain: string = 'blog.acme.com';

5 const response: DeleteDomainConfigResponse = await deleteDomainConfig(tenantId, domain);

6 console.log(response);

7}

8runExample();

9

Parameter

Antwort

Rückgabe: GetDomainConfigResponse

Beispiel

getDomainConfig Beispiel

Copy

1

2async function main() {

3 const tenantId: string = "acme-corp-123";

4 const domain: string = "blog.acme.com";

5 const config: GetDomainConfigResponse = await getDomainConfig(tenantId, domain);

6 console.log(config);

7}

8main();

9

Parameter

Antwort

Returns: GetDomainConfigsResponse

Beispiel

Beispiel für getDomainConfigs

Copy

1

2async function fetchDomainConfigs(): Promise<void> {

3 const tenantId: string = "acme-corp-567";

4 const configs: GetDomainConfigsResponse = await getDomainConfigs(tenantId);

5 console.log(configs);

6}

7

Parameter

Antwort

Rückgabe: PatchDomainConfigResponse

Beispiel

patchDomainConfig Beispiel

Copy

1

2async function updateDomainConfig() {

3 const tenantId: string = "tenant_98765";

4 const domainToUpdate: string = "forum.mycompany.com";

5 const patchParams: PatchDomainConfigParams = {

6 enableComments: true,

7 moderationLevel: "strict",

8 allowAnonymous: false, // optionaler Parameter demonstriert

9 };

10 const response: PatchDomainConfigResponse = await patchDomainConfig(tenantId, domainToUpdate, patchParams);

11 console.log(response);

12}

13

14updateDomainConfig();

15

Parameter

Antwort

Rückgabe: PutDomainConfigResponse

Beispiel

putDomainConfig Beispiel

Copy

1

2async function runExample() {

3 const tenantId: string = 'tenant-9f8c7b1a';

4 const domainToUpdate: string = 'comments.mywebsite.org';

5 const updateDomainConfigParams: UpdateDomainConfigParams = {

6 enableModeration: true,

7 // optionales Feld weggelassen, z.B., maxCommentLength?: number

8 };

9 const result: PutDomainConfigResponse = await putDomainConfig(

10 tenantId,

11 domainToUpdate,

12 updateDomainConfigParams,

13 );

14 console.log(result);

15}

16runExample();

17

Parameter

Antwort

Rückgabe: CreateEmailTemplateResponse

Beispiel

createEmailTemplate Beispiel

Copy

1

2const tenantId: string = "tenant_9f8b7c6d";

3

4const templateBody: CreateEmailTemplateBody = {

5 name: "Weekly Summary",

6 subject: "Your weekly activity report",

7 // optionales Feld

8 replyTo: "no-reply@myapp.com",

9 htmlContent: "<p>Hello \{{userName}}, here is your summary...</p>"

10};

11

12const response: CreateEmailTemplateResponse = await createEmailTemplate(tenantId, templateBody);

13

14console.log(response.template.id);

15

Parameter

Antwort

Rückgabe: APIEmptyResponse

Beispiel

deleteEmailTemplate Beispiel

Copy

1

2interface APIStatus {

3 code: number;

4 message: string;

5}

6

7interface APIEmptyResponse {

8 status?: APIStatus;

9}

10

11(async () => {

12 const tenantId: string = "tenant_12345";

13 const templateId: string = "template_987";

14

15 const result: APIEmptyResponse = await deleteEmailTemplate(tenantId, templateId);

16})();

17

Parameter

Antwort

Rückgabe: APIEmptyResponse

Beispiel

deleteEmailTemplateRenderError Beispiel

Copy

1

2async function removeRenderError() {

3 const tenantId: string = "acme-corp-tenant";

4 const templateId: string = "welcome-email-template";

5 const errorId: string = "render-err-20230915";

6

7 const result: APIEmptyResponse = await deleteEmailTemplateRenderError(tenantId, templateId, errorId);

8}

9

Parameter

Antwort

Rückgabe: GetEmailTemplateResponse

Beispiel

getEmailTemplate Beispiel

Copy

1

2async function fetchTemplate() {

3 const tenantId: string = "acme-corp-123";

4 const templateId: string = "welcome-email-456";

5 const response: GetEmailTemplateResponse = await getEmailTemplate(tenantId, templateId);

6 const status: APIStatus | undefined = response.status;

7 const customTemplate: CustomEmailTemplate | undefined = response.template;

8}

9

Parameter

Antwort

Rückgabe: GetEmailTemplateDefinitionsResponse

Beispiel

getEmailTemplateDefinitions Beispiel

Copy

1

2async function fetchEmailTemplates() {

3 const tenantId: string = "acme-corp-456";

4 const result: GetEmailTemplateDefinitionsResponse = await getEmailTemplateDefinitions(tenantId);

5 const status: APIStatus = result.status;

6 const definitions: EmailTemplateDefinition[] = result.definitions ?? [];

7 console.log(`Status: ${status.code}, Templates: ${definitions.length}`);

8}

9

Parameter

Antwort

Rückgabe: GetEmailTemplateRenderErrorsResponse

Beispiel

getEmailTemplateRenderErrors Beispiel

Copy

1

2async function demo() {

3 const tenantId: string = "tenant_12345";

4 const templateId: string = "template_9876";

5

6 const resultWithSkip: GetEmailTemplateRenderErrorsResponse = await getEmailTemplateRenderErrors(tenantId, templateId, 10);

7 const resultWithoutSkip: GetEmailTemplateRenderErrorsResponse = await getEmailTemplateRenderErrors(tenantId, templateId);

8

9 console.log(resultWithSkip, resultWithoutSkip);

10}

11demo();

12

Parameter

Antwort

Rückgabe: GetEmailTemplatesResponse

Beispiel

getEmailTemplates Beispiel

Copy

1

2async function fetchEmailTemplates() {

3 const tenantId: string = "acme-corp-123";

4 const skip: number = 20;

5 const templatesWithSkip: GetEmailTemplatesResponse = await getEmailTemplates(tenantId, skip);

6 const templatesWithoutSkip: GetEmailTemplatesResponse = await getEmailTemplates(tenantId);

7}

8

Parameter

Antwort

Rückgabe: RenderEmailTemplateResponse

Beispiel

renderEmailTemplate Beispiel

Copy

1

2const tenantId: string = "c1a2b3d4-5678-90ab-cdef-1234567890ab";

3

4const templateBody: RenderEmailTemplateBody = {

5 templateId: "welcome-email",

6 variables: {

7 userName: "Jane Doe",

8 signupDate: "2024-04-01"

9 }

10};

11

12const locale: string = "en-US";

13

14(async () => {

15 const rendered: RenderEmailTemplateResponse = await renderEmailTemplate(

16 tenantId,

17 templateBody,

18 locale

19 );

20 console.log(rendered);

21})();

22

Parameter

Antwort

Rückgabe: APIEmptyResponse

Beispiel

updateEmailTemplate Beispiel

Copy

1

2async function runUpdate() {

3 const tenantId: string = "tenant_12345";

4 const templateId: string = "template_67890";

5

6 const updateBody: UpdateEmailTemplateBody = {

7 subject: "New Comment Notification",

8 // htmlContent ist optional und wurde weggelassen

9 status: { code: 200, message: "Active" } // APIStatus

10 };

11

12 const response: APIEmptyResponse = await updateEmailTemplate(tenantId, templateId, updateBody);

13 console.log(response);

14}

15

req tenantId urlId userIdWS

Parameter

Antwort

Rückgabe: GetEventLogResponse

Beispiel

getEventLog Beispiel

Copy

1

2const tenantId: string = "tenant_12345";

3const urlId: string = "url_9876";

4const userIdWS: string = "user_abcde";

5const startTime: number = Date.now() - 86_400_000; // vor 24 Stunden

6const endTime: number = Date.now();

7

8const fullLog: GetEventLogResponse = await getEventLog(tenantId, urlId, userIdWS, startTime, endTime);

9const partialLog: GetEventLogResponse = await getEventLog(tenantId, urlId, userIdWS, startTime);

10

req tenantId urlId userIdWS

Parameter

Antwort

Rückgabe: GetEventLogResponse

Beispiel

getGlobalEventLog Beispiel

Copy

1

2async function fetchEventLogs() {

3 const tenantId: string = "tenant_12345";

4 const urlId: string = "url_9876";

5 const userIdWS: string = "user_ws_abcde";

6 const startTime: number = Date.now() - 24 * 60 * 60 * 1000; // vor 24 Stunden

7 const endTime: number = Date.now();

8

9 const logWithEnd: GetEventLogResponse = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);

10 const logWithoutEnd: GetEventLogResponse = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime);

11}

12

Parameter

Antwort

Rückgabe: CreateFeedPostsResponse

Beispiel

createFeedPost Beispiel

Copy

1

2(async () => {

3 const tenantId: string = "c1a2b3d4-5678-90ab-cdef-1234567890ab";

4 const broadcastId: string = "b1c2d3e4-5678-90ab-cdef-1234567890cd";

5 const isLive: boolean = true;

6 const doSpamCheck: boolean = false;

7 const skipDupCheck: boolean = true;

8

9 const mediaAsset: FeedPostMediaItemAsset = {

10 url: "https://cdn.example.com/photos/sunrise.jpg",

11 type: "image/jpeg"

12 };

13 const mediaItem: FeedPostMediaItem = {

14 asset: mediaAsset,

15 caption: "Sunrise over the mountains"

16 };

17 const linkItem: FeedPostLink = {

18 url: "https://blog.example.com/tech-trends-2024",

19 title: "Top Tech Trends for 2024"

20 };

21 const postParams: CreateFeedPostParams = {

22 text: "Excited to share the latest tech trends!",

23 media: [mediaItem],

24 link: linkItem

25 };

26

27 const response: CreateFeedPostsResponse = await createFeedPost(

28 tenantId,

29 postParams,

30 broadcastId,

31 isLive,

32 doSpamCheck,

33 skipDupCheck

34 );

35 console.log(response);

36})();

37

Parameter

Antwort

Rückgabe: CreateFeedPostResponse

Beispiel

createFeedPostPublic Beispiel

Copy

1

2const tenantId: string = "tenant_12345";

3

4const mediaAsset: FeedPostMediaItemAsset = {

5 url: "https://cdn.example.com/image.jpg",

6 width: 800,

7 height: 600,

8 mimeType: "image/jpeg"

9};

10

11const mediaItem: FeedPostMediaItem = {

12 type: "image",

13 asset: mediaAsset,

14 caption: "Sunset over the hills"

15};

16

17const link: FeedPostLink = {

18 url: "https://example.com/blog/post",

19 title: "Exciting New Features",

20 description: "Read about our latest updates."

21};

22

23const createFeedPostParams: CreateFeedPostParams = {

24 content: "Check out our latest blog post!",

25 media: [mediaItem],

26 link: link,

27 visibility: "public"

28};

29

30const broadcastId: string = "broadcast_9876";

31const sso: string = "sso_token_abc123";

32

33const response: CreateFeedPostResponse = await createFeedPostPublic(

34 tenantId,

35 createFeedPostParams,

36 broadcastId,

37 sso

38);

39

Parameter

Antwort

Rückgabe: DeleteFeedPostPublicResponse

Beispiel

deleteFeedPostPublic Beispiel

Copy

1

2(async () => {

3 const tenantId: string = "tenant_12345";

4 const postId: string = "post_98765";

5 const broadcastId: string = "broadcast_abcde";

6 const sso: string = "sso_token_xyz";

7

8 const responseWithOpts: DeleteFeedPostPublicResponse = await deleteFeedPostPublic(

9 tenantId,

10 postId,

11 broadcastId,

12 sso

13 );

14

15 const responseWithoutOpts: DeleteFeedPostPublicResponse = await deleteFeedPostPublic(

16 tenantId,

17 postId

18 );

19})();

20