Class: CommentService

services/comment.CommentService

Comment service can be used in the following way:

1. Import the service from our library:

import {CommentService} from "@selfcommunity/api-services";

2. Create a function and put the service inside it!
The async function `getAllComments` will return the paginated list of comments.

async getAllComments() {
       return await CommentService.getAllComments();
     }

In case of required `params`, just add them inside the brackets.

async getASpecificComment(commentId) {
       return await CommentService.getASpecificComment(commentId);
     }

If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).

1. Declare it(or declare them, it is possible to add multiple params)

const headers = headers: {Authorization: `Bearer ${yourToken}`}

2. Add it inside the brackets and pass it to the function, as shown in the previous example!

Constructors

constructor

• new CommentService(): CommentService

Returns

CommentService

Methods

createComment

▸ createComment(data, config?): Promise<SCCommentType>

Parameters

Name	Type
data	CommentCreateParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCCommentType>

Defined in

services/comment/index.ts:170

---

deleteComment

▸ deleteComment(id, config?): Promise<any>

Parameters

Name	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Defined in

services/comment/index.ts:179

---

flagComment

▸ flagComment(id, flagType, config?): Promise<any>

Parameters

Name	Type
id	string | number
flagType	SCFlagTypeEnum
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Defined in

services/comment/index.ts:194

---

getASpecificComment

▸ getASpecificComment(id, config?): Promise<SCCommentType>

Parameters

Name	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<SCCommentType>

Defined in

services/comment/index.ts:173

---

getAllComments

▸ getAllComments(params, config?): Promise<SCPaginatedResponse<SCCommentType>>

Parameters

Name	Type
params	CommentListParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCCommentType>>

Defined in

services/comment/index.ts:167

---

getSpecificCommentFlagStatus

▸ getSpecificCommentFlagStatus(id, config?): Promise<SCFlagType>

Parameters

Name	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<SCFlagType>

Defined in

services/comment/index.ts:197

---

getSpecificCommentFlags

▸ getSpecificCommentFlags(id, config?): Promise<SCPaginatedResponse<SCFlagType>>

Parameters

Name	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCFlagType>>

Defined in

services/comment/index.ts:191

---

getSpecificCommentVotesList

▸ getSpecificCommentVotesList(id, config?): Promise<SCPaginatedResponse<SCVoteType>>

Parameters

Name	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCVoteType>>

Defined in

services/comment/index.ts:185

---

restoreComment

▸ restoreComment(id, config?): Promise<any>

Parameters

Name	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Defined in

services/comment/index.ts:182

---

updateComment

▸ updateComment(id, text, config?): Promise<SCCommentType>

Parameters

Name	Type
id	string | number
text	string
config?	AxiosRequestConfig<any>

Returns

Promise<SCCommentType>

Defined in

services/comment/index.ts:176

---

upvoteComment

▸ upvoteComment(id, config?): Promise<any>

Parameters

Name	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Defined in

services/comment/index.ts:188