UserModule | NexconnChat

Module for managing user-related features including subscriptions, user profiles, and friend operations. Access via NCEngine.userModule.

example

// Get user profiles
const result = await NCEngine.userModule.getUserProfiles(['user-1', 'user-2']);

// Add a friend
await NCEngine.userModule.addFriend({ userId: 'user-123' });

Hierarchy

UserModule

Methods

getSubscribeUsersOnlineStatus

getSubscribeUsersOnlineStatus(userIds: string[]): Promise<NCResult<SubscribeUserOnlineStatus[]>>

Gets the online status of subscribed users.
example
```
const result = await NCEngine.userModule.getSubscribeUsersOnlineStatus(['user-1']);
```
Parameters
- userIds: string[]
  
  The user IDs to query
Returns Promise<NCResult<SubscribeUserOnlineStatus[]>>
A promise resolving to the online status list

subscribeEvent

subscribeEvent(params: SubscribeEventParams): Promise<NCResult<string[]>>

Subscribes to user events (e.g. online status).
example
```
const result = await NCEngine.userModule.subscribeEvent({
  subscribeType: SubscribeType.ONLINE_STATUS,
  userIds: ['user-1', 'user-2'],
  expiry: 3600,
});
```
Parameters
- params: SubscribeEventParams
  
  Subscription parameters
Returns Promise<NCResult<string[]>>
A promise resolving to the list of successfully subscribed user IDs

unsubscribeEvent

unsubscribeEvent(params: GetSubscribeEventParams): Promise<NCResult<string[]>>

Unsubscribes from user events.
example
```
await NCEngine.userModule.unsubscribeEvent({
  subscribeType: SubscribeType.ONLINE_STATUS,
  userIds: ['user-1'],
});
```
Parameters
- params: GetSubscribeEventParams
  
  Unsubscription parameters
Returns Promise<NCResult<string[]>>
A promise resolving to the list of successfully unsubscribed user IDs

getSubscribeEvent

getSubscribeEvent(params: GetSubscribeEventParams): Promise<NCResult<SubscriptionStatusInfo[]>>

Gets the current subscription event status for specified users.
example
```
const r = await NCEngine.userModule.getSubscribeEvent({
  subscribeType: SubscribeType.ONLINE_STATUS,
  userIds: ['user-1'],
});
```
Parameters
- params: GetSubscribeEventParams
  
  The subscription event query parameters
Returns Promise<NCResult<SubscriptionStatusInfo[]>>
A promise resolving to the subscription status list

createSubscribeQuery

createSubscribeQuery(params: SubscribeQueryParams): SubscribeQuery

Creates a paginated query for listing subscribed users.
example
```
const query = NCEngine.userModule.createSubscribeQuery({
  subscribeType: SubscribeType.ONLINE_STATUS,
});
const result = await query.loadNextPage();
```
Parameters
- params: SubscribeQueryParams
  
  The query parameters
Returns SubscribeQuery
A SubscribeQuery instance

updateMyUserProfile

updateMyUserProfile(profile: UserProfile): Promise<NCResult<void>>

Updates the current user's profile.
example
```
await NCEngine.userModule.updateMyUserProfile({
  name: 'Alice',
  portraitUri: 'https://example.com/avatar.png',
});
```
Parameters
- profile: UserProfile
  
  The profile fields to update
Returns Promise<NCResult<void>>
A promise resolving to the operation result

getUserProfiles

getUserProfiles(userIds: string[]): Promise<NCResult<UserProfile[]>>

Gets user profiles for the specified user IDs.
example
```
const result = await NCEngine.userModule.getUserProfiles(['user-1', 'user-2']);
if (result.isOk) {
  result.data.forEach(profile => console.log(profile.name));
}
```
Parameters
- userIds: string[]
  
  The user IDs to query
Returns Promise<NCResult<UserProfile[]>>
A promise resolving to the user profiles

