C# Class Systran.ResourcesClientLib.Api.DictionaryApi

Represents a collection of functions to interact with the API endpoints

Inheritance: IDictionaryApi

Datei anzeigen Open project: SYSTRAN/resources-api-csharp-client Class Usage Examples

Public Methods

Method	Description
DictionaryApi ( ApiClient apiClient = null ) : System	Initializes a new instance of the DictionaryApi class.
DictionaryApi ( String basePath ) : System	Initializes a new instance of the DictionaryApi class.
GetBasePath ( String basePath ) : String	Gets the base path of the API client.
ResourcesDictionaryAddPost ( DictionaryAddBody Input ) : DictionaryAddResponse	Add dictionary Add a new dictionary.
ResourcesDictionaryAddPostAsync ( DictionaryAddBody Input ) : Task	Add dictionary Add a new dictionary.
ResourcesDictionaryDeletePost ( string DictionaryId ) : void	Delete a dictionary Delete an existing dictionary.
ResourcesDictionaryDeletePostAsync ( string DictionaryId ) : System.Threading.Tasks.Task	Delete a dictionary Delete an existing dictionary.
ResourcesDictionaryEntryAddPost ( string DictionaryId, EntryAddBody Input ) : EntryAddResponse	Add an entry Add a new entry to an existing dictionary.
ResourcesDictionaryEntryAddPostAsync ( string DictionaryId, EntryAddBody Input ) : Task	Add an entry Add a new entry to an existing dictionary.
ResourcesDictionaryEntryDeletePost ( string DictionaryId, EntryDeleteBody Input ) : EntryDeleteResponse	Delete an entry Delete an entry in an existing dictionary.
ResourcesDictionaryEntryDeletePostAsync ( string DictionaryId, EntryDeleteBody Input ) : Task	Delete an entry Delete an entry in an existing dictionary.
ResourcesDictionaryEntryImportPost ( string DictionaryId, string SourceLang, string InputFile ) : DictionariesImportResponse	Import entries Import entries to an existing dictionary.
ResourcesDictionaryEntryImportPostAsync ( string DictionaryId, string SourceLang, string InputFile ) : Task	Import entries Import entries to an existing dictionary.
ResourcesDictionaryEntryListPost ( string DictionaryId, EntriesListFilters Filters ) : EntriesListResponse	List entries List entries for a specific dictionary.
ResourcesDictionaryEntryListPostAsync ( string DictionaryId, EntriesListFilters Filters ) : Task	List entries List entries for a specific dictionary.
ResourcesDictionaryEntryUpdatePost ( string DictionaryId, EntryUpdateBody Input ) : EntryUpdateResponse	Update an entry Update an entry in an existing dictionary.
ResourcesDictionaryEntryUpdatePostAsync ( string DictionaryId, EntryUpdateBody Input ) : Task	Update an entry Update an entry in an existing dictionary.
ResourcesDictionaryExportPost ( string DictionaryId ) : void	Export a dictionary Export an existing dictionary.
ResourcesDictionaryExportPostAsync ( string DictionaryId ) : System.Threading.Tasks.Task	Export a dictionary Export an existing dictionary.
ResourcesDictionaryListPost ( DictionariesListFilters Filters ) : DictionariesListResponse	List dictionaries List the dictionaries.
ResourcesDictionaryListPostAsync ( DictionariesListFilters Filters ) : Task	List dictionaries List the dictionaries.
ResourcesDictionaryLookupGet ( string Source, string Target, List Input, bool Autocomplete, string Callback ) : LookupResponse	Lookup Lookup words from a source language to a target language.
ResourcesDictionaryLookupGetAsync ( string Source, string Target, List Input, bool Autocomplete, string Callback ) : Task	Lookup Lookup words from a source language to a target language.
ResourcesDictionaryLookupSupportedLanguagesGet ( string Source, string Target, string Callback ) : LookupSupportedLanguageResponse	Lookup Supported Languages List of language pairs in which lookup is supported. This list can be limited to a specific source language or target language.\n
ResourcesDictionaryLookupSupportedLanguagesGetAsync ( string Source, string Target, string Callback ) : Task	Lookup Supported Languages List of language pairs in which lookup is supported. This list can be limited to a specific source language or target language.\n
ResourcesDictionarySupportedLanguagesGet ( ) : SupportedLanguagesResponse
ResourcesDictionarySupportedLanguagesGetAsync ( ) : Task
ResourcesDictionaryUpdatePost ( string DictionaryId, DictionaryUpdateBody Input ) : DictionaryUpdateResponse	Update a dictionary Update an existing dictionary.
ResourcesDictionaryUpdatePostAsync ( string DictionaryId, DictionaryUpdateBody Input ) : Task	Update a dictionary Update an existing dictionary.
SetBasePath ( String basePath ) : void	Sets the base path of the API client.

