FeedObjectApiClientInterface

Methods

checkIfFollowingFeedObject()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCFeedObjectFollowingStatusType>

---

checkIfSuspendedFeedObject()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCFeedObjectSuspendedStatusType>

---

createFeedObject()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
data	FeedObjCreateParams
config?	AxiosRequestConfig

Returns

Promise<SCFeedObjectType>

---

deleteFeedObject()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

feedObjectContributorsList()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

feedObjectDraftedList()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFeedObjectType>>

---

feedObjectFlagList()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFlagType>>

---

feedObjectFlagStatus()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFlagType>>

---

feedObjectFollowingList()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFeedObjectType>>

---

feedObjectHideStatus()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCFeedObjectHideStatusType>

---

feedObjectPollVote()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
id	string | number
choice	number
config?	AxiosRequestConfig

Returns

Promise<any>

---

feedObjectPollVotesList()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
id	string | number
params?	FeedObjectPollVotesSearch
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCPollVoteType>>

---

feedObjectScheduledList()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
params?	ScheduledFeedObjParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFeedObjectType>>

---

feedObjectSharesList()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFeedObjectType>>

---

feedObjectSuspendedList()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFeedObjectType>>

---

feedObjectUserSharesList()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

feedObjectVotes()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCVoteType>>

---

flagFeedObject()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
id	string | number
flag_type	SCFlagTypeEnum
config?	AxiosRequestConfig

Returns

Promise<any>

---

followFeedObject()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

getAllFeedObjects()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
params?	FeedObjGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFeedObjectType>>

---

getSpecificFeedObject()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCFeedObjectType>

---

getUncommentedFeedObjects()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFeedObjectType>>

---

hideFeedObject()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

publishFeedObject()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCFeedObjectType>

---

relatedFeedObjects()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFeedObjectType>>

---

restoreFeedObject()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

searchFeedObject()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
params?	BaseSearchParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFeedObjectType>>

---

suspendFeedObject()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

updateFeedObject()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
id	string | number
data	FeedObjCreateParams
config?	AxiosRequestConfig

Returns

Promise<SCFeedObjectType>

---

voteFeedObject()

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

Parameters

Parameter	Type
type	DISCUSSION | POST | STATUS
id	string | number
reaction?	number
config?	AxiosRequestConfig

Returns

Promise<any>