Unread
با استفاده از Unread، می‌توانید یک شمارنده‌ی پیام‌های خوانده نشده را در کنار منوی ابزارک خود نمایش دهید. این ویژگی به کاربران کمک می‌کند تا به سرعت از تعداد پیام‌های جدید یا وظایف ناتمام خود مطلع شوند.
روش استفاده
برای استفاده از Unread، ابتدا باید یک endpoint تعریف کنید که داده‌هایی با ساختار زیر را بازگرداند:
{
"unread": 5
}پارامترهای خروجی
| Field | Type | Description |
|---|---|---|
| unread | Number | تعداد پیام های خوانده نشده |
پارامترهای ورودی
داده‌های زیر از طریق کوئری پارامتر به endpoint شما ارسال می‌شوند:
| Field | Type | Description |
|---|---|---|
| user_id | String | شناسه کاربر |
| app_key | String | کلید اپلیکیشن |
| menu_key | String | کلید منو |
نمونه‌ی داده‌ی ورودی:
{
"user_id": "xxx",
"app_key": "sanje",
"menu_key": "my-performance"
}افزودن Endpoint به ابزارک
پس از آماده‌سازی endpoint، آن را به منوی ابزارک خود اضافه کنید تا شمارنده‌ی Unread به‌صورت خودکار به‌روزرسانی و نمایش داده شود.
این روش به شما امکان می‌دهد تجربه کاربری بهتری را برای کاربران فراهم کنید، زیرا آن‌ها به‌سرعت می‌توانند از پیام‌های جدید یا فعالیت‌های ناتمام خود مطلع شوند.