Notification Tray Status

Notification tray status tracks whether the signed-in user’s tray has been seen since the latest tray item occurred. Use it for tray badges, unread indicators, and “new notifications” affordances.

Status Fields

Concept	TypeScript	iOS	Android
Tray is seen	`isSeen`	`isSeen`	`isSeen()`
Last tray occurrence	`lastTrayOccurredAt`	`lastTrayOccurredAt`	`getLastOccurredAt()`
Last tray seen timestamp	`lastTraySeenAt`	`lastTraySeenAt`	`getLastSeenAt()`

The current public Flutter SDK source reviewed for this page does not expose notification tray seen-status APIs.

Parameters

Operation	Input	Required	Platforms	Description
Observe tray seen status	Signed-in user session	Yes	TypeScript, iOS, Android	The SDK returns status for the current user; no explicit user ID is passed.
Mark tray seen	Seen timestamp	Platform-dependent	TypeScript	Timestamp to store as the tray seen time.
Mark tray seen	Current tray context	Yes	iOS, Android	Marks the signed-in user’s tray seen without an explicit timestamp parameter.

Observe Tray Seen Status

Observe tray seen status when your app needs a badge or “new notifications” indicator to stay current.

import { notificationTray } from '@amityco/ts-sdk';

const unsubscribe = notificationTray.getNotificationTraySeen(
  ({ data: status, loading, error }) => {
    if (loading) return;
    if (error) {
      handleError(error);
      return;
    }

    updateUI(status);
  },
);

unsubscribe();

token = client.notificationTray
    .getNotificationTraySeen()
    .observe { object, error in
        if let error {
            handleError(error)
            return
        }

        if let status = object.snapshot {
            showSuccessMessage(status.isSeen)
        }
    }

AmityCoreClient.notificationTray()
    .getNotificationTraySeen()
    .subscribe(
        { status: AmityNotificationTraySeen -> showSuccessMessage(status.isSeen() == true) },
        { error -> handleGeneralError(error) }
    )

Mark Tray Seen

Mark the tray seen after the user actually views the notification tray.

import { notificationTray } from '@amityco/ts-sdk';

async function markNotificationTraySeen() {
  await notificationTray.markTraySeen(new Date().toISOString());
}

Task { @MainActor in
    do {
        try await client.notificationTray.markSeen()
    } catch {
        handleError(error)
    }
}

AmityCoreClient.notificationTray()
    .markTraySeen()
    .subscribe(
        { showSuccessMessage("seen") },
        { error -> handleGeneralError(error) }
    )

Notes

Mark the tray as seen when the user actually views the tray, not merely when a badge is rendered.
Keep tray-level status separate from item-level status. Marking the tray seen does not replace item-level interaction tracking in your UI.
Re-observe or refresh tray status when the app returns to the foreground if your badge must reflect cross-device activity.

Not real-time. Seen status is derived from the same server-cached tray data as notification items, so it does not update the instant a new notification is triggered. Expect a short delay before isSeen / lastTrayOccurredAt reflect a new occurrence — an unread indicator built on this status is eventually consistent, not live.

Notification Items

Query notification items and mark individual items as seen.

Notification Overview

Understand the notification tray SDK surface.

Powered by

Getting Started

Fundamentals

Social

Chat

Video

Release Notes

Migration Guides

Support

Notification Tray Status

Status Fields

Parameters

Observe Tray Seen Status

Mark Tray Seen

Notes

Notification Items

Notification Overview

​Status Fields

​Parameters

​Observe Tray Seen Status

​Mark Tray Seen

​Notes

​Related Topics

Notification Items

Notification Overview

Status Fields

Parameters

Observe Tray Seen Status

Mark Tray Seen

Notes

Related Topics