Method Details

DictionaryApi() public method

Initializes a new instance of the DictionaryApi class.

public DictionaryApi ( ApiClient apiClient = null ) : System
apiClient	Systran.ResourcesClientLib.Client.ApiClient
return	System

DictionaryApi() public method

Initializes a new instance of the DictionaryApi class.

public DictionaryApi ( String basePath ) : System
basePath	String
return	System

GetBasePath() public method

Gets the base path of the API client.

public GetBasePath ( String basePath ) : String
basePath	String
return	String

ResourcesDictionaryAddPost() public method

Add dictionary Add a new dictionary.

public ResourcesDictionaryAddPost ( DictionaryAddBody Input ) : DictionaryAddResponse
Input	Systran.ResourcesClientLib.Model.DictionaryAddBody	Input with dictionary information
return	Systran.ResourcesClientLib.Model.DictionaryAddResponse

ResourcesDictionaryAddPostAsync() public method

Add dictionary Add a new dictionary.

public ResourcesDictionaryAddPostAsync ( DictionaryAddBody Input ) : Task
Input	Systran.ResourcesClientLib.Model.DictionaryAddBody	Input with dictionary information
return	Task

ResourcesDictionaryDeletePost() public method

Delete a dictionary Delete an existing dictionary.

public ResourcesDictionaryDeletePost ( string DictionaryId ) : void
DictionaryId	string	Dictionary Id
return	void

ResourcesDictionaryDeletePostAsync() public method

Delete a dictionary Delete an existing dictionary.

public ResourcesDictionaryDeletePostAsync ( string DictionaryId ) : System.Threading.Tasks.Task
DictionaryId	string	Dictionary Id
return	System.Threading.Tasks.Task

ResourcesDictionaryEntryAddPost() public method

Add an entry Add a new entry to an existing dictionary.

public ResourcesDictionaryEntryAddPost ( string DictionaryId, EntryAddBody Input ) : EntryAddResponse
DictionaryId	string	Dictionary Id
Input	Systran.ResourcesClientLib.Model.EntryAddBody	Input with dictionary id and entries information
return	Systran.ResourcesClientLib.Model.EntryAddResponse

ResourcesDictionaryEntryAddPostAsync() public method

Add an entry Add a new entry to an existing dictionary.

public ResourcesDictionaryEntryAddPostAsync ( string DictionaryId, EntryAddBody Input ) : Task
DictionaryId	string	Dictionary Id
Input	Systran.ResourcesClientLib.Model.EntryAddBody	Input with dictionary id and entries information
return	Task

ResourcesDictionaryEntryDeletePost() public method

Delete an entry Delete an entry in an existing dictionary.

public ResourcesDictionaryEntryDeletePost ( string DictionaryId, EntryDeleteBody Input ) : EntryDeleteResponse
DictionaryId	string	Dictionary Id
Input	Systran.ResourcesClientLib.Model.EntryDeleteBody	Input with dictionary id + entry id (src or tgt) to delete
return	Systran.ResourcesClientLib.Model.EntryDeleteResponse

ResourcesDictionaryEntryDeletePostAsync() public method

