Skip to main content

User overview

App users must connect to Chat to send and receive messages. A user is an app user who holds a valid access token issued by the Nexconn server and connects to Chat.

Register users

Your application server sends the app user's user ID (userId) to the Nexconn server to obtain a unique access token. For the Nexconn server, obtaining a token with userId is registering a user. Your app server must call the Server API to complete this step.

The client application must hold a valid access token to connect to Chat and use messaging services. When an app user signs in, your application server verifies the request and returns a token to the client.

Registered user limits

  • The development environment? has a maximum limit of 100 registered users.
  • In the production environment?, there is no limit on registered users after upgrading to a Starter or Pro plan.

Delete users

Deleting users refers to removing registered test users in your application's development environment through the console to control the total number of test users. This operation is not supported in production environments.

Manage test users in the console

Deactivate users

Deactivating a user permanently deletes user data from Chat. Apps can use this capability to implement account closure and meet app store or compliance requirements.

After the Nexconn server returns a successful deactivation result, all data associated with the user ID is deleted. You can query all deactivated user IDs. If needed, you can reactivate a deactivated user ID, but the user's personal data cannot be recovered.

These capabilities are only available through the Chat Server API.

User information

User information includes nicknames, avatars, group nicknames, and group avatars. By default, NEXCONN does not store or maintain your application's user information. Your application must maintain this data. If you want NEXCONN to store user profile information, enable the information hosting service.

Friend relationships

By default, Chat does not synchronize or store friend relationship data from your app. Your application server must maintain this data. If you need friend relationship management, enable the Nexconn information hosting service.

If you do not use NEXCONN friend management but need to restrict messaging between users, consider using the user whitelist service. After the service is enabled and configured, users can receive messages only from whitelisted users.

When you use Nexconn friend relationship management, non-friends can message each other by default. To restrict direct channel messages to friends only, enable Restrict direct messaging to friends in the Nexconn Console under Chat > Chat settings > Friends.

User management APIs

CategoryDescriptionClient APIServer API
Register userObtain a token using the app user's ID.Not availableRegister user
Delete userSee Delete users.Not availableNot available
Expire tokenInvalidate tokens obtained before a specific time.Not availableExpire token
Deactivate userDeactivate a user ID in Chat and delete personal data.Not availableDeactivate user
Query deactivated usersGet a list of deactivated user IDs.Not availableQuery deactivated users
Reactivate user IDReactivate a deactivated user ID in Chat.Not availableReactivate user ID
Set local user infoSet a user info provider, where the application layer provides the data.Set user info providerNot available
Set server user infoSet the username and avatar used in NEXCONN push services.Not availableUpdate server user info
Get local user infoGet user avatars, nicknames, etc. displayed in channels and friend lists.Get local user infoNot available
Get server user infoGet user registration information from NEXCONN, including creation time and the username and avatar URL used for push notifications.Not availableGet server user info
Update local user infoModify locally stored user nicknames and avatars.Refresh user infoNot available
Update server user infoModify the username and avatar used in NEXCONN push services.Not availableUpdate server user info
Block userPrevent a user from connecting to Chat and immediately disconnect the user. The user can be unblocked after a specified duration or manually. You can also query blocked user IDs and block end times.Not availableBlock user, Unblock user, Query blocked users
Check online statusCheck a user's online status.Not availableCheck online status
User blocklistAdd/remove users to/from a blocklist. Blocked users cannot message the blocker. Query blocklist info.

Chat UI does not provide standalone UI for this feature. These client APIs are from Chat SDK.
NCEngine.userModule addToBlocklistWithUserId:completion:, removeFromBlocklistWithUserId:completion:, checkBlockedWithUserId:completion:, getBlocklistWithCompletion:Add to blocklist, Remove from blocklist, Query blocklist
User whitelistWhen enabled, users can only receive messages from whitelisted users.Not availableSee User service configuration.