Class LanguageService

Index

Constructors

Methods

deleteLanguageByIsoCode getItemLanguage getItemLanguageDefault getLanguage getLanguageByIsoCode postLanguage putLanguageByIsoCode

Constructors

constructor

new LanguageService(): LanguageService
Returns LanguageService

Methods

`Static`deleteLanguageByIsoCode

deleteLanguageByIsoCode<ThrowOnError extends boolean = true>(
    options: Options<DeleteLanguageByIsoCodeData, ThrowOnError>,
): RequestResult<
    DeleteLanguageByIsoCodeResponses,
    DeleteLanguageByIsoCodeErrors,
    ThrowOnError,
    "fields",
>
Deletes a language.

Deletes a language identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteLanguageByIsoCodeData, ThrowOnError>
Returns RequestResult<
    DeleteLanguageByIsoCodeResponses,
    DeleteLanguageByIsoCodeErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:3035

`Static`getItemLanguage

getItemLanguage<ThrowOnError extends boolean = true>(
    options?: Options<GetItemLanguageData, ThrowOnError>,
): RequestResult<
    GetItemLanguageResponses,
    GetItemLanguageErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of language items.

Gets a collection of language items identified by the provided Ids.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetItemLanguageData, ThrowOnError>
Returns RequestResult<
    GetItemLanguageResponses,
    GetItemLanguageErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2959

`Static`getItemLanguageDefault

getItemLanguageDefault<ThrowOnError extends boolean = true>(
    options?: Options<GetItemLanguageDefaultData, ThrowOnError>,
): RequestResult<
    GetItemLanguageDefaultResponses,
    GetItemLanguageDefaultErrors,
    ThrowOnError,
    "fields",
>
Gets the default language.

Gets the default language configured for the Umbraco installation.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetItemLanguageDefaultData, ThrowOnError>
Returns RequestResult<
    GetItemLanguageDefaultResponses,
    GetItemLanguageDefaultErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2977

`Static`getLanguage

getLanguage<ThrowOnError extends boolean = true>(
    options?: Options<GetLanguageData, ThrowOnError>,
): RequestResult<
    GetLanguageResponses,
    GetLanguageErrors,
    ThrowOnError,
    "fields",
>
Gets a paginated collection of languages.

Gets a paginated collection of all configured languages.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetLanguageData, ThrowOnError>
Returns RequestResult<GetLanguageResponses, GetLanguageErrors, ThrowOnError, "fields">
- Defined in src/packages/core/backend-api/sdk.gen.ts:2995

`Static`getLanguageByIsoCode

getLanguageByIsoCode<ThrowOnError extends boolean = true>(
    options: Options<GetLanguageByIsoCodeData, ThrowOnError>,
): RequestResult<
    GetLanguageByIsoCodeResponses,
    GetLanguageByIsoCodeErrors,
    ThrowOnError,
    "fields",
>
Gets a language by ISO code.

Gets a language identified by the provided ISO code.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetLanguageByIsoCodeData, ThrowOnError>
Returns RequestResult<
    GetLanguageByIsoCodeResponses,
    GetLanguageByIsoCodeErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:3053

`Static`postLanguage

postLanguage<ThrowOnError extends boolean = true>(
    options?: Options<PostLanguageData, ThrowOnError>,
): RequestResult<
    PostLanguageResponses,
    PostLanguageErrors,
    ThrowOnError,
    "fields",
>
Creates a new language.

Creates a new language with the configuration specified in the request model.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostLanguageData, ThrowOnError>
Returns RequestResult<PostLanguageResponses, PostLanguageErrors, ThrowOnError, "fields">
- Defined in src/packages/core/backend-api/sdk.gen.ts:3013

`Static`putLanguageByIsoCode

putLanguageByIsoCode<ThrowOnError extends boolean = true>(
    options: Options<PutLanguageByIsoCodeData, ThrowOnError>,
): RequestResult<
    PutLanguageByIsoCodeResponses,
    PutLanguageByIsoCodeErrors,
    ThrowOnError,
    "fields",
>
Updates a language.

Updates a language identified by the provided Id with the details from the request model.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutLanguageByIsoCodeData, ThrowOnError>
Returns RequestResult<
    PutLanguageByIsoCodeResponses,
    PutLanguageByIsoCodeErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:3071