Delete an entry Delete an entry in an existing dictionary.

public ResourcesDictionaryEntryDeletePostAsync ( string DictionaryId, EntryDeleteBody Input ) : Task
DictionaryId	string	Dictionary Id
Input	Systran.ResourcesClientLib.Model.EntryDeleteBody	Input with dictionary id + entry id (src or tgt) to delete
return	Task

ResourcesDictionaryEntryImportPost() public method

Import entries Import entries to an existing dictionary.

public ResourcesDictionaryEntryImportPost ( string DictionaryId, string SourceLang, string InputFile ) : DictionariesImportResponse
DictionaryId	string	Id of the dictionary where to import entries
SourceLang	string	Source lang of the entries to import
InputFile	string	File with entries to import
return	Systran.ResourcesClientLib.Model.DictionariesImportResponse

ResourcesDictionaryEntryImportPostAsync() public method

Import entries Import entries to an existing dictionary.

public ResourcesDictionaryEntryImportPostAsync ( string DictionaryId, string SourceLang, string InputFile ) : Task
DictionaryId	string	Id of the dictionary where to import entries
SourceLang	string	Source lang of the entries to import
InputFile	string	File with entries to import
return	Task

ResourcesDictionaryEntryListPost() public method

List entries List entries for a specific dictionary.

public ResourcesDictionaryEntryListPost ( string DictionaryId, EntriesListFilters Filters ) : EntriesListResponse
DictionaryId	string	Dictionary Id
Filters	Systran.ResourcesClientLib.Model.EntriesListFilters	Different filters that can be applied to the list functionality (skip/limit/sort/match)
return	Systran.ResourcesClientLib.Model.EntriesListResponse

ResourcesDictionaryEntryListPostAsync() public method

List entries List entries for a specific dictionary.

public ResourcesDictionaryEntryListPostAsync ( string DictionaryId, EntriesListFilters Filters ) : Task
DictionaryId	string	Dictionary Id
Filters	Systran.ResourcesClientLib.Model.EntriesListFilters	Different filters that can be applied to the list functionality (skip/limit/sort/match)
return	Task

ResourcesDictionaryEntryUpdatePost() public method

Update an entry Update an entry in an existing dictionary.

public ResourcesDictionaryEntryUpdatePost ( string DictionaryId, EntryUpdateBody Input ) : EntryUpdateResponse
DictionaryId	string	Dictionary Id
Input	Systran.ResourcesClientLib.Model.EntryUpdateBody	Input with dictionary id + entry id (src or tgt) to delete
return	Systran.ResourcesClientLib.Model.EntryUpdateResponse

ResourcesDictionaryEntryUpdatePostAsync() public method

Update an entry Update an entry in an existing dictionary.

public ResourcesDictionaryEntryUpdatePostAsync ( string DictionaryId, EntryUpdateBody Input ) : Task
DictionaryId	string	Dictionary Id
Input	Systran.ResourcesClientLib.Model.EntryUpdateBody	Input with dictionary id + entry id (src or tgt) to delete
return	Task

ResourcesDictionaryExportPost() public method

Export a dictionary Export an existing dictionary.

public ResourcesDictionaryExportPost ( string DictionaryId ) : void
DictionaryId	string	Dictionary Id
return	void

ResourcesDictionaryExportPostAsync() public method

Export a dictionary Export an existing dictionary.

public ResourcesDictionaryExportPostAsync ( string DictionaryId ) : System.Threading.Tasks.Task
DictionaryId	string	Dictionary Id
return	System.Threading.Tasks.Task

ResourcesDictionaryListPost() public method

List dictionaries List the dictionaries.

public ResourcesDictionaryListPost ( DictionariesListFilters Filters ) : DictionariesListResponse
Filters	Systran.ResourcesClientLib.Model.DictionariesListFilters	Different filters that can be applied to the list functionality (skip/limit/sort/match)
return	Systran.ResourcesClientLib.Model.DictionariesListResponse

ResourcesDictionaryListPostAsync() public method

