FastComments JavaScript/TypeScript SDK

為您的程式編寫代理提供 FastComments 所需的上下文——小工具、設定、Secure SSO、REST API 與 SDK：

npx skills add fastcomments/skills

可與 Claude Code、Codex、Cursor、Copilot、Gemini 以及所有其他由 skills CLI 支援的代理一起使用。

npm install fastcomments-sdk

完整的 API 參考： docs/api/README.md

此 SDK 使用 雙入口點 以確保最佳相容性並避免執行時錯誤：

• fastcomments-sdk/browser - 瀏覽器安全的版本，使用原生 fetch
• fastcomments-sdk/server - 完整的 Node.js 版本，支援 SSO
• fastcomments-sdk (default) - 僅型別，能安全在任何地方匯入

該 SDK 提供以下 API 類別：

• DefaultApi - 需要您的 API 金鑰用於驗證的受保護端點。用於伺服器端作業。
• PublicApi - 可在未提供 API 金鑰下存取的公開端點。可直接從瀏覽器/行動裝置/等呼叫。
• ModerationApi - 管理員儀表板端點（留言審核、封鎖、徽章、信任指數、搜尋）。透過管理員的會話進行驗證；對於以 SSO 驗證的管理員，傳入 sso 查詢參數。
• HiddenApi - 用於進階使用情境的內部/管理端點。

範例：使用 Public API（適用於瀏覽器）

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

const publicApi = new PublicApi();

// 取得頁面的留言（不需要 API 金鑰）
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

範例：使用 Default API（僅限伺服器端）

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

const config = new Configuration({
  apiKey: 'your-api-key' // 請務必保密！
});
const defaultApi = new DefaultApi(config);

// 以完整管理員權限取得留言
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

範例：使用 Moderation API

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

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

// 管理員已驗證的呼叫（使用 session cookie，或為 SSO 管理員傳入 `sso`）。
const comments = await sdk.moderationApi.getApiComments({
  tenantId: 'your-tenant-id'
});

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

FastComments 支援 SSO 以整合您現有的使用者認證系統。 SSO 功能僅在伺服器端匯出時可用，因為它需要 Node.js 的 crypto 功能。

Simple SSO (Server-Side Only)

簡易 SSO 應在伺服器端產生並傳送給客戶端：

// 伺服器端程式碼（Node.js/backend）
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// 使用內建輔助函式建立簡易 SSO  
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();

// 將 ssoToken 傳送到你的客戶端程式碼
// 客戶端程式碼之後可以使用此 token 與瀏覽器 SDK

Secure SSO (Server-Side, Recommended)

安全 SSO 應在伺服器端實作，並提供較佳的安全性：

// 伺服器端程式碼（Node.js/backend）
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// 使用內建輔助函式建立安全 SSO
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();

// 用於伺服器上的 API 呼叫
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: JSON.stringify(ssoConfig)
});

// 或將 ssoConfig 傳送給客戶端供瀏覽器使用

Using SSO from Browser (with Server-Generated Token)

// 客戶端程式碼（瀏覽器）
import { PublicApi } from 'fastcomments-sdk/browser';

// 從你的伺服器端點取得 SSO token
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 // 使用伺服器產生的 SSO token
});

SSO with Comment Creation

// 伺服器端：建立 SSO 與留言
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)
});

取得頁面留言

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

建立留言

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

對留言投票

const voteResponse = await sdk.publicApi.voteComment({
  voteBodyParams: {
    commentId: 'comment-id',
    direction: 1 // 1 表示讚，-1 表示踩
  }
});

使用者管理（需要 API 金鑰）

// 搜尋使用者（需要 DefaultApi）
const users = await sdk.defaultApi.searchUsers({
  tenantId: 'your-tenant-id',
  urlId: 'page-id',
  usernameStartsWith: 'john'
});

訂閱即時事件以獲取有關留言、點讚和其他活動的即時更新。

頁面層級事件

監聽特定頁面的即時事件（留言、點讚等）：

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

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

// 訂閱該頁面的即時事件
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS（租戶 ID）
  'page-url-id',    // urlIdWS（頁面 URL ID）  
  'user-session-id', // userIdWS（從 getComments 回應取得）
  (event: LiveEvent) => {
    console.log('Live event received:', event);
    
    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // 使用新留言更新您的介面
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // 在介面中更新票數
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }
    
    return true; // 若事件已處理則回傳 true
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// 完成後關閉訂閱
subscription.close();

