NCEngine | NexconnChat

The main entry point for the NexConn Chat SDK. Provides static methods for initialization, connection, handler registration, and access to functional modules.

example

// Initialize
NCEngine.initialize({ appKey: 'your-app-key' });

// Connect
const result = await NCEngine.connect({ token: 'user-token' });
if (result.isOk) {
  console.log('Connected as:', result.data.userId);
}

// Add handlers
NCEngine.addMessageHandler('main', new MessageHandler({
  onMessageReceived({ messages }) {
    console.log('New messages:', messages.length);
  },
}));

Hierarchy

NCEngine

Properties

Static Readonly userModule

userModule: UserModule = ...

User-related operations module (subscriptions, profiles, friends)

Static Readonly translateModule

translateModule: TranslateModule = ...

Translation operations module

Static initialize

initialize: ((params: InitParams) => void) = init

Type declaration

- (params: InitParams): void
- Initializes the NexConn Chat SDK. Must be called before any other operations.
  example
  NCEngine.initialize({ appKey: 'your-app-key', logLevel: LogLevel.WARN, areaCode: AreaCode.SINGAPORE, });
  Parameters
  - params: InitParams
    
    Initialization parameters
  Returns void

Methods

Static connect

connect(params: ConnectParams): Promise<NCResult<ConnectResult>>

Connects to the NexConn server with the provided token.
example
```
const result = await NCEngine.connect({ token: 'user-token' });
if (result.isOk) {
  console.log('Connected as:', result.data.userId);
}
```
Parameters
- params: ConnectParams
  
  Connection parameters including user token
Returns Promise<NCResult<ConnectResult>>
A promise resolving to the connection result containing the user ID

Static getNoDisturbTime

getNoDisturbTime(): Promise<NCResult<NoDisturbTimeInfo>>

Returns the current do-not-disturb quiet hours configuration, if any.

example

const result = await NCEngine.getNoDisturbTime();
if (result.isOk) {
  console.log(result.data.startTime, result.data.spanMinutes);
}

Returns Promise<NCResult<NoDisturbTimeInfo>>

Static removeNoDisturbTime

removeNoDisturbTime(): Promise<NCResult<void>>

Clears the do-not-disturb quiet hours configuration.
example
```
await NCEngine.removeNoDisturbTime();
```
Returns Promise<NCResult<void>>

Static disconnect

disconnect(disablePush?: boolean): Promise<void>

Disconnects from the NexConn server.
example
```
await NCEngine.disconnect();
```
Parameters
- Optional disablePush: boolean
  
  If true, disables push notifications after disconnecting
Returns Promise<void>
A promise that resolves when disconnected

Static getCurrentUserId

getCurrentUserId(): string

Gets the current connected user's ID.
example
```
const userId = NCEngine.getCurrentUserId();
```
Returns string
The user ID, or an empty string if not connected

Static addConnectionStatusHandler

addConnectionStatusHandler(identifier: string, handler: ConnectionStatusHandler): void

Registers a connection status handler.
example
```
NCEngine.addConnectionStatusHandler('main', new ConnectionStatusHandler({
  onConnectionStateChanged({ status }) {
    console.log('Connection status:', status);
  },
}));
```
Parameters
- identifier: string
  
  A unique identifier for this handler
- handler: ConnectionStatusHandler
  
  The connection status handler instance
Returns void

Static removeConnectionStatusHandler

removeConnectionStatusHandler(identifier: string): void

Removes a previously registered connection status handler.

Parameters
- identifier: string
  
  The unique identifier of the handler to remove
Returns void

Static getConnectionStatus

getConnectionStatus(): ConnectionStatus

Gets the current connection status.

Returns ConnectionStatus
The current connection status

Static setNoDisturbTime

setNoDisturbTime(params: NoDisturbTimeInfo): Promise<NCResult<void>>

Sets the do-not-disturb quiet hours period.
example
```
await NCEngine.setNoDisturbTime({
  startTime: '22:00:00',
  spanMinutes: 480,
  level: NoDisturbTimeLevel.MUTED,
});
```
Parameters
- params: NoDisturbTimeInfo
  
  The quiet hours configuration
Returns Promise<NCResult<void>>
A promise resolving to the operation result

Static addChannelHandler

addChannelHandler(identifier: string, handler: ChannelHandler): void

Registers a channel event handler.

Parameters
- identifier: string
  
  A unique identifier for this handler
- handler: ChannelHandler
  
  The channel handler instance
Returns void

Static removeChannelHandler

removeChannelHandler(identifier: string): void

Removes a previously registered channel event handler.

Parameters
- identifier: string
  
  The unique identifier of the handler to remove
Returns void

Static addMessageHandler

addMessageHandler(identifier: string, handler: MessageHandler): void

Registers a message event handler.

Parameters
- identifier: string
  
  A unique identifier for this handler
- handler: MessageHandler
  
  The message handler instance
Returns void

Static removeMessageHandler

removeMessageHandler(identifier: string): void

Removes a previously registered message event handler.

Parameters
- identifier: string
  
  The unique identifier of the handler to remove
Returns void

Static addUserHandler

addUserHandler(identifier: string, handler: UserHandler): void

Registers a user event handler.

Parameters
- identifier: string
  
  A unique identifier for this handler
- handler: UserHandler
  
  The user handler instance
Returns void

Static removeUserHandler

