Skip to main content

Interface: CommentApiClientInterface

services/comment.CommentApiClientInterface

Methods

createComment

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

Parameters

NameType
dataCommentCreateParams
config?AxiosRequestConfig<any>

Returns

Promise<SCCommentType>

Defined in

services/comment/index.ts:10


deleteComment

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

Parameters

NameType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise<any>

Defined in

services/comment/index.ts:13


flagComment

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

Parameters

NameType
idstring | number
flagTypeSCFlagTypeEnum
config?AxiosRequestConfig<any>

Returns

Promise<any>

Defined in

services/comment/index.ts:18


getASpecificComment

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

Parameters

NameType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise<SCCommentType>

Defined in

services/comment/index.ts:11


getAllComments

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

Parameters

NameType
paramsCommentListParams
config?AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCCommentType>>

Defined in

services/comment/index.ts:9


getSpecificCommentFlagStatus

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

Parameters

NameType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise<SCFlagType>

Defined in

services/comment/index.ts:19


getSpecificCommentFlags

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

Parameters

NameType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCFlagType>>

Defined in

services/comment/index.ts:17


getSpecificCommentVotesList

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

Parameters

NameType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCVoteType>>

Defined in

services/comment/index.ts:15


restoreComment

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

Parameters

NameType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise<any>

Defined in

services/comment/index.ts:14


updateComment

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

Parameters

NameType
idstring | number
textstring
config?AxiosRequestConfig<any>

Returns

Promise<SCCommentType>

Defined in

services/comment/index.ts:12


upvoteComment

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

Parameters

NameType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise<any>

Defined in

services/comment/index.ts:16