@ecp.eth/sdk / indexer / FetchCommentRepliesOptions
Type Alias: FetchCommentRepliesOptions
type FetchCommentRepliesOptions = {
apiUrl?: string;
app?: Hex;
chainId: number | number[];
channelId?: bigint;
commentId: Hex;
commentType?: number;
cursor?: Hex;
excludeByModerationLabels?: IndexerAPIModerationClassificationLabelSchemaType[];
limit?: number;
mode?: IndexerAPICommentListModeSchemaType;
moderationScore?: number;
moderationStatus?: | IndexerAPICommentModerationStatusSchemaType
| IndexerAPICommentModerationStatusSchemaType[];
retries?: number;
signal?: AbortSignal;
sort?: IndexerAPISortSchemaType;
viewer?: Hex;
};
Defined in: packages/sdk/src/indexer/api.ts:377
The options for fetchCommentReplies()
Properties
apiUrl?
optional apiUrl: string;
Defined in: packages/sdk/src/indexer/api.ts:395
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:399
Filters to only comments sent using this app signer key.
chainId
chainId: number | number[];
Defined in: packages/sdk/src/indexer/api.ts:385
Filter replies by chain ID(s)
channelId?
optional channelId: bigint;
Defined in: packages/sdk/src/indexer/api.ts:455
Filter replies by channel ID
commentId
commentId: Hex;
Defined in: packages/sdk/src/indexer/api.ts:381
The ID of the comment to fetch replies for
commentType?
optional commentType: number;
Defined in: packages/sdk/src/indexer/api.ts:424
Filter replies by comment type
cursor?
optional cursor: Hex;
Defined in: packages/sdk/src/indexer/api.ts:409
The cursor to fetch comments from
excludeByModerationLabels?
optional excludeByModerationLabels: IndexerAPIModerationClassificationLabelSchemaType[];
Defined in: packages/sdk/src/indexer/api.ts:451
Filter replies by moderation labels.
Only comments with moderation labels not included in the provided array are returned. This can be used to bypass premoderation, make sure to pass all moderation statuses to moderationStatus parameter if the premoderation is enabled.
limit?
optional limit: number;
Defined in: packages/sdk/src/indexer/api.ts:459
Default
50
mode?
optional mode: IndexerAPICommentListModeSchemaType;
Defined in: packages/sdk/src/indexer/api.ts:420
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"
moderationScore?
optional moderationScore: number;
Defined in: packages/sdk/src/indexer/api.ts:443
Filter replies by moderation score.
Only comments with moderation score lower or equal to the provided value are returned. This can be used to bypass premoderation, make sure to pass all moderation statuses to moderationStatus parameter if the premoderation is enabled.
moderationStatus?
optional moderationStatus:
| IndexerAPICommentModerationStatusSchemaType
| IndexerAPICommentModerationStatusSchemaType[];
Defined in: packages/sdk/src/indexer/api.ts:433
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:405
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:460
sort?
optional sort: IndexerAPISortSchemaType;
Defined in: packages/sdk/src/indexer/api.ts:413
Default
"desc"
viewer?
optional viewer: Hex;
Defined in: packages/sdk/src/indexer/api.ts:389
The viewer's address. This is useful when the content moderation is enabled on the indexer.