FeedObjectApiClientInterface
Methods
checkIfFollowingFeedObject()
checkIfFollowingFeedObject(
type,id,config?):Promise<SCFeedObjectFollowingStatusType>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCFeedObjectFollowingStatusType>
Source
services/feed_object/index.ts:107
checkIfSuspendedFeedObject()
checkIfSuspendedFeedObject(
type,id,config?):Promise<SCFeedObjectSuspendedStatusType>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCFeedObjectSuspendedStatusType>
Source
services/feed_object/index.ts:113
createFeedObject()
createFeedObject(
type,data,config?):Promise<SCFeedObjectType>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
data | FeedObjCreateParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCFeedObjectType>
Source
services/feed_object/index.ts:35
deleteFeedObject()
deleteFeedObject(
type,id,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Source
services/feed_object/index.ts:51
feedObjectContributorsList()
feedObjectContributorsList(
type,id,params?,config?):Promise<SCPaginatedResponse<SCUserType>>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
id | string | number |
params? | BaseGetParams |
config? | AxiosRequestConfig<any> |
Returns
Promise <SCPaginatedResponse<SCUserType>>
Source
services/feed_object/index.ts:52
feedObjectFlagList()
feedObjectFlagList(
type,id,config?):Promise<SCPaginatedResponse<SCFlagType>>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise <SCPaginatedResponse<SCFlagType>>
Source
services/feed_object/index.ts:129
feedObjectFlagStatus()
feedObjectFlagStatus(
type,id,config?):Promise<SCPaginatedResponse<SCFlagType>>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise <SCPaginatedResponse<SCFlagType>>
Source
services/feed_object/index.ts:134
feedObjectFollowingList()
feedObjectFollowingList(
type,params?,config?):Promise<SCPaginatedResponse<SCFeedObjectType>>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
params? | BaseGetParams |
config? | AxiosRequestConfig<any> |
Returns
Promise <SCPaginatedResponse<SCFeedObjectType>>
Source
services/feed_object/index.ts:102
feedObjectHideStatus()
feedObjectHideStatus(
type,id,config?):Promise<SCFeedObjectHideStatusType>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCFeedObjectHideStatusType>
Source
services/feed_object/index.ts:140
feedObjectPollVote()
feedObjectPollVote(
type,id,choice,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
id | string | number |
choice | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Source
services/feed_object/index.ts:89
feedObjectPollVotesList()
feedObjectPollVotesList(
type,id,params?,config?):Promise<SCPaginatedResponse<SCPollVoteType>>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
id | string | number |
params? | FeedObjectPollVotesSearch |
config? | AxiosRequestConfig<any> |
Returns
Promise <SCPaginatedResponse<SCPollVoteType>>
Source
services/feed_object/index.ts:95
feedObjectSharesList()
feedObjectSharesList(
type,id,params?,config?):Promise<SCPaginatedResponse<SCFeedObjectType>>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
id | string | number |
params? | BaseGetParams |
config? | AxiosRequestConfig<any> |
Returns
Promise <SCPaginatedResponse<SCFeedObjectType>>
Source
services/feed_object/index.ts:58
feedObjectSuspendedList()
feedObjectSuspendedList(
type,params?,config?):Promise<SCPaginatedResponse<SCFeedObjectType>>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
params? | BaseGetParams |
config? | AxiosRequestConfig<any> |
Returns
Promise <SCPaginatedResponse<SCFeedObjectType>>
Source
services/feed_object/index.ts:118
feedObjectUserSharesList()
feedObjectUserSharesList(
type,id,params?,config?):Promise<SCPaginatedResponse<SCUserType>>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
id | string | number |
params? | BaseGetParams |
config? | AxiosRequestConfig<any> |
Returns
Promise <SCPaginatedResponse<SCUserType>>
Source
services/feed_object/index.ts:64
feedObjectVotes()
feedObjectVotes(
type,id,params?,config?):Promise<SCPaginatedResponse<SCVoteType>>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
id | string | number |
params? | BaseGetParams |
config? | AxiosRequestConfig<any> |
Returns
Promise <SCPaginatedResponse<SCVoteType>>
Source
services/feed_object/index.ts:83
flagFeedObject()
flagFeedObject(
type,id,flag_type,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
id | string | number |
flag_type | SCFlagTypeEnum |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Source
services/feed_object/index.ts:123
followFeedObject()
followFeedObject(
type,id,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Source
services/feed_object/index.ts:101
getAllFeedObjects()
getAllFeedObjects(
type,params?,config?):Promise<SCPaginatedResponse<SCFeedObjectType>>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
params? | FeedObjGetParams |
config? | AxiosRequestConfig<any> |
Returns
Promise <SCPaginatedResponse<SCFeedObjectType>>
Source
services/feed_object/index.ts:20
getSpecificFeedObject()
getSpecificFeedObject(
type,id,config?):Promise<SCFeedObjectType>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCFeedObjectType>
Source
services/feed_object/index.ts:40
getUncommentedFeedObjects()
getUncommentedFeedObjects(
type,params?,config?):Promise<SCPaginatedResponse<SCFeedObjectType>>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
params? | BaseGetParams |
config? | AxiosRequestConfig<any> |
Returns
Promise <SCPaginatedResponse<SCFeedObjectType>>
Source
services/feed_object/index.ts:25
hideFeedObject()
hideFeedObject(
type,id,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Source
services/feed_object/index.ts:139
relatedFeedObjects()
relatedFeedObjects(
type,id,params?,config?):Promise<SCPaginatedResponse<SCFeedObjectType>>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
id | string | number |
params? | BaseGetParams |
config? | AxiosRequestConfig<any> |
Returns
Promise <SCPaginatedResponse<SCFeedObjectType>>
Source
services/feed_object/index.ts:71
restoreFeedObject()
restoreFeedObject(
type,id,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Source
services/feed_object/index.ts:70
searchFeedObject()
searchFeedObject(
type,params?,config?):Promise<SCPaginatedResponse<SCFeedObjectType>>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
params? | BaseSearchParams |
config? | AxiosRequestConfig<any> |
Returns
Promise <SCPaginatedResponse<SCFeedObjectType>>
Source
services/feed_object/index.ts:30
suspendFeedObject()
suspendFeedObject(
type,id,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Source
services/feed_object/index.ts:112
updateFeedObject()
updateFeedObject(
type,id,data,config?):Promise<SCFeedObjectType>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
id | string | number |
data | FeedObjCreateParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCFeedObjectType>
Source
services/feed_object/index.ts:45
voteFeedObject()
voteFeedObject(
type,id,reaction?,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
type | DISCUSSION | POST | STATUS |
id | string | number |
reaction? | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>