Class.TermbaseTemplateApi

Trados User Interface Extensibility / TermbaseTemplateApi

Class: TermbaseTemplateApi

Defined in: lc-public-api/apis/TermbaseTemplateApi.ts:72

Extends

• BaseAPI

Constructors

Constructor

new TermbaseTemplateApi(configuration): TermbaseTemplateApi

Defined in: lc-public-api/runtime.ts:97

Parameters

configuration

Configuration = DefaultConfig

Returns

TermbaseTemplateApi

Inherited from

runtime.BaseAPI.constructor

Methods

convertTermbaseTemplate()

convertTermbaseTemplate(requestParameters, initOverrides?): Promise<TermbaseStructure>

Defined in: lc-public-api/apis/TermbaseTemplateApi.ts:151

Converts a termbase definition (XDT file) to a termbase structure that will be returned in the response.
The structure will not be stored in the Trados Cloud Platform. Convert XDT to Termbase Structure

Parameters

requestParameters

ConvertTermbaseTemplateRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<TermbaseStructure>

---

convertTermbaseTemplateRaw()

convertTermbaseTemplateRaw(requestParameters, initOverrides?): Promise<ApiResponse<TermbaseStructure>>

Defined in: lc-public-api/apis/TermbaseTemplateApi.ts:78

Converts a termbase definition (XDT file) to a termbase structure that will be returned in the response.
The structure will not be stored in the Trados Cloud Platform. Convert XDT to Termbase Structure

Parameters

requestParameters

ConvertTermbaseTemplateRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<TermbaseStructure>>

---

createTermbaseTemplate()

createTermbaseTemplate(requestParameters, initOverrides?): Promise<TermbaseTemplate>

Defined in: lc-public-api/apis/TermbaseTemplateApi.ts:208

Creates a new termbase template. Create Termbase Template

Parameters

requestParameters

CreateTermbaseTemplateRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<TermbaseTemplate>

---

createTermbaseTemplateRaw()

createTermbaseTemplateRaw(requestParameters, initOverrides?): Promise<ApiResponse<TermbaseTemplate>>

Defined in: lc-public-api/apis/TermbaseTemplateApi.ts:160

Creates a new termbase template. Create Termbase Template

Parameters

requestParameters

CreateTermbaseTemplateRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<TermbaseTemplate>>

---

deleteTermbaseTemplate()

deleteTermbaseTemplate(requestParameters, initOverrides?): Promise<void>

Defined in: lc-public-api/apis/TermbaseTemplateApi.ts:265

Deletes a termbase template by identifier. Delete Termbase Template

Parameters

requestParameters

DeleteTermbaseTemplateRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<void>

---

deleteTermbaseTemplateRaw()

deleteTermbaseTemplateRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Defined in: lc-public-api/apis/TermbaseTemplateApi.ts:217

Deletes a termbase template by identifier. Delete Termbase Template

Parameters

requestParameters

DeleteTermbaseTemplateRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

---

getTermbaseTemplate()

getTermbaseTemplate(requestParameters, initOverrides?): Promise<TermbaseTemplate>

Defined in: lc-public-api/apis/TermbaseTemplateApi.ts:325

Get a termbase template by identifier. Get Termbase Template

Parameters

requestParameters

GetTermbaseTemplateRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<TermbaseTemplate>

---

getTermbaseTemplateRaw()

getTermbaseTemplateRaw(requestParameters, initOverrides?): Promise<ApiResponse<TermbaseTemplate>>

Defined in: lc-public-api/apis/TermbaseTemplateApi.ts:273

Get a termbase template by identifier. Get Termbase Template

Parameters

requestParameters

GetTermbaseTemplateRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<TermbaseTemplate>>

---

listTermbaseTemplates()

listTermbaseTemplates(requestParameters, initOverrides?): Promise<ListTermbaseTemplatesResponse>

Defined in: lc-public-api/apis/TermbaseTemplateApi.ts:395

List termbase templates. List Termbase Templates

Parameters

requestParameters

ListTermbaseTemplatesRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<ListTermbaseTemplatesResponse>

---

listTermbaseTemplatesRaw()

listTermbaseTemplatesRaw(requestParameters, initOverrides?): Promise<ApiResponse<ListTermbaseTemplatesResponse>>

Defined in: lc-public-api/apis/TermbaseTemplateApi.ts:334

List termbase templates. List Termbase Templates

Parameters

requestParameters

ListTermbaseTemplatesRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ListTermbaseTemplatesResponse>>

---

updateTermbaseTemplate()

updateTermbaseTemplate(requestParameters, initOverrides?): Promise<void>

Defined in: lc-public-api/apis/TermbaseTemplateApi.ts:455

Updates the termbase template. Update Termbase Template

Parameters

requestParameters

UpdateTermbaseTemplateRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<void>

---

updateTermbaseTemplateRaw()

updateTermbaseTemplateRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Defined in: lc-public-api/apis/TermbaseTemplateApi.ts:404

Updates the termbase template. Update Termbase Template

Parameters

requestParameters

UpdateTermbaseTemplateRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

---

withMiddleware()

withMiddleware<T>(this, ...middlewares): T

Defined in: lc-public-api/runtime.ts:101

Type Parameters

T

T extends BaseAPI

Parameters

this

T

middlewares

...Middleware[]

Returns

T

Inherited from

runtime.BaseAPI.withMiddleware

---

withPostMiddleware()

withPostMiddleware<T>(this, ...postMiddlewares): T

Defined in: lc-public-api/runtime.ts:112

Type Parameters

T

T extends BaseAPI

Parameters

this

T

postMiddlewares

...((context) => Promise<void | Response> | undefined)[]

Returns

T

Inherited from

runtime.BaseAPI.withPostMiddleware

---

withPreMiddleware()

withPreMiddleware<T>(this, ...preMiddlewares): T

Defined in: lc-public-api/runtime.ts:107

Type Parameters

T

T extends BaseAPI

Parameters

this

T

preMiddlewares

...((context) => Promise<void | FetchParams> | undefined)[]

Returns

T

Inherited from

runtime.BaseAPI.withPreMiddleware