Interface IGlossariesApiExecutor

Namespace: Crowdin.Api.Glossaries
Assembly: Crowdin.Api.dll
Syntax
public interface IGlossariesApiExecutor

Methods

| Improve this Doc View Source

AddGlossary(AddGlossaryRequest)

Declaration
Task<Glossary> AddGlossary(AddGlossaryRequest request)
Parameters
Type Name Description
AddGlossaryRequest request
Returns
Type Description
Task<Glossary>
| Improve this Doc View Source

AddTerm(Int32, AddTermRequest)

Declaration
Task<Term> AddTerm(int glossaryId, AddTermRequest request)
Parameters
Type Name Description
System.Int32 glossaryId
AddTermRequest request
Returns
Type Description
Task<Term>
| Improve this Doc View Source

CheckGlossaryExportStatus(Int32, String)

Declaration
Task<GlossaryExportStatus> CheckGlossaryExportStatus(int glossaryId, string exportId)
Parameters
Type Name Description
System.Int32 glossaryId
System.String exportId
Returns
Type Description
Task<GlossaryExportStatus>
| Improve this Doc View Source

CheckGlossaryImportStatus(Int32, String)

Declaration
Task<GlossaryImportStatus> CheckGlossaryImportStatus(int glossaryId, string importId)
Parameters
Type Name Description
System.Int32 glossaryId
System.String importId
Returns
Type Description
Task<GlossaryImportStatus>
| Improve this Doc View Source

ClearGlossary(Int32, Nullable<String>, Nullable<Int32>, Nullable<Int32>)

Declaration
Task ClearGlossary(int glossaryId, string? languageId = null, int? conceptId = null, int? translationOfTermId = null)
Parameters
Type Name Description
System.Int32 glossaryId
System.Nullable<System.String> languageId
System.Nullable<System.Int32> conceptId
System.Nullable<System.Int32> translationOfTermId
Returns
Type Description
Task
| Improve this Doc View Source

ConcordanceSearch(Int32, ConcordanceSearchRequest)

Declaration
Task<ResponseList<GlossaryConcordanceResultResource>> ConcordanceSearch(int projectId, ConcordanceSearchRequest request)
Parameters
Type Name Description
System.Int32 projectId
ConcordanceSearchRequest request
Returns
Type Description
Task<ResponseList<GlossaryConcordanceResultResource>>
| Improve this Doc View Source

DeleteConcept(Int32, Int32)

Declaration
Task DeleteConcept(int glossaryId, int conceptId)
Parameters
Type Name Description
System.Int32 glossaryId
System.Int32 conceptId
Returns
Type Description
Task
| Improve this Doc View Source

DeleteGlossary(Int32)

Declaration
Task DeleteGlossary(int glossaryId)
Parameters
Type Name Description
System.Int32 glossaryId
Returns
Type Description
Task
| Improve this Doc View Source

DeleteTerm(Int32, Int32)

Declaration
Task DeleteTerm(int glossaryId, int termId)
Parameters
Type Name Description
System.Int32 glossaryId
System.Int32 termId
Returns
Type Description
Task
| Improve this Doc View Source

DownloadGlossary(Int32, String)

Declaration
Task<DownloadLink> DownloadGlossary(int glossaryId, string exportId)
Parameters
Type Name Description
System.Int32 glossaryId
System.String exportId
Returns
Type Description
Task<DownloadLink>
| Improve this Doc View Source

EditGlossary(Int32, IEnumerable<GlossaryPatch>)

Declaration
Task<Glossary> EditGlossary(int glossaryId, IEnumerable<GlossaryPatch> patches)
Parameters
Type Name Description
System.Int32 glossaryId
IEnumerable<GlossaryPatch> patches
Returns
Type Description
Task<Glossary>
| Improve this Doc View Source

EditTerm(Int32, Int32, IEnumerable<TermPatch>)

Declaration
Task<Term> EditTerm(int glossaryId, int termId, IEnumerable<TermPatch> patches)
Parameters
Type Name Description
System.Int32 glossaryId
System.Int32 termId
IEnumerable<TermPatch> patches
Returns
Type Description
Task<Term>
| Improve this Doc View Source

ExportGlossary(Int32, ExportGlossaryRequest)

