Class CommentsService

Comments service

Hierarchy

  • CommentsService

Constructors

constructor

Properties

httpClient namespace

Methods

createComment deleteComment getComment getCommentsList pinComment readComments updateComment

Constructors

constructor

Properties

Private httpClient

httpClient: HttpClient

Private namespace

namespace: string = '/comments/v1'

Methods

createComment

  • Create comment

    Parameters

    Returns Promise<AxiosResponse<IComment, any, {}>>

    comment entity

deleteComment

  • Delete comment

    Parameters

    • id: number

      comment id

    • Optional body: Pick<ICreateCommentDto, "mentioned" | "notify" | "root_parent">

      notify params

    Returns Promise<AxiosResponse<any, any, {}>>

getComment

  • Get comment

    Parameters

    • id: number

    Returns Promise<AxiosResponse<IComment, any, {}>>

    comment entity

getCommentsList

pinComment

  • pin comments

    Parameters

    • id: number

      comment id

    • pinned: boolean

      comment pinned flag

    Returns Promise<AxiosResponse<any, any, {}>>

    comment entity

readComments

  • Read comments

    Parameters

    • commentIds: number[]

    Returns Promise<AxiosResponse<any, any, {}>>

updateComment

  • Update comment

    Parameters

    Returns Promise<AxiosResponse<IComment, any, {}>>

    comment entity

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc