Chat / iOS
Chat iOS v4
Chat iOS
Chat
iOS
Home
/
Chat
/
iOS
/
User
This is the new Docs for Chat SDK v4 for iOS. To see the previous Docs, click here.

Retrieve the online status of a user

You can check if a user in the Sendbird application is currently connected to the Sendbird server. For group channels only, you can check whether each member is currently connected to the server.

const queryParams: ApplicationUserListQueryParams = {
    userIdsFilter: ['Jeff'],
};
const query = sb.createApplicationUserListQuery(queryParams);

const [jeff] = await query.next();
if (jeff.connectionStatus === UserOnlineState.ONLINE) {
    // Jeff is currently online.
    // Acceptable values for User.connectionStatus are NON_AVAILABLE, ONLINE, and OFFLINE.
    // ...
}

Retrieve the online status of channel members

In a group channel, you can check the current connection status of each member. To do so, you need to first call the refresh(completionHandler:) method to update the channel with the latest information, then call members to retrieve a list of channel members.

When the members property returns a list of all members, you can call connectionStatus for each member object in the members property to check the corresponding member's current online status. Acceptable values of the connectionStatus property are offline and online.

Connection status values

ValueDescription

UserConnectionStatus.offline

The user isn't connected to Sendbird server.

UserConnectionStatus.online

The user isn't connected to Sendbird server.

Note: If your client app needs to keep track of the connection status of users in real time, we recommend that you periodically call the loadNextPage(completionHandler:) method of a ApplicationUserListQuery instance after specifying its userIdsFilter filter, perhaps in intervals of one minute or more.