@ecp.eth/sdk

@ecp.eth/sdk / indexer / FetchCommentRepliesOptions

type FetchCommentRepliesOptions = {
  apiUrl?: string;
  app?: Hex;
  chainId: number | number[];
  channelId?: bigint;
  commentId: Hex;
  commentType?: number;
  cursor?: Hex;
  limit?: number;
  mode?: IndexerAPICommentListModeSchemaType;
  moderationStatus?:   | IndexerAPICommentModerationStatusSchemaType
     | IndexerAPICommentModerationStatusSchemaType[];
  retries?: number;
  signal?: AbortSignal;
  sort?: IndexerAPISortSchemaType;
  viewer?: Hex;
};

Defined in: packages/sdk/src/indexer/api.ts:233

The options for fetchCommentReplies()

Properties

apiUrl?

optional apiUrl: string;

Defined in: packages/sdk/src/indexer/api.ts:251

URL on which /api/comments/$commentId/replies endpoint will be called

Default

"https://api.ethcomments.xyz"

app?

optional app: Hex;

Defined in: packages/sdk/src/indexer/api.ts:255

Filters to only comments sent using this app signer key.

chainId

chainId: number | number[];

Defined in: packages/sdk/src/indexer/api.ts:241

Filter replies by chain ID(s)

channelId?

optional channelId: bigint;

Defined in: packages/sdk/src/indexer/api.ts:295

Filter replies by channel ID

commentId

commentId: Hex;

Defined in: packages/sdk/src/indexer/api.ts:237

The ID of the comment to fetch replies for

commentType?

optional commentType: number;

Defined in: packages/sdk/src/indexer/api.ts:280

Filter replies by comment type

cursor?

optional cursor: Hex;

Defined in: packages/sdk/src/indexer/api.ts:265

The cursor to fetch comments from

limit?

optional limit: number;

Defined in: packages/sdk/src/indexer/api.ts:299

Default

50

mode?

optional mode: IndexerAPICommentListModeSchemaType;

Defined in: packages/sdk/src/indexer/api.ts:276

The mode to fetch replies in by default it returns only the first level of replies. If flat is used it will return all replies sorted by timestamp in descending order.

Default

"nested"

moderationStatus?

optional moderationStatus: 
  | IndexerAPICommentModerationStatusSchemaType
  | IndexerAPICommentModerationStatusSchemaType[];

Defined in: packages/sdk/src/indexer/api.ts:289

Filter replies by moderation status.

By default API returns only approved comments if moderation is enabled for all comments except when the viewer is provided, for viewer it returns all comments regardless of status.

If moderation is disabled, this parameter is ignored.

retries?

optional retries: number;

Defined in: packages/sdk/src/indexer/api.ts:261

Number of times to retry the signing operation in case of failure.

Default

3

signal?

optional signal: AbortSignal;

Defined in: packages/sdk/src/indexer/api.ts:300

sort?

optional sort: IndexerAPISortSchemaType;

Defined in: packages/sdk/src/indexer/api.ts:269

Default

"desc"

viewer?

optional viewer: Hex;

Defined in: packages/sdk/src/indexer/api.ts:245

The viewer's address. This is useful when the content moderation is enabled on the indexer.