FeedObjectApiClient
Contains all the endpoints needed to manage feed objs (discussions-posts-statuses).
Constructors
new FeedObjectApiClient()
new FeedObjectApiClient():
FeedObjectApiClient
Returns
Methods
checkIfFollowingFeedObject()
static
checkIfFollowingFeedObject(type
,id
,config
?):Promise
<SCFeedObjectFollowingStatusType
>
This endpoint returns following = true if the feed obj (identified in path) is followed by the authenticated user
Parameters
Parameter | Type | Description |
---|---|---|
type | DISCUSSION | POST | STATUS | |
id | string | number | |
config ? | AxiosRequestConfig <any > |
Returns
Promise
<SCFeedObjectFollowingStatusType
>
Source
services/feed_object/index.ts:462
checkIfSuspendedFeedObject()
static
checkIfSuspendedFeedObject(type
,id
,config
?):Promise
<SCFeedObjectSuspendedStatusType
>
This endpoint returns suspended = true if the notifications for the feed obj (identified in path) is suspended by the authenticated user
Parameters
Parameter | Type | Description |
---|---|---|
type | DISCUSSION | POST | STATUS | |
id | string | number | |
config ? | AxiosRequestConfig <any > |
Returns
Promise
<SCFeedObjectSuspendedStatusType
>
Source
services/feed_object/index.ts:494
createFeedObject()
static
createFeedObject(type
,data
,config
?):Promise
<SCFeedObjectType
>
This endpoint creates a feed obj
Parameters
Parameter | Type | Description |
---|---|---|
type | DISCUSSION | POST | STATUS | |
data | FeedObjCreateParams | |
config ? | AxiosRequestConfig <any > |
Returns
Promise
<SCFeedObjectType
>
Source
services/feed_object/index.ts:206
deleteFeedObject()
static
deleteFeedObject(type
,id
,config
?):Promise
<any
>
This endpoint deletes a specific feed obj
Parameters
Parameter | Type | Description |
---|---|---|
type | DISCUSSION | POST | STATUS | |
id | string | number | |
config ? | AxiosRequestConfig <any > |
Returns
Promise
<any
>
Source
services/feed_object/index.ts:250
feedObjectContributorsList()
static
feedObjectContributorsList(type
,id
,params
?,config
?):Promise
<SCPaginatedResponse
<SCUserType
>>
This endpoint retrieves all contributors for a specific feed obj
Parameters
Parameter | Type | Description |
---|---|---|
type | DISCUSSION | POST | STATUS | |
id | string | number | |
params ? | BaseGetParams | |
config ? | AxiosRequestConfig <any > |
Returns
Promise
<SCPaginatedResponse
<SCUserType
>>
Source
services/feed_object/index.ts:265
feedObjectFlagList()
static
feedObjectFlagList(type
,id
,config
?):Promise
<SCPaginatedResponse
<SCFlagType
>>
This endpoint retrieves a list of flags for a specific feed obj
Parameters
Parameter | Type | Description |
---|---|---|
type | DISCUSSION | POST | STATUS | |
id | string | number | |
config ? | AxiosRequestConfig <any > |
Returns
Promise
<SCPaginatedResponse
<SCFlagType
>>
Source
services/feed_object/index.ts:561
feedObjectFlagStatus()
static
feedObjectFlagStatus(type
,id
,config
?):Promise
<SCPaginatedResponse
<SCFlagType
>>
Retrieves, if exists, a flag for this contribute created by the authenticated user
Parameters
Parameter | Type | Description |
---|---|---|
type | DISCUSSION | POST | STATUS | |
id | string | number | |
config ? | AxiosRequestConfig <any > |
Returns
Promise
<SCPaginatedResponse
<SCFlagType
>>
Source
services/feed_object/index.ts:547
feedObjectFollowingList()
static
feedObjectFollowingList(type
,params
?,config
?):Promise
<SCPaginatedResponse
<SCFeedObjectType
>>
This endpoint retrieves all feed objs followed by the authenticated user
Parameters
Parameter | Type | Description |
---|---|---|
type | DISCUSSION | POST | STATUS | |
params ? | BaseGetParams | |
config ? | AxiosRequestConfig <any > |
Returns
Promise
<SCPaginatedResponse
<SCFeedObjectType
>>
Source
services/feed_object/index.ts:443
feedObjectHideStatus()
static
feedObjectHideStatus(type
,id
,config
?):Promise
<SCFeedObjectHideStatusType
>
This endpoint retrieves if the feed obj has been hidden by the authenticated user (hidden = true)
Parameters
Parameter | Type | Description |
---|---|---|
type | DISCUSSION | POST | STATUS | |
id | string | number | |
config ? | AxiosRequestConfig <any > |