Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ILanguages

export
interface

ILanguages

description

There are over 500 predefined language/dialect combinations available in Lokalise. In case you require a custom language/dialect combination use custom_X languages (where X is a number from 1 to 100). You may override language code and name when adding a language, or update an existing language properties later.

Hierarchy

  • ILanguages

Implemented by

Index

Methods

Methods

create

  • create(projectId: string, body: object): Promise<object>
  • description

    Creates one or more languages in the project. Requires Manage languages admin right.

    memberof

    ILanguages

    Parameters

    • projectId: string
    • body: object

    Returns Promise<object>

    }

delete

  • delete(projectId: string, langId: number): Promise<object>
  • description

    Deletes a language from the project. Requires Manage languages admin right.

    memberof

    ILanguages

    Parameters

    • projectId: string
    • langId: number

    Returns Promise<object>

    }

get

  • get(projectId: string, langId: number): Promise<object>
  • description

    Retrieves a Language object.

    memberof

    ILanguages

    Parameters

    • projectId: string
    • langId: number

    Returns Promise<object>

    }

list

  • list(projectId?: string, query?: IPage): Promise<object>
  • description

    Retrieves a list of system languages, or project languages

    memberof

    ILanguages

    Parameters

    • Optional projectId: string
    • Optional query: IPage

    Returns Promise<object>

    }

update

  • update(projectId: string, langId: number, body: object): Promise<object>
  • description

    Updates the properties of a language. Requires Manage languages admin right.

    memberof

    ILanguages

    Parameters

    • projectId: string
    • langId: number
    • body: object

    Returns Promise<object>

    }

Generated using TypeDoc