/ SDKs / iOS

SDKs

Overview
- Getting started
- Send first message
- Migration guide
- Collection migration guide
- User
- Overview
- - Retrieving and updating user information
  - Retrieve the online status of a user
  - Update user profile
  - Retrieve the latest information on participants
- - Managing user metadata
  - Manage user metadata
- Channel
- Overview
- - Creating a channel
  - Create a channel
- - Managing operators
  - Register and remove operators
- - Joining and leaving a channel
  - Enter and exit an open channel
  - Join and leave a group channel
- - Retrieving channels
  - Retrieve a list of channels
  - Retrieve a channel by URL
- - Inviting users to a group channel
  - Invite users as members
  - Accept or decline an invitation
- - Categorizing channels
  - Categorize channels by custom type
- - Managing channels
  - Delete a channel
  - Hide or archive a group channel
  - Refresh all data related to a group channel
- - Moderating a channel
  - Freeze and unfreeze a channel
- - Managing channel metadata
  - Manage channel metadata
- - Managing channel metacounters
  - Manage channel metacounters
- Message
- Overview
- - Receiving messages through event delegate
  - Receive messages in an open channel
  - Receive messages in a group channel
- - Using message threading
  - Create a message thread
  - List replies in a message thread
- - Retrieving messages
  - Retrieve a list of messages
  - Retrieve a message
- - Searching messages in a group channel
  - Search messages by a keyword
- - Managing scheduled messages in group channel
  - Create a scheduled message
  - Retrieve a scheduled message
  - Update a scheduled message
  - Cancel a scheduled message
  - Send a scheduled message immediately
  - List all scheduled messages
  - Retrieve the total number of scheduled messages
- - Managing pinned messages in group channels
  - Pin a message
  - Unpin a message
  - List pinned messages
- - Listing changelogs
  - List changelogs of messages
- - Marking messages as read in a group channel
  - Mark messages as read
- - Marking messages as delivered in a group channel
  - Mark messages as delivered
- - Mentioning other users in a message
  - Mention other users in a message
- - Retrieving unread count in a group channel
  - Unread messages in a channel
  - Unread messages in all channels
  - Unread channels
  - Members who haven't received a message
  - Members who haven't read a message
  - Unread items
- - Categorizing messages
  - Categorize messages by custom type
- - Adding extra data to a message
  - Add extra data to a message
- - Translating messages
  - Auto-translate messages
  - Translate messages on-demand
  - Translation engine
- Application
- Overview
- - Authenticating a user
  - Authentication
- - Understanding rate limits
  - Rate limits
- Event delegate
- Overview
- - Managing channel delegates
  - Add or remove a channel delegate
- - Managing connection delegates
  - Add or remove a connection delegate
- - Managing user event delegates
  - Add or remove a user event delegate
- Push notifications
- Overview
- - Configuring preferences
  - Register push notification credentials
  - Push notification preferences
  - Push notification content templates
  - Push notification tester
  - Push notification translation
- - Marking push notifications as delivered
  - Mark push notifications as delivered
- Report
- Overview
- - Creating a report
  - Report a message, user, or channel
- Local caching
- Overview
- - Using group channel collection
  - Group channel collection
- - Using message collection
  - Message collection
Migrating to Sendbird
Deprecated
Error codes
Logger
Apple Privacy Manifest

Chat SDKs iOS v4

Chat SDKs iOS

Chat SDKs

iOS

Version 4

/

/

/

/

Retrieve number of unread items

You can retrieve the count of a user's unread messages, unread mentioned messages, or invitations received in group channels and Supergroup channels. You can use this action to display the number of unread items in the UI so that users may check them. This is only available in group channels and Supergroup channels.

To get the count, call the getUnreadItemCount(params:completionHandler:) method using GroupChannelUnreadItemCountParams.

List of parameters

Parameter name	Type	Description
key	UnreadItemKey	Specifies the key type to filter the channels with the corresponding type.
customTypesFilter	[String]?	Specifies the custom channel types to filter channels with the corresponding custom type.

The following table lists some of the properties in UnreadItemKey. To see the comprehensive list of all properties in UnreadItemKey, see the API reference.

Property name	Description
groupChannelInvitationCount	The number of invitations from group channels and Supergroup channels the user has received.
groupChannelUnreadMentionCount	The number of messages in group channels and Supergroup channels where the user was mentioned but the user hasn't read.
groupChannelUnreadMessageCount	The number of messages in group channels and Supergroup channels the user hasn't read.
nonSuperInvitationCount	The number of invitations from group channels the user has received.
nonSuperUnreadMentionCount	The number of messages in group channels where the user was mentioned but the user hasn't read.
nonSuperUnreadMessageCount	The number of messages in group channels the user hasn't read.
superInvitationCount	The number of invitations from Supergroup channels the user has received.
superUnreadMentionCount	The number of messages in Supergroup channels where the user was mentioned but the user hasn't read.
superUnreadMessageCount	The number of messages in Supergroup channels the user hasn't read.

Swift

let params = GroupChannelUnreadItemCountParams(
    key: [.groupChannelUnreadMessageCount, .groupChannelUnreadMentionCount],
    customTypesFilter: ["customType1", "customType2"]
)
SendbirdChat.getUnreadItemCount(
    params: params
) { count, error in
    
}

Sample app