Skip to main content

CommentApiClientInterface

Methods

createComment()

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

Parameters

ParameterType
dataCommentCreateParams
config?AxiosRequestConfig

Returns

Promise<SCCommentType>


deleteComment()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<any>


flagComment()

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

Parameters

ParameterType
idstring | number
flagTypeSCFlagTypeEnum
config?AxiosRequestConfig

Returns

Promise<any>


getAllComments()

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

Parameters

ParameterType
paramsCommentListParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCCommentType>>


getASpecificComment()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCCommentType>


getSpecificCommentFlags()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFlagType>>


getSpecificCommentFlagStatus()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCFlagType>


getSpecificCommentVotesList()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCVoteType>>


restoreComment()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<any>


updateComment()

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

Parameters

ParameterType
idstring | number
textstring
config?AxiosRequestConfig

Returns

Promise<SCCommentType>


upvoteComment()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<any>