Class GlossariesApiExecutor

Inheritance

object

GlossariesApiExecutor

Implements

IGlossariesApiExecutor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Crowdin.Api.Glossaries

Assembly: Crowdin.Api.dll

Syntax

public class GlossariesApiExecutor : IGlossariesApiExecutor

Constructors

| Edit this page View Source

GlossariesApiExecutor(ICrowdinApiClient)

Declaration

public GlossariesApiExecutor(ICrowdinApiClient apiClient)

Parameters

Type	Name	Description
ICrowdinApiClient	apiClient

| Edit this page View Source

GlossariesApiExecutor(ICrowdinApiClient, IJsonParser)

Declaration

public GlossariesApiExecutor(ICrowdinApiClient apiClient, IJsonParser jsonParser)

Parameters

Type	Name	Description
ICrowdinApiClient	apiClient
IJsonParser	jsonParser

Methods

| Edit this page View Source

AddGlossary(AddGlossaryRequest)

Add glossary. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<Glossary> AddGlossary(AddGlossaryRequest request)

Parameters

Type	Name	Description
AddGlossaryRequest	request

Returns

Type	Description
Task<Glossary>

| Edit this page View Source

AddTerm(long, AddTermRequest)

Add term. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<Term> AddTerm(long glossaryId, AddTermRequest request)

Parameters

Type	Name	Description
long	glossaryId
AddTermRequest	request

Returns

Type	Description
Task<Term>

| Edit this page View Source

CheckGlossaryExportStatus(long, string)

Check glossary export status. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<GlossaryExportStatus> CheckGlossaryExportStatus(long glossaryId, string exportId)

Parameters

Type	Name	Description
long	glossaryId
string	exportId

Returns

Type	Description
Task<GlossaryExportStatus>

| Edit this page View Source

CheckGlossaryImportStatus(long, string)

Check glossary import status. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<GlossaryImportStatus> CheckGlossaryImportStatus(long glossaryId, string importId)

Parameters

Type	Name	Description
long	glossaryId
string	importId

Returns

Type	Description
Task<GlossaryImportStatus>

| Edit this page View Source

ClearGlossary(long, string?, long?, long?)

Clear glossary. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task ClearGlossary(long glossaryId, string? languageId = null, long? conceptId = null, long? translationOfTermId = null)

Parameters

Type	Name	Description
long	glossaryId
string	languageId
long?	conceptId
long?	translationOfTermId

Returns

Type	Description
Task

| Edit this page View Source

ConcordanceSearch(long, ConcordanceSearchRequest)

Concordance search in Glossaries. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<ResponseList<GlossaryConcordanceResultResource>> ConcordanceSearch(long projectId, ConcordanceSearchRequest request)

Parameters

Type	Name	Description
long	projectId
ConcordanceSearchRequest	request

Returns

Type	Description
Task<ResponseList<GlossaryConcordanceResultResource>>

| Edit this page View Source

DeleteConcept(long, long)

List terms. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task DeleteConcept(long glossaryId, long conceptId)

Parameters

Type	Name	Description
long	glossaryId
long	conceptId

Returns

Type	Description
Task

| Edit this page View Source

DeleteGlossary(long)

Delete glossary. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task DeleteGlossary(long glossaryId)

Parameters

Type	Name	Description
long	glossaryId

Returns

Type	Description
Task

| Edit this page View Source

DeleteTerm(long, long)

Delete term. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task DeleteTerm(long glossaryId, long termId)

Parameters

Type	Name	Description
long	glossaryId
long	termId

Returns

Type	Description
Task

| Edit this page View Source

DownloadGlossary(long, string)

Download glossary. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<DownloadLink> DownloadGlossary(long glossaryId, string exportId)

Parameters

Type	Name	Description
long	glossaryId
string	exportId

Returns

Type	Description
Task<DownloadLink>

| Edit this page View Source

EditGlossary(long, IEnumerable<GlossaryPatch>)

Edit glossary. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<Glossary> EditGlossary(long glossaryId, IEnumerable<GlossaryPatch> patches)

Parameters

Type	Name	Description
long	glossaryId
IEnumerable<GlossaryPatch>	patches

Returns

Type	Description
Task<Glossary>

| Edit this page View Source

EditTerm(long, long, IEnumerable<TermPatch>)