Declaration
Task<GlossaryExportStatus> ExportGlossary(int glossaryId, ExportGlossaryRequest request)
Parameters
Type Name Description
System.Int32 glossaryId
ExportGlossaryRequest request
Returns
Type Description
Task<GlossaryExportStatus>
| Improve this Doc View Source

GetConcept(Int32, Int32)

Declaration
Task<Concept> GetConcept(int glossaryId, int conceptId)
Parameters
Type Name Description
System.Int32 glossaryId
System.Int32 conceptId
Returns
Type Description
Task<Concept>
| Improve this Doc View Source

GetGlossary(Int32)

Declaration
Task<Glossary> GetGlossary(int glossaryId)
Parameters
Type Name Description
System.Int32 glossaryId
Returns
Type Description
Task<Glossary>
| Improve this Doc View Source

GetTerm(Int32, Int32)

Declaration
Task<Term> GetTerm(int glossaryId, int termId)
Parameters
Type Name Description
System.Int32 glossaryId
System.Int32 termId
Returns
Type Description
Task<Term>
| Improve this Doc View Source

ImportGlossary(Int32, ImportGlossaryRequest)

Declaration
Task<GlossaryImportStatus> ImportGlossary(int glossaryId, ImportGlossaryRequest request)
Parameters
Type Name Description
System.Int32 glossaryId
ImportGlossaryRequest request
Returns
Type Description
Task<GlossaryImportStatus>
| Improve this Doc View Source

ListConcepts(Int32, Int32, Int32, Nullable<IEnumerable<SortingRule>>)

Declaration
Task<ResponseList<Concept>> ListConcepts(int glossaryId, int limit = 25, int offset = 0, IEnumerable<SortingRule>? orderBy = null)
Parameters
Type Name Description
System.Int32 glossaryId
System.Int32 limit
System.Int32 offset
System.Nullable<IEnumerable<SortingRule>> orderBy
Returns
Type Description
Task<ResponseList<Concept>>
| Improve this Doc View Source

ListGlossaries(GlossariesListParams)

Declaration
Task<ResponseList<Glossary>> ListGlossaries(GlossariesListParams params)
Parameters
Type Name Description
GlossariesListParams params
Returns
Type Description
Task<ResponseList<Glossary>>
| Improve this Doc View Source

ListGlossaries(Int32, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<IEnumerable<SortingRule>>)

Declaration
Task<ResponseList<Glossary>> ListGlossaries(int limit = 25, int offset = 0, int? userId = null, int? groupId = null, IEnumerable<SortingRule>? orderBy = null)
Parameters
Type Name Description
System.Int32 limit
System.Int32 offset
System.Nullable<System.Int32> userId
System.Nullable<System.Int32> groupId
System.Nullable<IEnumerable<SortingRule>> orderBy
Returns
Type Description
Task<ResponseList<Glossary>>
| Improve this Doc View Source

ListTerms(Int32, TermsListParams)

Declaration
Task<ResponseList<Term>> ListTerms(int glossaryId, TermsListParams params)
Parameters
Type Name Description
System.Int32 glossaryId
TermsListParams params
Returns
Type Description
Task<ResponseList<Term>>
| Improve this Doc View Source

ListTerms(Int32, Nullable<Int32>, Nullable<String>, Nullable<Int32>, Nullable<Int32>, Nullable<String>, Int32, Int32, Nullable<IEnumerable<SortingRule>>)

Declaration
Task<ResponseList<Term>> ListTerms(int glossaryId, int? userId = null, string? languageId = null, int? translationOfTermId = null, int? conceptId = null, string? croql = null, int limit = 25, int offset = 0, IEnumerable<SortingRule>? orderBy = null)
Parameters
Type Name Description
System.Int32 glossaryId
System.Nullable<System.Int32> userId
System.Nullable<System.String> languageId
System.Nullable<System.Int32> translationOfTermId
System.Nullable<System.Int32> conceptId
System.Nullable<System.String> croql
System.Int32 limit
System.Int32 offset
System.Nullable<IEnumerable<SortingRule>> orderBy
Returns
Type Description
Task<ResponseList<Term>>
| Improve this Doc View Source

UpdateConcept(Int32, Int32, UpdateConceptRequest)

Declaration
Task<Concept> UpdateConcept(int glossaryId, int conceptId, UpdateConceptRequest request)
Parameters
Type Name Description
System.Int32 glossaryId
System.Int32 conceptId
UpdateConceptRequest request
Returns
Type Description
Task<Concept>