Class CommentsService

Comments service

Hierarchy

CommentsService

Index

Constructors

Properties

httpClient namespace

Methods

createComment deleteComment getComment getCommentsList pinComment readComments updateComment

Constructors

constructor

new CommentsService(httpClient): CommentsService
Parameters
- httpClient: HttpClient
Returns CommentsService

Properties

`Private` httpClient

httpClient: HttpClient

`Private` namespace

namespace: string = '/comments/v1'

Methods

createComment

createComment(body): Promise<AxiosResponse<IComment, any>>
Create comment
Parameters
- body: ICreateCommentDto
  
  create comment params
Returns Promise<AxiosResponse<IComment, any>>
comment entity

deleteComment

deleteComment(id): Promise<AxiosResponse<any, any>>
Delete comment
Parameters
- id: number
  
  comment id
Returns Promise<AxiosResponse<any, any>>

getComment

getComment(id): Promise<AxiosResponse<IComment, any>>
Get comment
Parameters
- id: number
Returns Promise<AxiosResponse<IComment, any>>
comment entity

getCommentsList

getCommentsList(params): Promise<AxiosResponse<IResponseWithMeta<IComment>, any>>
Get comments
Parameters
- params: ICommentParams
Returns Promise<AxiosResponse<IResponseWithMeta<IComment>, any>>
list of comments

pinComment

pinComment(id, pinned): Promise<AxiosResponse<any, any>>
pin comments
Parameters
- id: number
  
  comment id
- pinned: boolean
  
  comment pinned flag
Returns Promise<AxiosResponse<any, any>>
comment entity

readComments

readComments(commentIds): Promise<AxiosResponse<any, any>>
Read comments
Parameters
- commentIds: number[]
Returns Promise<AxiosResponse<any, any>>

updateComment

updateComment(id, body): Promise<AxiosResponse<IComment, any>>
Update comment
Parameters
- id: number
  
  comment id
- body: ICreateCommentDto
  
  update comment params
Returns Promise<AxiosResponse<IComment, any>>
comment entity

Generated using TypeDoc