Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IContributors

export
interface

IContributors

description

You may add unlimited number of contributors to your project. User roles include admin, translator and reviewer.

Hierarchy

  • IContributors

Implemented by

Index

Methods

Methods

create

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

    Creates one or more contributors in the project. Requires Manage contributors admin right. If is_admin flag is set to true, the user would automatically get access to all project languages, overriding supplied languages object. Attribute fullname will be ignored, if the user has already been registered in Lokalise.

    memberof

    IContributors

    Parameters

    • projectId: string
    • body: object

    Returns Promise<object>

    }

delete

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

    Deletes a user from the project. Requires Manage contributors admin right.

    memberof

    IContributors

    Parameters

    • projectId: string
    • contributorId: number

    Returns Promise<object>

    }

get

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

    Retrieves a Contributor object.

    memberof

    IContributors

    Parameters

    • projectId: string
    • contributorId: number

    Returns Promise<object>

    }

list

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

    Lists contributors of the project, including access levels to the project languages. Admins always have read/write access to all languages.

    memberof

    IContributors

    Parameters

    • projectId: string
    • Optional query: IPage

    Returns Promise<object>

    }

update

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

    Updates the properties of a contributor. Requires Manage contributors admin right. If you want to give an existing contributor access to a new language, you must specify full languages array, including the previously added languages as well.

    memberof

    IContributors

    Parameters

    • projectId: string
    • contributorId: number
    • body: object

    Returns Promise<object>

    }

Generated using TypeDoc