訂閱使用者事件

監聽與特定使用者相關的事件（通知、提及等）：

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

const userConfig = {
  userIdWS: 'user-session-id', // 從 getComments 回應取得
};

// 訂閱使用者的個人資訊流
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);
    
    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // 在您的介面中顯示通知
        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');
  }
);

// 完成後關閉
userSubscription.close();

取得 userIdWS

參數 userIdWS 為即時事件所需，可從 API 回應中取得：

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

// 從回應中擷取 userIdWS
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // 現在您可以訂閱即時事件
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

你會看到在某些 API 呼叫中應該傳入 broadcastId。當你接收事件時，你會得到這個 ID 回傳，因此如果你打算在客戶端採取樂觀更新（你很可能會想這麼做，因為它提供最佳體驗），你就會知道要忽略該事件。請在此傳入 UUID。該 ID 應該足夠唯一，以免在瀏覽器會話中出現兩次。

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() // 此操作的唯一識別碼
  }
});

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

Creates a new trial account for an AI agent without a human signup. No API key is needed to call this.

為 AI 代理建立一個新的試用帳戶，無需人工註冊。呼叫此功能不需要 API 金鑰。

The response contains the tenant id, an API key that works immediately against the REST API and the MCP server, and a claim URL. Give the claim URL to the human you are working for: opening it while logged in to FastComments attaches the account to them. Unclaimed accounts, and their keys, are deleted 72 hours after creation. Until claimed, the account has the standard trial limits.

回應中包含租戶 ID、可立即用於 REST API 與 MCP 伺服器的 API 金鑰，以及領取 URL。將領取 URL 提供給您所協助的人員：在登入 FastComments 後開啟該 URL，即可將帳戶與其關聯。未領取的帳戶及其金鑰會在建立後 72 小時內被刪除。未領取前，帳戶仍具備標準的試用限制。

Parameters

Response

Returns: CreateAgentTenantResponse

Example

createAgentTenant 範例

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

聚合文件，透過分組（如果提供 groupBy）並套用多項操作。支援不同的操作（例如 sum、countDistinct、avg 等）。

參數

回應

返回：AggregateResponse

範例

聚合 示例

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

參數

回應

返回：GetAuditLogsResponse

範例

getAuditLogs 範例

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; // 1 天前

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

參數

回應

返回：BlockSuccess

範例

blockFromCommentPublic 範例

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

參數

回應

回傳：UnblockSuccess

範例

unBlockCommentPublic 範例

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

參數

回應

返回: CheckBlockedCommentsResponse

範例

checkedCommentsForBlocked 範例

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

參數

回應

返回: BlockSuccess

範例

blockUserFromComment 範例

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

參數

回應

Returns: SaveCommentsResponseWithPresence

範例

createCommentPublic 範例

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

參數

回應

Returns: DeleteCommentResult

範例

deleteComment 範例

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

參數

回應

返回: PublicAPIDeleteCommentResponse

範例

deleteCommentPublic 範例

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

參數

回應

Returns: VoteDeleteResponse

範例

deleteCommentVote 範例

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"; // 可選

8const ssoToken: string = "sso_token_xyz"; // 可選

9

10// 僅使用必要參數與一個可選參數 呼叫

11const deleteResult: VoteDeleteResponse = await deleteCommentVote(

12 tenantId,

13 commentId,

14 voteId,

15 urlId,

16 broadcastId,

17 editKey

18);

19

20// 同時使用兩個可選參數 呼叫

21const deleteResultWithSSO: VoteDeleteResponse = await deleteCommentVote(

22 tenantId,

23 commentId,

24 voteId,

25 urlId,

26 broadcastId,

27 editKey,

28 ssoToken

29);

30

參數

回應

返回：FlagCommentResponse

範例

flagComment 範例

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

參數

回應

返回：APIGetCommentResponse

範例

取得評論 範例

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 // 可選欄位示範

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

參數

回應

返回：APIGetCommentsResponse

範例

getComments 範例

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

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

參數

回應

返回：GetCommentsResponseWithPresencePublicComment

範例

getCommentsPublic 範例

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

參數

回應

返回：PublicAPIGetCommentTextResponse

範例

getCommentText 範例

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

