On this page

Notification Tray
Architecture Overview
Key Features
Data Models
Notification Tray Item
Notification Tray Seen State
Implementation Strategies
Quick Start Guide
Related Topics

Notification Tray

Real-time Notifications

Keep users engaged with instant notifications for posts, reactions, comments, and replies

Flexible Integration

Easy-to-use SDK methods for seamless notification tray integration

Granular Control

Fine-grained read tracking with both global and per-item seen states

Cross-platform Support

Consistent notification experience across iOS, Android, and Web platforms

Architecture Overview

Key Features

The Notification Tray SDK Feature enhances user engagement and connectivity within your application by providing comprehensive notification management capabilities.

Core Notification Types

State Management Features

Developer Benefits

Data Models

Notification Tray Item

Property	Type	Description
`notificationId`	`String`	Unique identifier of notification item
`lastSeenAt`	`Datetime`	Timestamp when the notification was last seen
`lastOccuredAt`	`Datetime`	Timestamp when the notification last occurred
`actors`	`List<AmityNotificationActors>`	Data of users that acted on this notification item
`actorCount`	`Int`	Number of users that acted on this notification item
`actionType`	`String`	Type of action that triggered this notification
`trayItemCategory`	`String`	Category for when action is either “mention” or “reply”
`targetId`	`String`	Object ID of the target
`targetType`	`String`	Type of target for this action
`referenceId`	`String`	Optional ObjectId of the reference
`referenceType`	`String`	Type of reference for this action
`parentId`	`String`	Optional ObjectId of parent
`text`	`String`	Ready to render text without any templating
`templatedText`	`String`	Ready to render text with templating for client interpretation
`isSeen`	`Boolean`	Whether this notification item has been seen
`isRecent`	`Boolean`	Whether this notification item is recent or older
`users`	`List<AmityUser>`	List of users that acted on this notification

Notification Tray Seen State

Property	Type	Description
`lastTraySeenAt`	`Datetime`	Timestamp when the tray was last seen
`lastTrayOccuredAt`	`Datetime`	Timestamp when the last tray item occurred
`isSeen`	`Boolean`	Whether the entire tray has been seen

Implementation Strategies

State Synchronization Patterns

Refresh Strategy Best Practices

Cross-device Synchronization

Understanding Sync Limitations

Local updates: Immediate when using same client
Cross-device: Requires manual refresh via getNotificationTraySeen()
No real-time events: State changes don’t broadcast automatically

Implementation Pattern

class NotificationManager {
    private let repository = AmityNotificationTrayRepository()
    
    func refreshTrayState() {
        repository.getNotificationTraySeen { [weak self] result in
            DispatchQueue.main.async {
                switch result {
                case .success(let state):
                    self?.updateBadgeState(state.isSeen)
                case .failure(let error):
                    self?.handleSyncError(error)
                }
            }
        }
    }
    
    func markTrayAsSeenAndRefresh() {
        repository.markNotificationTraySeen { [weak self] result in
            switch result {
            case .success:
                self?.refreshTrayState()
            case .failure(let error):
                self?.handleError(error)
            }
        }
    }
}

Quick Start Guide

1

Initialize Repository

Set up the notification repository in your application

import AmitySDK

class NotificationViewController: UIViewController {
    private let notificationRepository = AmityNotificationTrayRepository()
    
    override func viewDidLoad() {
        super.viewDidLoad()
        setupNotificationHandling()
    }
}

2

Check Notification State

Implement badge indicators based on tray seen status

func checkForUnseenNotifications() {
    notificationRepository.getNotificationTraySeen { [weak self] result in
        DispatchQueue.main.async {
            switch result {
            case .success(let trayData):
                self?.updateNotificationBadge(!trayData.isSeen)
            case .failure(let error):
                print("Error checking notifications: \(error)")
            }
        }
    }
}

3

Mark as Seen

Update seen status when user interacts with notifications

func markTrayAsSeen() {
    notificationRepository.markNotificationTraySeen { [weak self] result in
        switch result {
        case .success:
            self?.checkForUnseenNotifications() // Refresh state
        case .failure(let error):
            print("Error marking tray as seen: \(error)")
        }
    }
}

Query Notification Items

Learn how to retrieve and filter notification tray items

Mark Individual Items

Track seen status for specific notification items

Tray Seen Status

Understand global tray seen state management