Skip to main content

FeedObjectApiClientInterface

Methods

checkIfFollowingFeedObject()

checkIfFollowingFeedObject(type, id, config?): Promise<SCFeedObjectFollowingStatusType>

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCFeedObjectFollowingStatusType>


checkIfSuspendedFeedObject()

checkIfSuspendedFeedObject(type, id, config?): Promise<SCFeedObjectSuspendedStatusType>

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCFeedObjectSuspendedStatusType>


createFeedObject()

createFeedObject(type, data, config?): Promise<SCFeedObjectType>

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
dataFeedObjCreateParams
config?AxiosRequestConfig

Returns

Promise<SCFeedObjectType>


deleteFeedObject()

deleteFeedObject(type, id, config?): Promise<any>

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
idstring | number
config?AxiosRequestConfig

Returns

Promise<any>


feedObjectContributorsList()

feedObjectContributorsList(type, id, params?, config?): Promise<SCPaginatedResponse<SCUserType>>

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
idstring | number
params?BaseGetParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>


feedObjectFlagList()

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

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFlagType>>


feedObjectFlagStatus()

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

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFlagType>>


feedObjectFollowingList()

feedObjectFollowingList(type, params?, config?): Promise<SCPaginatedResponse<SCFeedObjectType>>

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
params?BaseGetParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFeedObjectType>>


feedObjectHideStatus()

feedObjectHideStatus(type, id, config?): Promise<SCFeedObjectHideStatusType>

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCFeedObjectHideStatusType>


feedObjectPollVote()

feedObjectPollVote(type, id, choice, config?): Promise<any>

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
idstring | number
choicenumber
config?AxiosRequestConfig

Returns

Promise<any>


feedObjectPollVotesList()

feedObjectPollVotesList(type, id, params?, config?): Promise<SCPaginatedResponse<SCPollVoteType>>

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
idstring | number
params?FeedObjectPollVotesSearch
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCPollVoteType>>


feedObjectSharesList()

feedObjectSharesList(type, id, params?, config?): Promise<SCPaginatedResponse<SCFeedObjectType>>

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
idstring | number
params?BaseGetParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFeedObjectType>>


feedObjectSuspendedList()

feedObjectSuspendedList(type, params?, config?): Promise<SCPaginatedResponse<SCFeedObjectType>>

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
params?BaseGetParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFeedObjectType>>


feedObjectUserSharesList()

feedObjectUserSharesList(type, id, params?, config?): Promise<SCPaginatedResponse<SCUserType>>

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
idstring | number
params?BaseGetParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>


feedObjectVotes()

feedObjectVotes(type, id, params?, config?): Promise<SCPaginatedResponse<SCVoteType>>

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
idstring | number
params?BaseGetParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCVoteType>>


flagFeedObject()

flagFeedObject(type, id, flag_type, config?): Promise<any>

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
idstring | number
flag_typeSCFlagTypeEnum
config?AxiosRequestConfig

Returns

Promise<any>


followFeedObject()

followFeedObject(type, id, config?): Promise<any>

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
idstring | number
config?AxiosRequestConfig

Returns

Promise<any>


getAllFeedObjects()

getAllFeedObjects(type, params?, config?): Promise<SCPaginatedResponse<SCFeedObjectType>>

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
params?FeedObjGetParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFeedObjectType>>


getSpecificFeedObject()

getSpecificFeedObject(type, id, config?): Promise<SCFeedObjectType>

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCFeedObjectType>


getUncommentedFeedObjects()

getUncommentedFeedObjects(type, params?, config?): Promise<SCPaginatedResponse<SCFeedObjectType>>

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
params?BaseGetParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFeedObjectType>>


hideFeedObject()

hideFeedObject(type, id, config?): Promise<any>

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
idstring | number
config?AxiosRequestConfig

Returns

Promise<any>


relatedFeedObjects()

relatedFeedObjects(type, id, params?, config?): Promise<SCPaginatedResponse<SCFeedObjectType>>

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
idstring | number
params?BaseGetParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFeedObjectType>>


restoreFeedObject()

restoreFeedObject(type, id, config?): Promise<any>

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
idstring | number
config?AxiosRequestConfig

Returns

Promise<any>


searchFeedObject()

searchFeedObject(type, params?, config?): Promise<SCPaginatedResponse<SCFeedObjectType>>

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
params?BaseSearchParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFeedObjectType>>


suspendFeedObject()

suspendFeedObject(type, id, config?): Promise<any>

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
idstring | number
config?AxiosRequestConfig

Returns

Promise<any>


updateFeedObject()

updateFeedObject(type, id, data, config?): Promise<SCFeedObjectType>

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
idstring | number
dataFeedObjCreateParams
config?AxiosRequestConfig

Returns

Promise<SCFeedObjectType>


voteFeedObject()

voteFeedObject(type, id, reaction?, config?): Promise<any>

Parameters

ParameterType
typeDISCUSSION | POST | STATUS
idstring | number
reaction?number
config?AxiosRequestConfig

Returns

Promise<any>