/ 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

/

/

/

/

Add or remove a connection delegate

To detect changes in the connection status of a client app, register a connection delegate ConnectionDelegate with its unique user-defined ID.

If you want to stay informed of changes related to the Sendbird server connection status and notify the changes to different client apps, define and register multiple connection delegates to each view controller.

Connection event types

List of connection events

Method	Invoked when	Notified devices
didConnect(userId:)	The SDK has connected with the given `userId`.	The device that was connected to the server.
didDisconnect(userId:)	The SDK has disconnected for the `userId`.	The device that was disconnected from the server.
didStartReconnection	The SDK has started reconnecting to the Sendbird server.	The device where `connect(userId:authToken:completionHandler:)` was automatically called by the Chat SDK or manually by the client app.
didSucceedReconnection	The SDK has succeeded in reconnecting to the Sendbird server.	The device that successfully reconnected to the server.
didFailReconnection	The SDK has failed to reconnect to the Sendbird server.	The device that failed to reconnect to the server.

Add a connection delegate

The following code shows a full set of supported event callbacks and how to add a connection delegate to the unique SendbirdChat instance.

Swift

// CustomViewController.swift
class CustomViewController: UIViewController, ConnectionDelegate {
    func initViewController() {
        SendbirdChat.add(self as ConnectionDelegate, identifier: UNIQUE_DELEGATE_ID)
    }

    func didStartReconnection() { }

    func didSucceedReconnection() { }

    func didFailReconnection() { }

    func didConnect(userId: String) { }

    func didDisconnect(userId: String) { }
}

Remove a connection delegate

The following code shows how to remove the connection delegate.

Swift

SendbirdChat.removeConnectionDelegate(forIdentifier: UNIQUE_DELEGATE_ID)

On this page

Connection event types Add a connection delegate Remove a connection delegate

Sample app