@ecp.eth/sdk

@ecp.eth/sdk / indexer / FetchGroupedNotificationsOptions

type FetchGroupedNotificationsOptions = {
  after?: string;
  apiUrl?: string;
  app?:   | Hex
     | Hex[];
  appSecretKey: string;
  before?: string;
  limit?: number;
  retries?: number;
  seen?: boolean;
  signal?: AbortSignal;
  type?:   | IndexerAPINotificationTypeSchemaType
     | IndexerAPINotificationTypeSchemaType[];
  user: Hex | string;
};

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

The options for fetchGroupedNotifications()

Properties

after?

optional after: string;

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

After cursor to fetch grouped notifications from (older grouped notifications)

apiUrl?

optional apiUrl: string;

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

URL on which /api/notifications/grouped endpoint will be called

Default

"https://api.ethcomments.xyz"

app?

optional app: 
  | Hex
  | Hex[];

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

The app signers to fetch grouped notifications for

appSecretKey

appSecretKey: string;

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

App secret key to authenticate the request. Can be found in the https://dashboard.ethcomments.xyz after creating an app.

before?

optional before: string;

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

Before cursor to fetch grouped notifications from (newer grouped notifications)

limit?

optional limit: number;

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

The number of grouped notifications to fetch

Default

10

retries?

optional retries: number;

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

Number of times to retry the request in case of failure (non‑parsing/network errors).

Default

3

seen?

optional seen: boolean;

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

Whether to fetch only seen or unseen notifications

Default

undefined - fetches all grouped notifications

signal?

optional signal: AbortSignal;

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

The signal to abort the request

type?

optional type: 
  | IndexerAPINotificationTypeSchemaType
  | IndexerAPINotificationTypeSchemaType[];

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

The types of grouped notifications to fetch

user

user: Hex | string;

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

The user to fetch grouped notifications for, either ETH address or ENS name