Class CloudTranslationProvider

Represents server-provided access to translation memories and provides related administrative and maintenance services.

Inheritance

System.Object

CloudTranslationProvider

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Sdl.LanguagePlatform.TranslationMemoryApi

Assembly: Sdl.LanguagePlatform.TranslationMemoryApi.dll

Syntax

public class CloudTranslationProvider

Constructors

CloudTranslationProvider()

Initializes a new instance of the CloudTranslationProvider class.

Declaration

public CloudTranslationProvider()

Remarks

This is for in-line server side usage and assumes thet the SDL identity has been propagated to the calling Thread.

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the current thread's principal is invalid.

CloudTranslationProvider(Uri, Boolean, String, String)

Creates a new translation provider server.

Declaration

public CloudTranslationProvider(Uri serverUri, bool useWindowsAuthentication, string userName, string password)

Parameters

Type	Name	Description
System.Uri	serverUri	The URI of the server. This is of the form http://servername:port.
System.Boolean	useWindowsAuthentication	Whether to use Windows authentication. When set to false , userName and password have to be specified. When set to true , either pass null for userName and password in order to log on as the currently logged on Windows user, or set userName to a domain-qualified Windows user name and password to the matching password to log on using basic Windows authentication.
System.String	userName	When using custom authentication or basic Windows authentication, the user name of the user. Pass null to use integrated Windows authentication(see useWindowsAuthentication).
System.String	password	When using custom authentication or basic Windows authentication the password of the user. Pass null to use integrated Windows authentication (see useWindowsAuthentication).

CloudTranslationProvider(Uri, String, String)

Creates a new translation provider server.

Declaration

public CloudTranslationProvider(Uri serverUri, string username, string password)

Parameters

Type	Name	Description
System.Uri	serverUri
System.String	username
System.String	password

Exceptions

Type	Condition
System.Security.SecurityException

Properties

Uri

Gets the URI that was used to connect to this server.

Declaration

public Uri Uri { get; }

Property Value

Type	Description
System.Uri

Methods

GetDefaultLanguageResources(CultureInfo)

Gets default language resources for the specified language from the server.

Declaration

public LanguageResourceBundle GetDefaultLanguageResources(CultureInfo language)

Parameters

Type	Name	Description
System.Globalization.CultureInfo	language	The language for which to get the default language resources.

Returns

Type	Description
LanguageResourceBundle	A LanguageResourceBundle instance, populated with the default language resources. Note that some default language resources might be null.

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when language is null.

GetDefaultLanguageResources(String)

Gets default language resources for the specified language code from the server.

Declaration

public LanguageResourceBundle GetDefaultLanguageResources(string languageCode)

Parameters

Type	Name	Description
System.String	languageCode	The language code for which to get the default language resources.

Returns

Type	Description
LanguageResourceBundle	A LanguageResourceBundle instance, populated with the default language resources. Note that some default language resources might be null.

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when languageCode is null or empty.

GetFieldsTemplate(Guid, FieldsTemplateProperties)

Gets the fields template with the specified id, or null if no such fields template exists.

Declaration

public ServerBasedFieldsTemplate GetFieldsTemplate(Guid id, FieldsTemplateProperties additionalProperties)

Parameters

Type	Name	Description
System.Guid	id	The fields template ID.
FieldsTemplateProperties	additionalProperties	The additional related objects to retrieve.

Returns

Type	Description
ServerBasedFieldsTemplate	The fields template, or null if no fields template with given id exists.

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when id is empty.

GetFieldsTemplate(String, FieldsTemplateProperties)

Gets the fields template with the specified path, or null if no such fields template exists.

Declaration

public ServerBasedFieldsTemplate GetFieldsTemplate(string path, FieldsTemplateProperties additionalProperties)

Parameters

Type	Name	Description
System.String	path	The fields template path.
FieldsTemplateProperties	additionalProperties	The additional related objects to retrieve.

Returns

Type	Description
ServerBasedFieldsTemplate	The fields template, or null if no fields template with given id exists.

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when path is null or empty.

GetLanguageResourcesTemplate(Guid, LanguageResourcesTemplateProperties)

Gets the LanguageResourcesTemplate with the specified ID.

Declaration

public ServerBasedLanguageResourcesTemplate GetLanguageResourcesTemplate(Guid id, LanguageResourcesTemplateProperties additionalProperties)

Parameters

Type	Name	Description
System.Guid	id	The language resources template ID.
LanguageResourcesTemplateProperties	additionalProperties	The additional related objects to retrieve.

Returns

Type	Description
ServerBasedLanguageResourcesTemplate	The language resource group template, or null if it does not exist.

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when id is empty.

GetLanguageResourcesTemplate(String, LanguageResourcesTemplateProperties)

Gets the language resources template with the specified path.

Declaration

public ServerBasedLanguageResourcesTemplate GetLanguageResourcesTemplate(string path, LanguageResourcesTemplateProperties additionalProperties)

Parameters

Type	Name	Description
System.String	path	The language resources template path.
LanguageResourcesTemplateProperties	additionalProperties	The additional related objects to retrieve.

Returns

Type	Description
ServerBasedLanguageResourcesTemplate	The language resource group template, or null if it does not exist.

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when path is null or empty.

GetTranslationMemories(TranslationMemoryProperties)

Returns a collection of all the server-based translation memories on this server.

Declaration

public ReadOnlyCollection<CloudBasedTranslationMemory> GetTranslationMemories(TranslationMemoryProperties additionalProperties)

Parameters

Type	Name	Description
TranslationMemoryProperties	additionalProperties	The additional related objects to retrieve.

Returns

Type	Description
System.Collections.ObjectModel.ReadOnlyCollection<CloudBasedTranslationMemory>	A read-only collection of server-based translation memories.

GetTranslationMemory(Guid, TranslationMemoryProperties)

Gets the translation memory with the corresponding unique id.

Declaration

public CloudBasedTranslationMemory GetTranslationMemory(Guid id, TranslationMemoryProperties additionalProperties)

Parameters

Type	Name	Description
System.Guid	id	The translation memory's unique id.
TranslationMemoryProperties	additionalProperties	The additional related objects to retrieve.

Returns

Type	Description
CloudBasedTranslationMemory	The translation memory, or null if no translation memory with given id exists.

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when id is empty.

GetTranslationMemory(String, TranslationMemoryProperties)

Gets the translation memory with the corresponding unique path. Gets a translation memory through its path.

Declaration

public ServerBasedTranslationMemory GetTranslationMemory(string path, TranslationMemoryProperties additionalProperties)

Parameters

Type	Name	Description
System.String	path	The translation memory's name.
TranslationMemoryProperties	additionalProperties	The additional related objects to retrieve.

Returns

Type	Description
ServerBasedTranslationMemory	The translation memory, or null if no translation memory with given path exists.

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when path is null or empty.