Edit term. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<Term> EditTerm(long glossaryId, long termId, IEnumerable<TermPatch> patches)

Parameters

Type	Name	Description
long	glossaryId
long	termId
IEnumerable<TermPatch>	patches

Returns

Type	Description
Task<Term>

| Edit this page View Source

ExportGlossary(long, ExportGlossaryRequest)

Export glossary. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<GlossaryExportStatus> ExportGlossary(long glossaryId, ExportGlossaryRequest request)

Parameters

Type	Name	Description
long	glossaryId
ExportGlossaryRequest	request

Returns

Type	Description
Task<GlossaryExportStatus>

| Edit this page View Source

GetConcept(long, long)

List terms. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<Concept> GetConcept(long glossaryId, long conceptId)

Parameters

Type	Name	Description
long	glossaryId
long	conceptId

Returns

Type	Description
Task<Concept>

| Edit this page View Source

GetGlossary(long)

Get glossary. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<Glossary> GetGlossary(long glossaryId)

Parameters

Type	Name	Description
long	glossaryId

Returns

Type	Description
Task<Glossary>

| Edit this page View Source

GetTerm(long, long)

Get term. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<Term> GetTerm(long glossaryId, long termId)

Parameters

Type	Name	Description
long	glossaryId
long	termId

Returns

Type	Description
Task<Term>

| Edit this page View Source

ImportGlossary(long, ImportGlossaryRequest)

Import glossary. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<GlossaryImportStatus> ImportGlossary(long glossaryId, ImportGlossaryRequest request)

Parameters

Type	Name	Description
long	glossaryId
ImportGlossaryRequest	request

Returns

Type	Description
Task<GlossaryImportStatus>

| Edit this page View Source

ListConcepts(long, int, int, IEnumerable<SortingRule>?)

List terms. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<ResponseList<Concept>> ListConcepts(long glossaryId, int limit = 25, int offset = 0, IEnumerable<SortingRule>? orderBy = null)

Parameters

Type	Name	Description
long	glossaryId
int	limit
int	offset
IEnumerable<SortingRule>	orderBy

Returns

Type	Description
Task<ResponseList<Concept>>

| Edit this page View Source

ListGlossaries(GlossariesListParams)

List glossaries. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<ResponseList<Glossary>> ListGlossaries(GlossariesListParams @params)

Parameters

Type	Name	Description
GlossariesListParams	params

Returns

Type	Description
Task<ResponseList<Glossary>>

| Edit this page View Source

ListGlossaries(int, int, long?, long?, IEnumerable<SortingRule>?)

List glossaries. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<ResponseList<Glossary>> ListGlossaries(int limit = 25, int offset = 0, long? userId = null, long? groupId = null, IEnumerable<SortingRule>? orderBy = null)

Parameters

Type	Name	Description
int	limit
int	offset
long?	userId
long?	groupId
IEnumerable<SortingRule>	orderBy

Returns

Type	Description
Task<ResponseList<Glossary>>

| Edit this page View Source

ListTerms(long, TermsListParams)

List terms. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<ResponseList<Term>> ListTerms(long glossaryId, TermsListParams @params)

Parameters

Type	Name	Description
long	glossaryId
TermsListParams	params

Returns

Type	Description
Task<ResponseList<Term>>

| Edit this page View Source

ListTerms(long, long?, string?, long?, long?, string?, int, int, IEnumerable<SortingRule>?)

List terms. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<ResponseList<Term>> ListTerms(long glossaryId, long? userId = null, string? languageId = null, long? translationOfTermId = null, long? conceptId = null, string? croql = null, int limit = 25, int offset = 0, IEnumerable<SortingRule>? orderBy = null)

Parameters

Type	Name	Description
long	glossaryId
long?	userId
string	languageId
long?	translationOfTermId
long?	conceptId
string	croql
int	limit
int	offset
IEnumerable<SortingRule>	orderBy

Returns

Type	Description
Task<ResponseList<Term>>

| Edit this page View Source

UpdateConcept(long, long, UpdateConceptRequest)

List terms. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<Concept> UpdateConcept(long glossaryId, long conceptId, UpdateConceptRequest request)

Parameters

Type	Name	Description
long	glossaryId
long	conceptId
UpdateConceptRequest	request

Returns

Type	Description
Task<Concept>

Implements

IGlossariesApiExecutor