getMyUserProfile

getMyUserProfile(): Promise<NCResult<UserProfile>>

Gets the current user's own profile.

example

const result = await NCEngine.userModule.getMyUserProfile();
if (result.isOk) {
  console.log('My name:', result.data.name);
}

Returns Promise<NCResult<UserProfile>>

A promise resolving to the current user's profile

updateMyUserProfileVisibility

updateMyUserProfileVisibility(visibility: UserProfileVisibility): Promise<NCResult<void>>

Updates the visibility of the current user's profile.
example
```
await NCEngine.userModule.updateMyUserProfileVisibility(UserProfileVisibility.EVERYONE);
```
Parameters
- visibility: UserProfileVisibility
  
  The profile visibility level
Returns Promise<NCResult<void>>
A promise resolving to the operation result

getMyUserProfileVisibility

getMyUserProfileVisibility(): Promise<NCResult<UserProfileVisibility>>

Gets the current user's profile visibility setting.
example
```
const r = await NCEngine.userModule.getMyUserProfileVisibility();
```
Returns Promise<NCResult<UserProfileVisibility>>
A promise resolving to the visibility level

setFriendAddPermission

setFriendAddPermission(permission: FriendAddPermission): Promise<NCResult<void>>

Sets the permission level for receiving friend requests.
example
```
await NCEngine.userModule.setFriendAddPermission(FriendAddPermission.NEED_VERIFY);
```
Parameters
- permission: FriendAddPermission
  
  The friend add permission level
Returns Promise<NCResult<void>>
A promise resolving to the operation result

getFriendAddPermission

getFriendAddPermission(): Promise<NCResult<FriendAddPermission>>

Gets the current friend add permission setting.
example
```
const r = await NCEngine.userModule.getFriendAddPermission();
```
Returns Promise<NCResult<FriendAddPermission>>
A promise resolving to the current permission level

addFriend

addFriend(params: AddFriendParams): Promise<NCResult<ProcessCode>>

Sends a friend request to a user.
example
```
await NCEngine.userModule.addFriend({ userId: 'user-123', extra: 'Hi!' });
```
Parameters
- params: AddFriendParams
  
  Friend request parameters
Returns Promise<NCResult<ProcessCode>>
A promise resolving to the process code

deleteFriends

deleteFriends(userIds: string[]): Promise<NCResult<void>>

Deletes friends by user IDs.
example
```
await NCEngine.userModule.deleteFriends(['user-123', 'user-456']);
```
Parameters
- userIds: string[]
  
  The user IDs to unfriend
Returns Promise<NCResult<void>>
A promise resolving to the operation result

acceptFriendApplication

acceptFriendApplication(userId: string): Promise<NCResult<void>>

Accepts a friend application from a user.
example
```
await NCEngine.userModule.acceptFriendApplication('applicant-id');
```
Parameters
- userId: string
  
  The applicant's user ID
Returns Promise<NCResult<void>>
A promise resolving to the operation result

refuseFriendApplication

refuseFriendApplication(userId: string): Promise<NCResult<void>>

Refuses a friend application from a user.
example
```
await NCEngine.userModule.refuseFriendApplication('applicant-id');
```
Parameters
- userId: string
  
  The applicant's user ID
Returns Promise<NCResult<void>>
A promise resolving to the operation result

setFriendInfo

setFriendInfo(params: SetFriendInfoParams): Promise<NCResult<IErrorKeys>>

Sets remark or extra profile info for a friend.
example
```
await NCEngine.userModule.setFriendInfo({
  userId: 'friend-id',
  remark: 'Work',
});
```
Parameters
- params: SetFriendInfoParams
  
  The friend info parameters
Returns Promise<NCResult<IErrorKeys>>
A promise resolving to error keys if any fields failed

checkFriends

checkFriends(userIds: string[]): Promise<NCResult<IFriendRelationInfo[]>>