List dictionaries List the dictionaries.

public ResourcesDictionaryListPostAsync ( DictionariesListFilters Filters ) : Task
Filters	Systran.ResourcesClientLib.Model.DictionariesListFilters	Different filters that can be applied to the list functionality (skip/limit/sort/match)
return	Task

ResourcesDictionaryLookupGet() public method

Lookup Lookup words from a source language to a target language.

public ResourcesDictionaryLookupGet ( string Source, string Target, List Input, bool Autocomplete, string Callback ) : LookupResponse
Source	string	Language code of the source text\n
Target	string	Language code in which to lookup the source text\n
Input	List	Input word (the 'input' parameter can be repeated)\n
Autocomplete	bool	With this option, if the input word is not found in the source language, it will be filled in with autocompletion to perform the lookup\n\nDefault: false\n
Callback	string	Javascript callback function name for JSONP Support\n
return	Systran.ResourcesClientLib.Model.LookupResponse

ResourcesDictionaryLookupGetAsync() public method

Lookup Lookup words from a source language to a target language.

public ResourcesDictionaryLookupGetAsync ( string Source, string Target, List Input, bool Autocomplete, string Callback ) : Task
Source	string	Language code of the source text\n
Target	string	Language code in which to lookup the source text\n
Input	List	Input word (the 'input' parameter can be repeated)\n
Autocomplete	bool	With this option, if the input word is not found in the source language, it will be filled in with autocompletion to perform the lookup\n\nDefault: false\n
Callback	string	Javascript callback function name for JSONP Support\n
return	Task

ResourcesDictionaryLookupSupportedLanguagesGet() public method

Lookup Supported Languages List of language pairs in which lookup is supported. This list can be limited to a specific source language or target language.\n

public ResourcesDictionaryLookupSupportedLanguagesGet ( string Source, string Target, string Callback ) : LookupSupportedLanguageResponse
Source	string	Language code of the source text\n
Target	string	Language code into which to translate the source text\n
Callback	string	Javascript callback function name for JSONP Support\n
return	Systran.ResourcesClientLib.Model.LookupSupportedLanguageResponse

ResourcesDictionaryLookupSupportedLanguagesGetAsync() public method

Lookup Supported Languages List of language pairs in which lookup is supported. This list can be limited to a specific source language or target language.\n

public ResourcesDictionaryLookupSupportedLanguagesGetAsync ( string Source, string Target, string Callback ) : Task
Source	string	Language code of the source text\n
Target	string	Language code into which to translate the source text\n
Callback	string	Javascript callback function name for JSONP Support\n
return	Task

ResourcesDictionarySupportedLanguagesGet() public method

public ResourcesDictionarySupportedLanguagesGet ( ) : SupportedLanguagesResponse
return	Systran.ResourcesClientLib.Model.SupportedLanguagesResponse

ResourcesDictionarySupportedLanguagesGetAsync() public method

public ResourcesDictionarySupportedLanguagesGetAsync ( ) : Task
return	Task

ResourcesDictionaryUpdatePost() public method

Update a dictionary Update an existing dictionary.

public ResourcesDictionaryUpdatePost ( string DictionaryId, DictionaryUpdateBody Input ) : DictionaryUpdateResponse
DictionaryId	string	Dictionary Id
Input	Systran.ResourcesClientLib.Model.DictionaryUpdateBody	Input with dictionary id
return	Systran.ResourcesClientLib.Model.DictionaryUpdateResponse

ResourcesDictionaryUpdatePostAsync() public method

Update a dictionary Update an existing dictionary.

public ResourcesDictionaryUpdatePostAsync ( string DictionaryId, DictionaryUpdateBody Input ) : Task
DictionaryId	string	Dictionary Id
Input	Systran.ResourcesClientLib.Model.DictionaryUpdateBody	Input with dictionary id
return	Task

SetBasePath() public method

Sets the base path of the API client.

public SetBasePath ( String basePath ) : void
basePath	String
return	void