參數

回應

返回: GetCommentVoteUserNamesSuccessResponse

範例

getCommentVoteUserNames 範例

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

Parameters

Response

返回：APIEmptyResponse

範例

lockComment 範例

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

參數

回應

返回：ChangeCommentPinStatusResponse

範例

pinComment 範例

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

參數

回應

Returns: APISaveCommentResponse

範例

saveComment 範例

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, // isLive

23 true, // doSpamCheck

24 false, // sendEmails

25 true // populateNotifications

26);

27

參數

回應

返回： Array<SaveCommentsBulkResponse

範例

saveCommentsBulk 範例

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

參數

回應

返回：PublicAPISetCommentTextResponse

範例

setCommentText 範例

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

參數

回應

回傳: UnblockSuccess

範例

unBlockUserFromComment 範例

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

參數

回應

返回：FlagCommentResponse

範例

unFlagComment 範例

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

參數

回應

返回：APIEmptyResponse

範例

unLockComment 範例

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

參數

回應

返回：ChangeCommentPinStatusResponse

範例

unPinComment 範例

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

參數

回應

返回: APIEmptyResponse

範例

updateComment 範例

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

參數

回應

返回：VoteResponse

範例

voteComment 範例

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

參數

回應

返回：GetCommentsForUserResponse

範例

getCommentsForUser 範例

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

參數

回應

返回：AddDomainConfigResponse

範例

addDomainConfig 範例

Copy

1

2(async () => {

3 const tenantId: string = 'tenant_12345';

4 const config: AddDomainConfigParams = {

5 domain: 'myblog.example.com',

6 enabled: true,

7 // description 是可選的，此處省略

8 };

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

10 console.log(response);

11})();

12

參數

回應

返回：DeleteDomainConfigResponse

範例

deleteDomainConfig 範例

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

參數

回應

返回：GetDomainConfigResponse

範例

getDomainConfig 範例

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

參數

回應

返回: GetDomainConfigsResponse

範例

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

參數

回應

Returns: PatchDomainConfigResponse

範例

patchDomainConfig 範例

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, // 示範可選參數

9 };

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

11 console.log(response);

12}

13

14updateDomainConfig();

15

參數

回應

返回: PutDomainConfigResponse

範例

putDomainConfig 範例

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 // 可選欄位已省略，例如 maxCommentLength?: number

8 };

9 const result: PutDomainConfigResponse = await putDomainConfig(

10 tenantId,

11 domainToUpdate,

12 updateDomainConfigParams,

13 );

14 console.log(result);

15}

16runExample();

17

參數

回應

Returns: CreateEmailTemplateResponse

範例

createEmailTemplate 範例

Copy

1

2const tenantId: string = "tenant_9f8b7c6d";

3

4const templateBody: CreateEmailTemplateBody = {

5 name: "Weekly Summary",

6 subject: "Your weekly activity report",

7 // 可選欄位

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

參數

回應

返回：APIEmptyResponse

範例

deleteEmailTemplate 範例

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

參數

回應

返回：APIEmptyResponse

範例

deleteEmailTemplateRenderError 範例

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

參數

回應

Returns: GetEmailTemplateResponse

範例

getEmailTemplate 範例

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

參數

回應

返回：GetEmailTemplateDefinitionsResponse

範例

getEmailTemplateDefinitions 範例

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

參數

回應

返回：GetEmailTemplateRenderErrorsResponse

範例

getEmailTemplateRenderErrors 範例

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

參數

回應

返回：GetEmailTemplatesResponse

範例

getEmailTemplates 範例

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

參數

回應

返回：RenderEmailTemplateResponse

範例

renderEmailTemplate 範例

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

參數

回應

返回：APIEmptyResponse

範例

updateEmailTemplate 範例

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 是可選的，已省略

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

參數

回應

Returns: GetEventLogResponse

範例

getEventLog 範例

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; // 24 小時前

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

參數

回應

返回：GetEventLogResponse

範例

getGlobalEventLog 範例

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; // 24 小時前

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

參數

回應

返回: CreateFeedPostsResponse

範例

createFeedPost 範例

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

參數

回應

返回：CreateFeedPostResponse

範例

createFeedPostPublic 範例

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

參數

回應

Returns: DeleteFeedPostPublicResponse

範例

deleteFeedPostPublic 範例

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