Checks the friendship status with the specified users.
example
```
const r = await NCEngine.userModule.checkFriends(['user-1', 'user-2']);
```
Parameters
- userIds: string[]
  
  The user IDs to check
Returns Promise<NCResult<IFriendRelationInfo[]>>
A promise resolving to the friend relation info

createFriendsQuery

createFriendsQuery(params: FriendsQueryParams): FriendsQuery

Creates a paginated query for listing friends.
example
```
const query = NCEngine.userModule.createFriendsQuery({ pageSize: 20 });
const result = await query.loadNextPage();
```
Parameters
- params: FriendsQueryParams
  
  Query parameters
Returns FriendsQuery
A FriendsQuery instance

createFriendApplicationsQuery

createFriendApplicationsQuery(params: FriendApplicationsQueryParams): FriendApplicationsQuery

Creates a paginated query for listing friend applications.
example
```
const query = NCEngine.userModule.createFriendApplicationsQuery({ pageSize: 20 });
const result = await query.loadNextPage();
```
Parameters
- params: FriendApplicationsQueryParams
  
  Query parameters
Returns FriendApplicationsQuery
A FriendApplicationsQuery instance

getFriendsInfo

getFriendsInfo(userIds: string[]): Promise<NCResult<FriendInfo[]>>

Gets detailed friend information for the specified user IDs.
example
```
const result = await NCEngine.userModule.getFriendsInfo(['user-1', 'user-2']);
if (result.isOk) {
  result.data.forEach(info => console.log(info.remark));
}
```
Parameters
- userIds: string[]
  
  The friend user IDs to query
Returns Promise<NCResult<FriendInfo[]>>
A promise resolving to the friend info list

Hierarchy

Index

Methods

Methods

getSubscribeUsersOnlineStatus

Parameters

userIds: string[]

Returns Promise<NCResult<SubscribeUserOnlineStatus[]>>

subscribeEvent

Parameters

params: SubscribeEventParams

Returns Promise<NCResult<string[]>>

unsubscribeEvent

Parameters

params: GetSubscribeEventParams

Returns Promise<NCResult<string[]>>

getSubscribeEvent

Parameters

params: GetSubscribeEventParams

Returns Promise<NCResult<SubscriptionStatusInfo[]>>

createSubscribeQuery

Parameters

params: SubscribeQueryParams

Returns SubscribeQuery

updateMyUserProfile

Parameters

profile: UserProfile

Returns Promise<NCResult<void>>

getUserProfiles

Parameters

userIds: string[]

Returns Promise<NCResult<UserProfile[]>>

getMyUserProfile

Returns Promise<NCResult<UserProfile>>

updateMyUserProfileVisibility

Parameters

visibility: UserProfileVisibility

Returns Promise<NCResult<void>>

getMyUserProfileVisibility

Returns Promise<NCResult<UserProfileVisibility>>

setFriendAddPermission

Parameters

permission: FriendAddPermission

Returns Promise<NCResult<void>>

getFriendAddPermission

Returns Promise<NCResult<FriendAddPermission>>

addFriend

Parameters

params: AddFriendParams

Returns Promise<NCResult<ProcessCode>>

deleteFriends

Parameters

userIds: string[]

Returns Promise<NCResult<void>>

acceptFriendApplication

Parameters

userId: string

Returns Promise<NCResult<void>>

refuseFriendApplication

Parameters

userId: string

Returns Promise<NCResult<void>>

setFriendInfo

Parameters

params: SetFriendInfoParams

Returns Promise<NCResult<IErrorKeys>>

checkFriends

Parameters

userIds: string[]

Returns Promise<NCResult<IFriendRelationInfo[]>>

createFriendsQuery

Parameters

params: FriendsQueryParams

Returns FriendsQuery

createFriendApplicationsQuery

Parameters

params: FriendApplicationsQueryParams

Returns FriendApplicationsQuery

getFriendsInfo

Parameters