Class LanguageService

Index

Constructors

Methods

Constructors

constructor

Returns LanguageService

Methods

`Static`deleteLanguageByIsoCode

Type Parameters

Parameters

Returns RequestResult<
    DeleteLanguageByIsoCodeResponses,
    DeleteLanguageByIsoCodeErrors,
    ThrowOnError,
    "fields",
>

`Static`getItemLanguage

Type Parameters

Parameters

Returns RequestResult<
    GetItemLanguageResponses,
    GetItemLanguageErrors,
    ThrowOnError,
    "fields",
>

`Static`getItemLanguageDefault

Type Parameters

Parameters

Returns RequestResult<
    GetItemLanguageDefaultResponses,
    GetItemLanguageDefaultErrors,
    ThrowOnError,
    "fields",
>

`Static`getLanguage

Type Parameters

Parameters

Returns RequestResult<GetLanguageResponses, GetLanguageErrors, ThrowOnError, "fields">

`Static`getLanguageByIsoCode

Type Parameters

Parameters

Returns RequestResult<
    GetLanguageByIsoCodeResponses,
    GetLanguageByIsoCodeErrors,
    ThrowOnError,
    "fields",
>

`Static`postLanguage

Type Parameters

Parameters

Returns RequestResult<PostLanguageResponses, PostLanguageErrors, ThrowOnError, "fields">

`Static`putLanguageByIsoCode

Type Parameters

Parameters

Returns RequestResult<
    PutLanguageByIsoCodeResponses,
    PutLanguageByIsoCodeErrors,
    ThrowOnError,
    "fields",
>

Settings

On This Page

Class LanguageService

Index

Constructors

Methods

Constructors

constructor

Returns LanguageService

Methods

StaticdeleteLanguageByIsoCode

Type Parameters

Parameters

Returns RequestResult< DeleteLanguageByIsoCodeResponses, DeleteLanguageByIsoCodeErrors, ThrowOnError, "fields",>

StaticgetItemLanguage

Type Parameters

Parameters

Returns RequestResult< GetItemLanguageResponses, GetItemLanguageErrors, ThrowOnError, "fields",>

StaticgetItemLanguageDefault

Type Parameters

Parameters

Returns RequestResult< GetItemLanguageDefaultResponses, GetItemLanguageDefaultErrors, ThrowOnError, "fields",>

StaticgetLanguage

Type Parameters

Parameters

Returns RequestResult<GetLanguageResponses, GetLanguageErrors, ThrowOnError, "fields">

StaticgetLanguageByIsoCode

Type Parameters

Parameters

Returns RequestResult< GetLanguageByIsoCodeResponses, GetLanguageByIsoCodeErrors, ThrowOnError, "fields",>

StaticpostLanguage

Type Parameters

Parameters

Returns RequestResult<PostLanguageResponses, PostLanguageErrors, ThrowOnError, "fields">

StaticputLanguageByIsoCode

Type Parameters

Parameters

Returns RequestResult< PutLanguageByIsoCodeResponses, PutLanguageByIsoCodeErrors, ThrowOnError, "fields",>

Settings

On This Page

`Static`deleteLanguageByIsoCode

Returns RequestResult<
DeleteLanguageByIsoCodeResponses,
DeleteLanguageByIsoCodeErrors,
ThrowOnError,
"fields",
>

`Static`getItemLanguage

Returns RequestResult<
GetItemLanguageResponses,
GetItemLanguageErrors,
ThrowOnError,
"fields",
>

`Static`getItemLanguageDefault

Returns RequestResult<
GetItemLanguageDefaultResponses,
GetItemLanguageDefaultErrors,
ThrowOnError,
"fields",
>

`Static`getLanguage

`Static`getLanguageByIsoCode

Returns RequestResult<
GetLanguageByIsoCodeResponses,
GetLanguageByIsoCodeErrors,
ThrowOnError,
"fields",
>

`Static`postLanguage

`Static`putLanguageByIsoCode

Returns RequestResult<
PutLanguageByIsoCodeResponses,
PutLanguageByIsoCodeErrors,
ThrowOnError,
"fields",
>