Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IComments

export
interface

IComments

description

Comments can be used to give translators a context about the key, or as a discussion about certain aspects of translation for the key. There is a separate comments thread for each key. All comments are cross-posted into project chat.

Hierarchy

  • IComments

Implemented by

Index

Methods

Methods

create

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

    Adds a set of comments to the key

    memberof

    IComments

    Parameters

    • projectId: string
    • keyId: number
    • body: object

    Returns Promise<object>

    }

delete

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

    Deletes a comment from the project. Authenticated user can only delete own comments

    memberof

    IComments

    Parameters

    • projectId: string
    • keyId: number
    • commentId: number

    Returns Promise<object>

    }

get

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

    Retrieves a Comment object.

    memberof

    IComments

    Parameters

    • projectId: string
    • keyId: number
    • commentId: number

    Returns Promise<object>

    }

list

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

    Retrieves a list of all comments in the project or for given key (if specified).

    memberof

    IComments

    Parameters

    • projectId: string
    • Optional keyId: number
    • Optional query: IPage

    Returns Promise<object>

    }

Generated using TypeDoc