Skip to content

@ecp.eth/sdk


@ecp.eth/sdk / indexer / MarkNotificationsAsSeenOptions

Type Alias: MarkNotificationsAsSeenOptions

type MarkNotificationsAsSeenOptions = {
  apiUrl?: string;
  app?:   | Hex
     | Hex[];
  appSecretKey: string;
  lastSeenNotificationDate?: Date;
  retries?: number;
  signal?: AbortSignal;
  type?:   | IndexerAPINotificationTypeSchemaType
     | IndexerAPINotificationTypeSchemaType[];
  user: Hex | string;
};

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

Properties

apiUrl?

optional apiUrl: string;

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

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

Default

"https://api.ethcomments.xyz"

app?

optional app: 
  | Hex
  | Hex[];

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

The app signers to mark notifications as seen for


appSecretKey

appSecretKey: string;

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

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


lastSeenNotificationDate?

optional lastSeenNotificationDate: Date;

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

The date of the last seen notification, will mark as seen notifications created after this date


retries?

optional retries: number;

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

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

Default

3

signal?

optional signal: AbortSignal;

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

The signal to abort the request


type?

optional type: 
  | IndexerAPINotificationTypeSchemaType
  | IndexerAPINotificationTypeSchemaType[];

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

The types of notifications to mark as seen


user

user: Hex | string;

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

The user to mark notifications as seen for, either ETH address or ENS name