removeUserHandler(identifier: string): void

Removes a previously registered user event handler.

Parameters
- identifier: string
  
  The unique identifier of the handler to remove
Returns void

Static addUserSettingsHandler

addUserSettingsHandler(identifier: string, handler: UserSettingsHandler): void

Registers a user settings sync handler.

Parameters
- identifier: string
  
  A unique identifier for this handler
- handler: UserSettingsHandler
  
  The user settings handler instance
Returns void

Static removeUserSettingsHandler

removeUserSettingsHandler(identifier: string): void

Removes a previously registered user settings sync handler.

Parameters
- identifier: string
  
  The unique identifier of the handler to remove
Returns void

Static addTranslateHandler

addTranslateHandler(identifier: string, handler: TranslateHandler): void

Registers a translation event handler.

Parameters
- identifier: string
  
  A unique identifier for this handler
- handler: TranslateHandler
  
  The translate handler instance
Returns void

Static removeTranslateHandler

removeTranslateHandler(identifier: string): void

Removes a previously registered translation event handler.

Parameters
- identifier: string
  
  The unique identifier of the handler to remove
Returns void

Static addOpenChannelHandler

addOpenChannelHandler(identifier: string, handler: OpenChannelHandler): void

Registers an open channel event handler.

Parameters
- identifier: string
  
  A unique identifier for this handler
- handler: OpenChannelHandler
  
  The open channel handler instance
Returns void

Static removeOpenChannelHandler

removeOpenChannelHandler(identifier: string): void

Removes a previously registered open channel event handler.

Parameters
- identifier: string
  
  The unique identifier of the handler to remove
Returns void

Static addTagHandler

addTagHandler(identifier: string, handler: TagHandler): void

Registers a tag event handler.

Parameters
- identifier: string
  
  A unique identifier for this handler
- handler: TagHandler
  
  The tag handler instance
Returns void

Static addGroupChannelHandler

addGroupChannelHandler(identifier: string, handler: GroupChannelHandler): void

Registers a group channel event handler (group operations, applications, membership).
example
```
NCEngine.addGroupChannelHandler('main', new GroupChannelHandler({
  onGroupOperation(event) {
    console.log('Group operation:', event);
  },
}));
```
Parameters
- identifier: string
  
  A unique identifier for this handler
- handler: GroupChannelHandler
  
  The group channel handler instance
Returns void

Static removeGroupChannelHandler

removeGroupChannelHandler(identifier: string): void

Removes a previously registered group channel event handler.
example
```
NCEngine.removeGroupChannelHandler('main');
```
Parameters
- identifier: string
  
  The unique identifier of the handler to remove
Returns void

Static removeTagHandler

removeTagHandler(identifier: string): void

Removes a previously registered tag event handler.

Parameters
- identifier: string
  
  The unique identifier of the handler to remove
Returns void

Static registerCustomMessages

registerCustomMessages(params: CustomMessageRegistration[]): void

Registers custom message types with the SDK. Must be called after initialization and before receiving messages of these types.
example
```
NCEngine.registerCustomMessages([
  { messageType: 'app:custom', isPersisted: true, isCounted: true },
  { messageType: 'app:card', isPersisted: true, isCounted: false },
]);
```
Parameters
- params: CustomMessageRegistration[]
  
  Array of custom message type registration parameters
Returns void

Static getAppSettings

getAppSettings(): NCResult<AppSettings>

Gets the application settings from the server configuration.

example

const result = NCEngine.getAppSettings();
if (result.isOk) {
  console.log('Speech-to-text enabled:', result.data.isSpeechToTextEnabled);
}

Returns NCResult<AppSettings>

The application settings or an error result

Constructors

constructor

new NCEngine(): NCEngine

Returns NCEngine

Hierarchy

Index

Properties

Methods

Constructors

Properties

Static Readonly userModule

Static Readonly translateModule

Static initialize

Type declaration

Parameters

params: InitParams

Returns void

Methods

Static connect

Parameters

params: ConnectParams

Returns Promise<NCResult<ConnectResult>>

Static getNoDisturbTime

Returns Promise<NCResult<NoDisturbTimeInfo>>

Static removeNoDisturbTime

Returns Promise<NCResult<void>>

Static disconnect

Parameters

Optional disablePush: boolean

Returns Promise<void>

Static getCurrentUserId

Returns string

Static addConnectionStatusHandler

Parameters

identifier: string

handler: ConnectionStatusHandler

Returns void

Static removeConnectionStatusHandler

Parameters

identifier: string

Returns void

Static getConnectionStatus

Returns ConnectionStatus

Static setNoDisturbTime

Parameters

params: NoDisturbTimeInfo

Returns Promise<NCResult<void>>

Static addChannelHandler

Parameters

identifier: string

handler: ChannelHandler

Returns void

Static removeChannelHandler

Parameters

identifier: string

Returns void

Static addMessageHandler

Parameters

identifier: string

handler: MessageHandler

Returns void

Static removeMessageHandler

Parameters

identifier: string

Returns void

Static addUserHandler

Parameters

identifier: string

handler: UserHandler

Returns void

Static removeUserHandler

Parameters

identifier: string

Returns void

Static addUserSettingsHandler

Parameters

identifier: string

handler: UserSettingsHandler

Returns void

Static removeUserSettingsHandler

Parameters

identifier: string

Returns void

Static addTranslateHandler