Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IProjects

export
interface

IProjects

description

Lokalise is a project-based translation management system. We recommend to keep all platform keys in the same project. Upload iOS, Android, frontend, backend and API language files

  • everything that relates to a certain app or website - to the same project. We provide you with key merging or referencing options, that let you avoid recurring work for translators.

Hierarchy

  • IProjects

Implemented by

Index

Methods

Methods

create

  • create(body: object): Promise<IProject>
  • description

    Creates a new project in the specified team. Requires Admin role in the team.

    memberof

    IProjects

    Parameters

    • body: object

    Returns Promise<IProject>

delete

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

    Deletes a project.

    memberof

    IProjects

    Parameters

    • projectId: string

    Returns Promise<object>

    }

empty

  • empty(projectId: string): Promise<object>
  • description

    Deletes all keys and translations from the project. Requires Manage settings admin right.

    memberof

    IProjects

    Parameters

    • projectId: string

    Returns Promise<object>

    }

get

  • get(projectId: string): Promise<IProject>
  • description

    Retrieves a Project object.

    memberof

    IProjects

    Parameters

    • projectId: string

    Returns Promise<IProject>

list

  • description

    Retrieves a list of projects available to the user, authorized with a token.

    memberof

    IProjects

    Parameters

    Returns Promise<object>

    }

update

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

    Updates the details of a project. Requires Manage settings admin right.

    memberof

    IProjects

    Parameters

    • projectId: string
    • body: object

    Returns Promise<IProject>

Generated using TypeDoc