Method

Description

Translate

The main translation method which calls the appropriate web service (Google, Bing etc.) or otherwise translates the specified text from the source language into a target language.

When a user submits a translation to the service, the system calls the Translate method for every translation unit (<trans-unit> element) in the XLIFF source data. The method's text parameter contains the source text of the unit.

Detect

You can use this method to call the logic of the translation service to automatically determine the language of the source text.

Kentico CMS does not use the Detect method by default, but you can implement it if you need language detection functionality in your custom API.

Speak

Converts text to a stream of sound using the given service's text-to-speech engine.

Kentico CMS does not use the Speak method by default, but you can implement it if you need text-to-speech functionality in your custom API. If your service does not support such an option, throw a not implemented exception.

IsAvailable

Checks whether the service is appropriately configured and ready to be used. For example, you can confirm that the target service is currently online, or load any credentials and API keys required by the service from the website settings and confirm their validity.

The system only offers the service when translating documents and resource strings if the IsAvailable method returns a true value.

using System;
 
using CMS.TranslationServices;
using CMS.IO;

 
/// <summary>
/// Sample machine translation service.
/// </summary>
public class SampleMachineTS : AbstractMachineTranslationService
{
  /// <summary>
  /// Translates the specified text from the source language to the target language.
  /// Must return the translated text as a string.
  /// </summary>
  /// <param name="text">Text to translate</param>
  /// <param name="sourceLang">Source language culture code</param>
  /// <param name="targetLang">Target language culture code</param>
  public override string Translate(string text, string sourceLang, string targetLang)
   {
      // "Translates" the text to upper case.
      return text.ToUpper();
   }

 
  /// <summary>
  /// Automatically attempts to detect the language of the source text.
  /// Returns the culture code of the detected language.
  /// </summary>
  /// <param name="text">Text to be processed</param>
  public override string Detect(string text)
   {
      // Use your service to detect the language. This example always returns English.
      return "en-US";
   }

 
  /// <summary>
  /// Returns a stream of sound generated by text-to-speech services (if supported).
  /// </summary>
  /// <param name="text">Text to be processed</param>
  /// <param name="lang">Culture code of the text's language</param>
  public override Stream Speak(string text, string lang)
   {
      // This service provider does not support Text-to-speech.
      throw new NotImplementedException();
   }

 
  /// <summary>
  /// Checks the necessary prerequisities needed for the service to work,
  /// e.g. availability of credentials for connecting to the service etc.
  /// </summary>
  public override bool IsAvailable()
   {
      // This sample provider does not require any settings and does not depend on
      // any other services, therefore is always available.
      return true;
   }
}