Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TranslateModule

Module for message and text translation features. Access via NCEngine.translateModule.

example
// Set target language
await NCEngine.translateModule.setTranslationLanguage('en');

// Enable auto-translate
await NCEngine.translateModule.setAutoTranslateEnabled(true);

Hierarchy

  • TranslateModule

Index

Methods

Methods

translateMessages

translateTexts

  • Translates raw text strings. The translation result will be delivered via TranslateHandlerParams.onTranslationCompleted.

    example
    import { TranslateTextParam } from '@nexconn/chat';
    await NCEngine.translateModule.translateTexts({
      list: [new TranslateTextParam('你好', 'zh', 'en')],
    });

    Parameters

    Returns Promise<NCResult<void>>

    A promise resolving to the operation result

setTranslationLanguage

  • setTranslationLanguage(language: string): Promise<NCResult<void>>

  • Sets the target language for translations (user-level setting).

    example
    await NCEngine.translateModule.setTranslationLanguage('en');

    Parameters

    • language: string

      The target language code (e.g. 'en', 'zh', 'ja')

    Returns Promise<NCResult<void>>

    A promise resolving to the operation result

getTranslationLanguage

  • getTranslationLanguage(): Promise<NCResult<string>>

  • Gets the current target language for translations.

    example
    const r = await NCEngine.translateModule.getTranslationLanguage();
    if (r.isOk) console.log(r.data);

    Returns Promise<NCResult<string>>

    A promise resolving to the target language code

setAutoTranslateEnabled

  • setAutoTranslateEnabled(isEnabled: boolean): Promise<NCResult<void>>

  • Enables or disables auto-translate (user-level setting).

    example
    await NCEngine.translateModule.setAutoTranslateEnabled(true);

    Parameters

    • isEnabled: boolean

      Whether to enable auto-translate

    Returns Promise<NCResult<void>>

    A promise resolving to the operation result

getAutoTranslateEnabled

  • getAutoTranslateEnabled(): Promise<NCResult<boolean>>

  • Gets the current auto-translate enabled state.

    example
    const r = await NCEngine.translateModule.getAutoTranslateEnabled();

    Returns Promise<NCResult<boolean>>

    A promise resolving to whether auto-translate is enabled

setTranslateStrategy

  • Sets the translate strategy for one or more channels.

    example
    await NCEngine.translateModule.setTranslateStrategy(
      [new DirectChannelIdentifier('user-123')],
      TranslateStrategy.AUTO,
    );

    Parameters

    Returns Promise<NCResult<void>>

    A promise resolving to the operation result