Interface Locale

interface Locale {
    code: string;
    contentDeliveryApi: boolean;
    contentManagementApi: boolean;
    default: boolean;
    fallbackCode: null | string;
    internal_code: string;
    name: string;
    optional: boolean;
    sys: BasicMetaSysProps & {
        environment: SysLink;
        space: SysLink;
    };
    delete(): Promise<void>;
    toPlainObject(): LocaleProps;
    update(): Promise<Locale>;
}

Hierarchy (view full)

Properties

code contentDeliveryApi contentManagementApi default fallbackCode internal_code name optional sys

Methods

delete toPlainObject update

Properties

code

code: string

Locale code (example: en-us)

contentDeliveryApi

contentDeliveryApi: boolean

If the content under this locale should be available on the CDA (for public reading)

contentManagementApi

contentManagementApi: boolean

If the content under this locale should be available on the CMA (for editing)

default

default: boolean

If this is the default locale

fallbackCode

fallbackCode: null | string

Locale code to fallback to when there is not content for the current locale

internal_code

internal_code: string

Internal locale code

name

name: string

Locale name

optional

optional: boolean

If the locale needs to be filled in on entries or not

sys

sys: BasicMetaSysProps & {
    environment: SysLink;
    space: SysLink;
}

Methods

delete

  • delete(): Promise<void>

  • Deletes this object on the server.

    Returns Promise<void>

    Promise for the deletion. It contains no data, but the Promise error case should be handled.

    Example: ```javascript const contentful = require('contentful-management') const client = contentful.createClient({ accessToken: '<content_management_api_key>' }) client.getSpace('<space_id>') .then((space) => space.getEnvironment('<environment_id>')) .then((environment) => environment.getLocale('<locale_id>')) .then((locale) => locale.delete()) .then(() => console.log(`locale deleted.`)) .catch(console.error) ```

toPlainObject

update

  • update(): Promise<Locale>

  • Sends an update to the server with any changes made to the object's properties

    Returns Promise<Locale>

    Object returned from the server with updated changes.

    Example: ```javascript const contentful = require('contentful-management') const client = contentful.createClient({ accessToken: '<content_management_api_key>' }) client.getSpace('<space_id>') .then((space) => space.getEnvironment('<environment_id>')) .then((environment) => environment.getLocale('<locale_id>')) .then((locale) => { locale.name = 'New locale name' return locale.update() }) .then((locale) => console.log(`locale ${locale.sys.id} updated.`)) .catch(console.error) ```

Settings

Member Visibility

On This Page

Properties
Methods